Accessors for class IliDbToggle

Properties

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

Description

The IliDbToggle class defines a toggle gadget that can be connected to a data source.
By default, the gadget assigns integer 1 to the value when it is in the checked state and it assigns integer 0 when it is in the unchecked state.
A table, known as a foreign table, can be used to map the checked and unchecked states to values other than 0 and 1.
For example, if you want to use strings "True" and "False" instead of integers 1 and 0, you could :

Create a data source named "MAP" with two columns:
column name: "DISPLAY", type: Integer
column name: "VALUE", type: String
Enter the following rows into this data source:
```
	0, "False"
	1, "True"
```

Set up the db-toggle as follows:

	dbToggle.foreignDataSourceName = "MAP";
	dbToggle.foreignDisplayColumnName = "DISPLAY";
	dbToggle.foreignValueColumnName = "VALUE";

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 is3StatesMode This property is true if the 3 states mode is on.

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

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 value of the db-toggle. The type of this property depends on the column's data type.

Datatype valueType Contains the data type of the value. Its string representation 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 db-toggle is connected to a 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`	`is3StatesMode`	This property is `true` if the 3 states mode is on.
`Boolean`	`readOnly`	This property is `true` if the gadget is read-only.
`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 value of the db-toggle. The type of this property depends on the column's data type.
`Datatype`	`valueType`	Contains the data type of the value. Its string representation 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 db-toggle is connected to a data source.