<html> <head> <title>Constants' Group PropertyControlType</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimainnone">Use</td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#Constants" class="navisub">Constants</a></td> <td class="navisub"><a href="#ConstantDetails" class="navisub">Constants' Details</a></td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">inspection</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">constants group PropertyControlType</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>describes pre-defined possible control types to be used to display and enter property values within a <a href="ObjectInspector.html">ObjectInspector</a>. </dd> <dd><p>The type of a control determines its visual appearance, its behavior, and - important for property handlers using a control - the expected type when reading and writing the control's value.</p> </dd> <dt><b>Since </b></dt> <dd>OOo 2.0.3</dd> <dt><b>See also</b></dt> <dd><a href="XPropertyControl.html">XPropertyControl</a>, <a href="XPropertyControlFactory.html">XPropertyControlFactory</a>, <a href="XPropertyControl.html">XPropertyControl</a>::<a href="XPropertyControl.html#ValueType">ValueType</a></dd> </dl> </td> </tr> </table> <hr> <a name="Constants"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Constants</td> </tr> <tr> <td class="imsum_left"><a href="#ListBox">ListBox</a></td> <td class="imsum_right">denotes a control which allows the user to choose from a list of possible property values </td> </tr> <tr> <td class="imsum_left"><a href="#ComboBox">ComboBox</a></td> <td class="imsum_right">denotes a control which allows the user to choose from a list of possible property values, combined with the possibility to enter a new property value. </td> </tr> <tr> <td class="imsum_left"><a href="#TextField">TextField</a></td> <td class="imsum_right">denotes a control which allows the user to enter property values consisting of a single line of text </td> </tr> <tr> <td class="imsum_left"><a href="#MultiLineTextField">MultiLineTextField</a></td> <td class="imsum_right">denotes a control which allows the user to enter pure text, including line breaks </td> </tr> <tr> <td class="imsum_left"><a href="#CharacterField">CharacterField</a></td> <td class="imsum_right">denotes a control which allows the user to enter a single character </td> </tr> <tr> <td class="imsum_left"><a href="#StringListField">StringListField</a></td> <td class="imsum_right">denotes a control which allows the user to enter a list of single-line strings </td> </tr> <tr> <td class="imsum_left"><a href="#ColorListBox">ColorListBox</a></td> <td class="imsum_right">denotes a control which allows the user to choose from a list of colors. </td> </tr> <tr> <td class="imsum_left"><a href="#NumericField">NumericField</a></td> <td class="imsum_right">denotes a control which allows the user to enter a numerical value </td> </tr> <tr> <td class="imsum_left"><a href="#DateField">DateField</a></td> <td class="imsum_right">denotes a control which allows the user to enter a date value </td> </tr> <tr> <td class="imsum_left"><a href="#TimeField">TimeField</a></td> <td class="imsum_right">denotes a control which allows the user to enter a time value </td> </tr> <tr> <td class="imsum_left"><a href="#DateTimeField">DateTimeField</a></td> <td class="imsum_right">denotes a control which allows the user to enter a combined date/time value </td> </tr> <tr> <td class="imsum_left"><a href="#HyperlinkField">HyperlinkField</a></td> <td class="imsum_right">denotes a control which displays a string in a hyperlink-like appearance </td> </tr> <tr> <td class="imsum_left"><a href="#Unknown">Unknown</a></td> <td class="imsum_right">denotes a non-standard property control, which is usually provided by an <a href="XPropertyHandler.html">XPropertyHandler</a> </td> </tr> </table> <a name="ConstantDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Constants' Details</td> </tr> <tr> <td class="imdetail"><a name="ListBox" class="membertitle">ListBox</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>ListBox</b> = 1;<hr> <dl> <dt><b>Description</b></dt> <dd>denotes a control which allows the user to choose from a list of possible property values </dd> <dd><p>Controls of type <a href="#ListBox">ListBox</a> exchange their values as <code>string</code>.</p> <p>Additionally, those controls support the <a href="XStringListControl.html">XStringListControl</a> interface.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ComboBox" class="membertitle">ComboBox</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>ComboBox</b> = 2;<hr> <dl> <dt><b>Description</b></dt> <dd>denotes a control which allows the user to choose from a list of possible property values, combined with the possibility to enter a new property value. </dd> <dd><p>Controls of type <a href="#ComboBox">ComboBox</a> exchange their values as <code>string</code>.</p> <p>Additionally, those controls support the <a href="XStringListControl.html">XStringListControl</a> interface.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="TextField" class="membertitle">TextField</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>TextField</b> = 3;<hr> <dl> <dt><b>Description</b></dt> <dd>denotes a control which allows the user to enter property values consisting of a single line of text </dd> <dd><p>Controls of type <a href="#TextField">TextField</a> exchange their values as <code>string</code>.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="MultiLineTextField" class="membertitle">MultiLineTextField</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>MultiLineTextField</b> = 4;<hr> <dl> <dt><b>Description</b></dt> <dd>denotes a control which allows the user to enter pure text, including line breaks </dd> <dd><p>Controls of type <a href="#MultiLineTextField">MultiLineTextField</a> exchange their values as <code>string</code>.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CharacterField" class="membertitle">CharacterField</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>CharacterField</b> = 5;<hr> <dl> <dt><b>Description</b></dt> <dd>denotes a control which allows the user to enter a single character </dd> <dd><p>Controls of type <a href="#CharacterField">CharacterField</a> exchange their values as <code>short</code>, being a single UTF-16 character.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="StringListField" class="membertitle">StringListField</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>StringListField</b> = 6;<hr> <dl> <dt><b>Description</b></dt> <dd>denotes a control which allows the user to enter a list of single-line strings </dd> <dd><p>Controls of type <a href="#StringListField">StringListField</a> exchange their values as <code>sequence< string ><code>.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ColorListBox" class="membertitle">ColorListBox</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>ColorListBox</b> = 7;<hr> <dl> <dt><b>Description</b></dt> <dd>denotes a control which allows the user to choose from a list of colors. </dd> <dd><p>Controls of type <a href="#ColorListBox">ColorListBox</a> usually exchange their values as ::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/Color.html">Color</a>.</p> <p>Additionally, those controls support the <a href="XStringListControl.html">XStringListControl</a> interface. If you use this interface to add additional entries to the list box, which have no color associated with it, then you can also exchange values as <code>string</code>. That is, if you write a string into <a href="XPropertyControl.html">XPropertyControl</a>::<a href="XPropertyControl.html#Value">Value</a>, and if this string has previously been added to the list using the <a href="XStringListControl.html">XStringListControl</a> interface, this string is selected. Vice versa, if the user selects one of those non-color strings in the list, then reading <a href="XPropertyControl.html">XPropertyControl</a>::<a href="XPropertyControl.html#Value">Value</a> will retrieve you this string.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="NumericField" class="membertitle">NumericField</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>NumericField</b> = 8;<hr> <dl> <dt><b>Description</b></dt> <dd>denotes a control which allows the user to enter a numerical value </dd> <dd><p>Controls of type <a href="#NumericField">NumericField</a> exchange their values as <code>double</code>.</p> <p>Additionally, those controls support the <a href="XNumericControl.html">XNumericControl</a> interface.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="DateField" class="membertitle">DateField</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>DateField</b> = 9;<hr> <dl> <dt><b>Description</b></dt> <dd>denotes a control which allows the user to enter a date value </dd> <dd><p>Controls of type <a href="#DateField">DateField</a> exchange their values as ::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/Date.html">Date</a>.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="TimeField" class="membertitle">TimeField</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>TimeField</b> = 10;<hr> <dl> <dt><b>Description</b></dt> <dd>denotes a control which allows the user to enter a time value </dd> <dd><p>Controls of type <a href="#TimeField">TimeField</a> exchange their values as ::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/Time.html">Time</a>.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="DateTimeField" class="membertitle">DateTimeField</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>DateTimeField</b> = 11;<hr> <dl> <dt><b>Description</b></dt> <dd>denotes a control which allows the user to enter a combined date/time value </dd> <dd><p>Controls of type <a href="#DateTimeField">DateTimeField</a> exchange their values as ::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/DateTime.html">DateTime</a>.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="HyperlinkField" class="membertitle">HyperlinkField</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>HyperlinkField</b> = 12;<hr> <dl> <dt><b>Description</b></dt> <dd>denotes a control which displays a string in a hyperlink-like appearance </dd> <dd><p>Controls of type <a href="#HyperlinkField">HyperlinkField</a> exchange their values as <code>string</code>.</p> <p>Additionally, those controls support the <a href="XHyperlinkControl.html">XHyperlinkControl</a> interface.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Unknown" class="membertitle">Unknown</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>const short <b>Unknown</b> = 13;<hr> <dl> <dt><b>Description</b></dt> <dd>denotes a non-standard property control, which is usually provided by an <a href="XPropertyHandler.html">XPropertyHandler</a> </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>
