Accessors for class IliDbOptionMenu

Properties

columnName
dataSource
dataSourceName
foreignDataSourceName
foreignDisplayColumnName
foreignTable
foreignValueColumnName
inputModified
readOnly
tablePropertyManagerName
useTableProperties
value
valueType

Methods

endOfBatch
startOfBatch

Description

The IliDbOption class defines an option menu gadget that can be connected to a data source. The list of items is defined by the data of the foreign data source.

Type Name Description Notes

String columnName Contains the column name that the gadget must connect to. The column name must designate a valid column of the data source.

IliDataSource dataSource Contains the data source object. This property cannot be written to if the dataSourceName property is not empty. In other words, the data source can be specified either literally through the dataSource property or by name through the dataSourceName property, but not both.

String dataSourceName Contains the data source name.

String foreignDataSourceName Contains the foreign data source name.

String foreignDisplayColumnName Contains the foreign display column name.

IliTable foreignTable Contains the foreign table. This property cannot be written to if the foreignDataSourceName property is not empty. In other words, the foreign table can be specified either literally through the foreignTable property or by name through the foreignDataSourceName property, but not both.

String foreignValueColumnName Contains the foreign value column name.

Boolean inputModified This property is true if the external representation has been edited by the end user since the last validation. read-only

Boolean readOnly This property is true if the gadget is read-only.

Int selected Contains the position of the currently selected item.

String tablePropertyManagerName Contains the name of the table property manager used by this gadget or null if the data source's table property manager is used. Initially, this property is null.

Boolean useTableProperties Contains true if the gadget uses table properties. Note that the gadget will effectively use table properties if this property is true and if the data source to which it is connected is also using table properties. Initially, this property is true.

Variant value Contains the selected value.

Datatype valueType Contains the data type of the value. It can be one of the following:

String
Integer
Boolean
Double
Float
Decimal
Date
Time
Although this property is not read-only, it should not be assigned if the option menu is connected to a data source.

Void endOfBatch() Called to terminate a series of modifications of properties. A call to this method must be preceded by a call to the startOfBatch method. Calls to startOfBatch and endOfBatch can be nested.

Void startOfBatch() Called to start a series of modifications of properties. A call to this method must be followed by a call to the endOfBatch method.

Type	Name	Description	Notes
`String`	`columnName`	Contains the column name that the gadget must connect to. The column name must designate a valid column of the data source.
`IliDataSource`	`dataSource`	Contains the data source object. This property cannot be written to if the `dataSourceName` property is not empty. In other words, the data source can be specified either literally through the `dataSource` property or by name through the `dataSourceName` property, but not both.
`String`	`dataSourceName`	Contains the data source name.
`String`	`foreignDataSourceName`	Contains the foreign data source name.
`String`	`foreignDisplayColumnName`	Contains the foreign display column name.
`IliTable`	`foreignTable`	Contains the foreign table. This property cannot be written to if the `foreignDataSourceName` property is not empty. In other words, the foreign table can be specified either literally through the `foreignTable` property or by name through the `foreignDataSourceName` property, but not both.
`String`	`foreignValueColumnName`	Contains the foreign value column name.
`Boolean`	`inputModified`	This property is `true` if the external representation has been edited by the end user since the last validation.	read-only
`Boolean`	`readOnly`	This property is `true` if the gadget is read-only.
`Int`	`selected`	Contains the position of the currently selected item.
`String`	`tablePropertyManagerName`	Contains the name of the table property manager used by this gadget or `null` if the data source's table property manager is used. Initially, this property is `null`.
`Boolean`	`useTableProperties`	Contains `true` if the gadget uses table properties. Note that the gadget will effectively use table properties if this property is `true` and if the data source to which it is connected is also using table properties. Initially, this property is `true`.
`Variant`	`value`	Contains the selected value.
`Datatype`	`valueType`	Contains the data type of the value. It can be one of the following: `String` `Integer` `Boolean` `Double` `Float` `Decimal` `Date` `Time` Although this property is not read-only, it should not be assigned if the option menu is connected to a data source.
`Void`	`endOfBatch()`	Called to terminate a series of modifications of properties. A call to this method must be preceded by a call to the `startOfBatch` method. Calls to `startOfBatch` and `endOfBatch` can be nested.
`Void`	`startOfBatch()`	Called to start a series of modifications of properties. A call to this method must be followed by a call to the `endOfBatch` method.