<html> <head> <title>Service UnoControlFormattedFieldModel</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="navimain"><a href="UnoControlFormattedFieldModel-xref.html" class="navimain">Use</a></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="#IncludedServices" class="navisub">Included Services</a></td> <td class="navisub">Exported Interfaces</td> <td class="navisub"><a href="#PropertiesSummary" class="navisub">Properties' Summary</a></td> <td class="navisub"><a href="#PropertiesDetails" class="navisub">Properties' 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">awt</a> :: </p> </td> </tr> <tr> <td class="title">service UnoControlFormattedFieldModel</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>specifies the standard model of an <a href="UnoControlFormattedField.html">UnoControlFormattedField</a>. </dd> </dl> </td> </tr> </table> <hr> <a name="IncludedServices"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Included Services</td> </tr> <tr> <td class="imsum_left"><a href="UnoControlModel.html">UnoControlModel</a></td> <td class="imsum_right"><dl> <dt>(referenced entity's summary:)</dt> <dd>specifies the standard model of an <a href="UnoControl.html">UnoControl</a> in the <em>Smalltalk model view controller design</em>. </dd> </dl> </td> </tr> </table> <a name="PropertiesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Properties' Summary</td> </tr> <tr> <td class="imsum_left">short<br> <a href="#Align">Align</a></td> <td class="imsum_right">specifies the horiztonal alignment of the text in the control. </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/Color.html">Color</a><br> <a href="#BackgroundColor">BackgroundColor</a></td> <td class="imsum_right">specifies the background color (RGB) of the control. </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#Border">Border</a></td> <td class="imsum_right">specifies the border style of the control. </td> </tr> <tr> <td class="imsum_left">long<br> <a href="#BorderColor">BorderColor</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies the color of the border, if present </td> </tr> <tr> <td class="imsum_left">any<br> <a href="#EffectiveDefault">EffectiveDefault</a></td> <td class="imsum_right">specifies the default value of the formatted field. </td> </tr> <tr> <td class="imsum_left">double<br> <a href="#EffectiveMax">EffectiveMax</a></td> <td class="imsum_right">specifies the maximum value that can be entered. </td> </tr> <tr> <td class="imsum_left">double<br> <a href="#EffectiveMin">EffectiveMin</a></td> <td class="imsum_right">specifies the minimum value that can be entered. </td> </tr> <tr> <td class="imsum_left">double<br> <a href="#EffectiveValue">EffectiveValue</a></td> <td class="imsum_right">specifies the current value of the formatted field. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#Enabled">Enabled</a></td> <td class="imsum_right">determines whether the control is enabled or disabled. </td> </tr> <tr> <td class="imsum_left"><a href="FontDescriptor.html">FontDescriptor</a><br> <a href="#FontDescriptor">FontDescriptor</a></td> <td class="imsum_right">specifies the font attributes of the text in the control. </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#FontEmphasisMark">FontEmphasisMark</a></td> <td class="imsum_right">specifies the ::com::sun::star::<a href="../text/module-ix.html">text</a>::<a href="../text/FontEmphasis.html">FontEmphasis</a> value of the text in the control. </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#FontRelief">FontRelief</a></td> <td class="imsum_right">specifies the ::com::sun::star::<a href="../text/module-ix.html">text</a>::<a href="../text/FontRelief.html">FontRelief</a> value of the text in the control. </td> </tr> <tr> <td class="imsum_left">long<br> <a href="#FormatKey">FormatKey</a></td> <td class="imsum_right">specifies the format to be used when formatting the field input and output. </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/XNumberFormatsSupplier.html">XNumberFormatsSupplier</a><br> <a href="#FormatsSupplier">FormatsSupplier</a></td> <td class="imsum_right">supplies the formats the field should work with. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#HelpText">HelpText</a></td> <td class="imsum_right">specifies the help text of the control. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#HelpURL">HelpURL</a></td> <td class="imsum_right">specifies the help URL of the control. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#HideInactiveSelection">HideInactiveSelection</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies whether the selection in the control should be hidden when the control is not active (focused). </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#MaxTextLen">MaxTextLen</a></td> <td class="imsum_right">specifies the maximum character count. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#Printable">Printable</a></td> <td class="imsum_right">specifies that the control will be printed with the document. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#ReadOnly">ReadOnly</a></td> <td class="imsum_right">specifies that the content of the control cannot be modified by the user. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#Repeat">Repeat</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies whether the mouse should show repeating behaviour, i.e. repeatedly trigger an action when keeping pressed. </td> </tr> <tr> <td class="imsum_left">long<br> <a href="#RepeatDelay">RepeatDelay</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies the mouse repeat delay, in milliseconds. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#Spin">Spin</a></td> <td class="imsum_right">specifies that the control has a spin button. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#StrictFormat">StrictFormat</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies that the text is checked during the user input. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#Tabstop">Tabstop</a></td> <td class="imsum_right">specifies that the control can be reached with the TAB key. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Text">Text</a></td> <td class="imsum_right">specifies the text displayed in the control. </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/Color.html">Color</a><br> <a href="#TextColor">TextColor</a></td> <td class="imsum_right">specifies the text color (RGB) of the control. </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/Color.html">Color</a><br> <a href="#TextLineColor">TextLineColor</a></td> <td class="imsum_right">specifies the text line color (RGB) of the control. </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#TreatAsNumber">TreatAsNumber</a></td> <td class="imsum_right">specifies that the text is treated as a number. </td> </tr> </table> <a name="PropertiesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Properties' Details</td> </tr> <tr> <td class="imdetail"><a name="Align" class="membertitle">Align</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>Align</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the horiztonal alignment of the text in the control. </dd> <dd><pre> 0: left 1: center 2: right </pre> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="BackgroundColor" class="membertitle">BackgroundColor</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/Color.html">Color</a> <b>BackgroundColor</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the background color (RGB) of the control. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Border" class="membertitle">Border</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>Border</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the border style of the control. </dd> <dd><pre> 0: No border 1: 3D border 2: simple border </pre> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="BorderColor" class="membertitle">BorderColor</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>BorderColor</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies the color of the border, if present </dd> <dd><p>Not every border style (see <a href="#Border">Border</a>) may support coloring. For instance, usually a border with 3D effect will ignore the BorderColor setting.</p> </dd> <dt><b/></dt> <dd/></dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="EffectiveDefault" class="membertitle">EffectiveDefault</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>any <b>EffectiveDefault</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the default value of the formatted field. </dd> <dd><p>This may be a numeric value (double) or a string, depending on the formatting of the field.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="EffectiveMax" class="membertitle">EffectiveMax</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>double <b>EffectiveMax</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the maximum value that can be entered. </dd> <dd><p>This property is ignored if the format of the field is no numeric format.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="EffectiveMin" class="membertitle">EffectiveMin</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>double <b>EffectiveMin</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the minimum value that can be entered. </dd> <dd><p>This property is ignored if the format of the field is no numeric format.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="EffectiveValue" class="membertitle">EffectiveValue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>double <b>EffectiveValue</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the current value of the formatted field. </dd> <dd><p>This may be a numeric value (double) or a string, depending on the formatting of the field.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Enabled" class="membertitle">Enabled</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>Enabled</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>determines whether the control is enabled or disabled. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="FontDescriptor" class="membertitle">FontDescriptor</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td><a href="FontDescriptor.html">FontDescriptor</a> <b>FontDescriptor</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the font attributes of the text in the control. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="FontEmphasisMark" class="membertitle">FontEmphasisMark</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>FontEmphasisMark</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the ::com::sun::star::<a href="../text/module-ix.html">text</a>::<a href="../text/FontEmphasis.html">FontEmphasis</a> value of the text in the control. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="FontRelief" class="membertitle">FontRelief</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>FontRelief</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the ::com::sun::star::<a href="../text/module-ix.html">text</a>::<a href="../text/FontRelief.html">FontRelief</a> value of the text in the control. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="FormatKey" class="membertitle">FormatKey</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>FormatKey</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the format to be used when formatting the field input and output. </dd> <dd><p>This value is meaningful relative to the FormatsSupplier property only.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="FormatsSupplier" class="membertitle">FormatsSupplier</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/XNumberFormatsSupplier.html">XNumberFormatsSupplier</a> <b>FormatsSupplier</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>supplies the formats the field should work with. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="HelpText" class="membertitle">HelpText</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>HelpText</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the help text of the control. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="HelpURL" class="membertitle">HelpURL</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>HelpURL</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the help URL of the control. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="HideInactiveSelection" class="membertitle">HideInactiveSelection</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>HideInactiveSelection</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies whether the selection in the control should be hidden when the control is not active (focused). </dd> <dt><b/></dt> <dd/></dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="MaxTextLen" class="membertitle">MaxTextLen</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>MaxTextLen</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the maximum character count. </dd> <dd><p>There's no limitation, if set to 0.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Printable" class="membertitle">Printable</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>Printable</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies that the control will be printed with the document. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ReadOnly" class="membertitle">ReadOnly</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>ReadOnly</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies that the content of the control cannot be modified by the user. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Repeat" class="membertitle">Repeat</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>Repeat</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies whether the mouse should show repeating behaviour, i.e. repeatedly trigger an action when keeping pressed. </dd> <dt><b/></dt> <dd/></dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="RepeatDelay" class="membertitle">RepeatDelay</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>long <b>RepeatDelay</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies the mouse repeat delay, in milliseconds. </dd> <dd><p>When the user presses a mouse in a control area where this triggers an action (such as spinning the value), then usual control implementations allow to repeatedly trigger this action, without the need to release the mouse button and to press it again. The delay between two such triggers is specified with this property.</p> </dd> <dt><b/></dt> <dd/></dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Spin" class="membertitle">Spin</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>Spin</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies that the control has a spin button. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="StrictFormat" class="membertitle">StrictFormat</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>StrictFormat</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies that the text is checked during the user input. </dd> <dd><p>This property is optional - not every component implementing this service is required to provide it, as real-time input checking on a formatted field may be pretty expensive.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Tabstop" class="membertitle">Tabstop</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>Tabstop</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies that the control can be reached with the TAB key. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Text" class="membertitle">Text</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Text</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the text displayed in the control. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="TextColor" class="membertitle">TextColor</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/Color.html">Color</a> <b>TextColor</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the text color (RGB) of the control. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="TextLineColor" class="membertitle">TextLineColor</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/Color.html">Color</a> <b>TextLineColor</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the text line color (RGB) of the control. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="TreatAsNumber" class="membertitle">TreatAsNumber</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>TreatAsNumber</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies that the text is treated as a number. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <br> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
1052
