LibreOffice LibreOffice 25.2 SDK API Reference

Included Services | Public Attributes | List of all members
ColumnDescriptor Service Referencepublished

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

`import"ColumnDescriptor.idl";`

Inheritance diagram for ColumnDescriptor:

## Included Services
service | com::sun::star::sdbcx::Descriptor

## Public Attributes
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 | 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...
string | AutoIncrementCreation
| specifies how to create an auto-increment column. More...
Public Attributes inherited from Descriptor
string | Name
| is the name for the object to create. More...

## Additional Inherited Members
Exported Interfaces inherited from Descriptor
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...

## Detailed Description

describes the common properties of a database column.

Could be used for the creation of a database columns within a table.

See also
  com::sun::star::sdbcx::Column
  com::sun::star::sdbcx::Table

## Exported Interfaces

## ◆ com::sun::star::sdbcx::Descriptor

service com::sun::star::sdbcx::Descriptor

## Member Data Documentation

## ◆ AutoIncrementCreation

string AutoIncrementCreation
| optional property

specifies how to create an auto-increment column.

## ◆ DefaultValue

string DefaultValue
| optional property

keeps a default value for a column, is provided as string.

## ◆ Description

string Description
| optional property

keeps a description of the object.

## ◆ IsAutoIncrement

boolean IsAutoIncrement
| property

indicates whether the column is automatically numbered, thus read-only.

See also
  com::sun::star::sdbc::ColumnValue

## ◆ IsNullable

long IsNullable
| property

indicates the nullability of values in the designated column.

See also
  com::sun::star::sdbc::ColumnValue

## ◆ IsRowVersion

boolean IsRowVersion
| optional property

indicates that the column contains some kind of time or date stamp used to track updates.

## ◆ Precision

long Precision
| property

gets a column's number of decimal digits.

## ◆ Scale

long Scale
| property

gets a column's number of digits to right of the decimal point.

## ◆ Type

long Type
| property

is the com::sun::star::sdbc::DataType of the column.

## ◆ TypeName

string TypeName
| property

is the type name used by the database.

If the column type is a user-defined type, then a fully-qualified type name is returned. May be empty.

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

- com/sun/star/sdbcx/ColumnDescriptor.idl