Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous

Overview Module Use Devguide Index
Services' Summary Interfaces' Summary Properties' Summary Services' Details Interfaces' Details Properties' Details

:: com :: sun :: star :: sdb ::

service ColumnSettings
Description
describes the common properties of a database column.
Exported Interfaces - Summary
::com::sun::star::beans::XPropertySet
(referenced entity's summary:)
provides information about and access to the properties from an implementation.
Properties' Summary
long
FormatKey		 contains the index of the number format that is used for the column.  
long
Align		 specifies the alignment of columns text.  
long
Width		 specifies the width of the column displayed in a grid, the unit is 10THMM.  
long
Position		 Position of the column within a grid.  
boolean
Hidden		 determines whether the column should be displayed or not.  
::com::sun::star::beans::XPropertySet
ControlModel		 [ OPTIONAL ]
indicates a control model whichs defines the settings for layouting. The default is NULL .  
string
HelpText		 [ OPTIONAL ]
describes an optional help text which can be used by UI components when representing this column. The default is NULL .  
string
ControlDefault		 [ OPTIONAL ]
describes the default value which should be displayed by a control when moving to a new row. The default is NULL .  
Exported Interfaces - Details
::com::sun::star::beans::XPropertySet
(referenced entity's summary:)
provides information about and access to the properties from an implementation.
Properties' Details
FormatKey
long FormatKey;
Description
contains the index of the number format that is used for the column.

The proper value can be determined by using the ::com::sun::star::util::XNumberFormatter interface.

If the value is void , a default numberformat should be used according to the datatype of the column.

Align
long Align;
Description
specifies the alignment of columns text. 
 0: left
 1: center
 2: right

If the value is void , a default alignment should be used according to the datatype of the column.

Width
long Width;
Description
specifies the width of the column displayed in a grid, the unit is 10THMM.

If the value is void , a default width should be used according to the label of the column.

Position
long Position;
Description
Position of the column within a grid.

If the value is void , the default position should be taken according.

Hidden
boolean Hidden;
Description
determines whether the column should be displayed or not.
ControlModel
::com::sun::star::beans::XPropertySet ControlModel;
Usage Restrictions
optional
Description
indicates a control model whichs defines the settings for layouting. The default is NULL .
HelpText
string HelpText;
Usage Restrictions
optional
Description
describes an optional help text which can be used by UI components when representing this column. The default is NULL .
ControlDefault
string ControlDefault;
Usage Restrictions
optional
Description
describes the default value which should be displayed by a control when moving to a new row. The default is NULL .

 Top of Page

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

Apache Software Foundation

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

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