LibreOffice
LibreOffice 6.2 SDK API Reference
Exported Interfaces | Public Attributes | List of all members
ColumnSettings Service Referencepublished

describes the common properties of a database column. More...

import"ColumnSettings.idl";

Inheritance diagram for ColumnSettings:
XPropertySet XInterface Column ResultColumn DataColumn

Exported Interfaces

interface com::sun::star::beans::XPropertySet
 

Public Attributes

long FormatKey
 contains the index of the number format that is used for the column. More...
 
long Align
 specifies the alignment of columns text. More...
 
long Width
 specifies the width of the column displayed in a grid, the unit is 10THMM. More...
 
long Position
 Position of the column within a grid. More...
 
boolean Hidden
 determines whether the column should be displayed or not. More...
 
com::sun::star::beans::XPropertySet ControlModel
 indicates a control model which defines the settings for layouting. More...
 
string HelpText
 describes an optional help text which can be used by UI components when representing this column. More...
 
string ControlDefault
 describes the default value which should be displayed by a control when moving to a new row. More...
 

Additional Inherited Members

- Public Member Functions inherited from XPropertySet
com::sun::star::beans::XPropertySetInfo getPropertySetInfo ()
 
void setPropertyValue ([in] string aPropertyName, [in] any aValue) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::beans::PropertyVetoException, com::sun::star::lang::IllegalArgumentException, com::sun::star::lang::WrappedTargetException )
 sets the value of the property with the specified name. More...
 
any getPropertyValue ([in] string PropertyName) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 
void addPropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener xListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XPropertyChangeListener to the specified property. More...
 
void removePropertyChangeListener ([in] string aPropertyName, [in] com::sun::star::beans::XPropertyChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XPropertyChangeListener from the listener list. More...
 
void addVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 adds an XVetoableChangeListener to the specified property with the name PropertyName. More...
 
void removeVetoableChangeListener ([in] string PropertyName, [in] com::sun::star::beans::XVetoableChangeListener aListener) raises ( com::sun::star::beans::UnknownPropertyException, com::sun::star::lang::WrappedTargetException )
 removes an XVetoableChangeListener from the listener list. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

describes the common properties of a database column.

Exported Interfaces

Member Data Documentation

long Align
property

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.

string ControlDefault
optionalproperty

describes the default value which should be displayed by a control when moving to a new row.

The default is NULL.

com::sun::star::beans::XPropertySet ControlModel
optionalproperty

indicates a control model which defines the settings for layouting.

The default is NULL.

long FormatKey
property

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 number format should be used according to the datatype of the column.

string HelpText
optionalproperty

describes an optional help text which can be used by UI components when representing this column.

The default is NULL.

boolean Hidden
property

determines whether the column should be displayed or not.

long Position
property

Position of the column within a grid.

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

long Width
property

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.


The documentation for this service was generated from the following file: