Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: inspection ::

interface XNumericControl
Base Interfaces
XNumericControlXPropertyControl

XPropertyControl
(referenced interface's summary:)
defines the interface for a single control in an ObjectInspector
Description
defines the interface for an XPropertyControl which supports displaying and entering numerical values.
Since
OOo 2.0.3

Attributes' Summary
DecimalDigits describes the number of decimal digits to use for the value  
MinValue describes the minimum value which is allowed to be entered in the control  
MaxValue describes the maximum value which is allowed to be entered in the control  
DisplayUnit describes a ::com::sun::star::util::MeasureUnit to be applied for displaying values.  
ValueUnit describes a ::com::sun::star::util::MeasureUnit to be applied for transfering values.  
Attributes' Details
DecimalDigits
short DecimalDigits;
Description
describes the number of decimal digits to use for the value
MinValue
::com::sun::star::beans::Optional< double > MinValue;
Description
describes the minimum value which is allowed to be entered in the control
MaxValue
::com::sun::star::beans::Optional< double > MaxValue;
Description
describes the maximum value which is allowed to be entered in the control
DisplayUnit
short DisplayUnit
set raises (::com::sun::star::lang::IllegalArgumentException);

Description
describes a ::com::sun::star::util::MeasureUnit to be applied for displaying values.

Only a certain set of ::com::sun::star::util::MeasureUnit values is supported. In particular, every value which denotes a fraction of another unit (like 100th millimiters) cannot be used as DisplayUnit.

Throws
com::sun::star::lang::IllegalArgumentException if the caller attempts to set an unsupported ::com::sun::star::util::MeasureUnit
ValueUnit
short ValueUnit;
Description
describes a ::com::sun::star::util::MeasureUnit to be applied for transfering values.

The core measurement unit for a property value might differ from the unit which is used by the control to display it. For instance, your property value might require that your values denote 100th millimeters, but to the user, you want to present the value as, say, inches. In this case, a numeric control can automatically handle the value conversion for you, if you give it a ValueUnit different from the DisplayUnit.

See also
XPropertyControl::Value
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.