LibreOffice
LibreOffice 6.2 SDK API Reference
Included Services | Public Attributes | List of all members
ResultColumn Service Referencepublished

describes a column of a result set. More...

import"ResultColumn.idl";

Inheritance diagram for ResultColumn:
Column ColumnSettings XDataDescriptorFactory XPropertySet XPropertySet XInterface XInterface XInterface DataColumn

Included Services

service com::sun::star::sdbcx::Column
 
service com::sun::star::sdb::ColumnSettings
 [optional], access to layout settings for a column. More...
 

Public Attributes

boolean IsSearchable
 indicates whether the column can be used in a Where clause. More...
 
boolean IsSigned
 indicates whether values in the column are signed numbers. More...
 
boolean IsCaseSensitive
 indicates that a column is case sensitive. More...
 
long DisplaySize
 indicates the column's normal max width in chars. More...
 
string Label
 gets the suggested column title for use in printouts and displays. More...
 
boolean IsReadOnly
 indicates whether a column is definitely, not writable. More...
 
boolean IsWritable
 indicates whether it is possible for a write on the column to succeed. More...
 
boolean IsDefinitelyWritable
 indicates whether a write on the column will definitely succeed. More...
 
string ServiceName
 returns the fully-qualified name of the service whose instances are manufactured if the method com::sun::star::sdbc::XRow::getObject)= is called to retrieve a value from the column. More...
 
string TableName
 gets a column's table name. More...
 
string SchemaName
 gets a column's schema name. More...
 
string CatalogName
 gets a column's table's catalog name. More...
 
- Public Attributes inherited from Column
string Name
 is the name of the column. More...
 
long Type
 is the com::sun::star::sdbc::DataType of the column. More...
 
string TypeName
 is the type name used by the database. More...
 
long Precision
 gets a column's number of decimal digits. More...
 
long Scale
 gets a column's number of digits to right of the decimal point. More...
 
long IsNullable
 indicates the nullability of values in the designated column. More...
 
boolean IsAutoIncrement
 indicates whether the column is automatically numbered, thus read-only. More...
 
boolean IsCurrency
 indicates whether the column is a cash value. More...
 
boolean IsRowVersion
 indicates that the column contains some kind of time or date stamp used to track updates. More...
 
string Description
 keeps a description of the object. More...
 
string DefaultValue
 keeps a default value for a column, is provided as string. More...
 
- Public Attributes inherited from ColumnSettings
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

- Exported Interfaces inherited from Column
interface XDataDescriptorFactory
 optional, could be used to copy a database column. More...
 
interface com::sun::star::beans::XPropertySet
 
- Exported Interfaces inherited from ColumnSettings
interface com::sun::star::beans::XPropertySet
 
- 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...
 
- Protected Member Functions inherited from XDataDescriptorFactory
com::sun::star::beans::XPropertySet createDataDescriptor ()
 returns a descriptor of a definition object. More...
 
- Protected 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...
 
- Protected 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...
 

Detailed Description

describes a column of a result set.

Exported Interfaces

[optional], access to layout settings for a column.

Member Data Documentation

string CatalogName
propertyreadonly

gets a column's table's catalog name.

long DisplaySize
propertyreadonly

indicates the column's normal max width in chars.

boolean IsCaseSensitive
propertyreadonly

indicates that a column is case sensitive.

boolean IsDefinitelyWritable
propertyreadonly

indicates whether a write on the column will definitely succeed.

boolean IsReadOnly
propertyreadonly

indicates whether a column is definitely, not writable.

boolean IsSearchable
propertyreadonly

indicates whether the column can be used in a Where clause.

boolean IsSigned
propertyreadonly

indicates whether values in the column are signed numbers.

boolean IsWritable
propertyreadonly

indicates whether it is possible for a write on the column to succeed.

string Label
propertyreadonly

gets the suggested column title for use in printouts and displays.

string SchemaName
propertyreadonly

gets a column's schema name.

string ServiceName
propertyreadonly

returns the fully-qualified name of the service whose instances are manufactured if the method com::sun::star::sdbc::XRow::getObject)= is called to retrieve a value from the column.

string TableName
propertyreadonly

gets a column's table name.


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