Accessors for class IliDbField

Properties

Methods

Description

The IliDbField class defines a gadget that can:
A DbField can be connected to a data source's column. Whenever the value of this column changes in the data source, the DbField's value property is updated accordingly.
A DbField also has a style property that determines the look and feel. It is used to make the DbField look like another gadget, such an entry field, a toggle, and so on.
It has a label that will be displayed near the gadgets. The label can be positioned either on top of the DbField or to its left, except for some styles where the label is at a fixed position.

TypeNameDescriptionNotes
DirectionalignmentContains the alignment of the text inside the DbField. The text can be right-aligned (right), left-aligned (left), or center-aligned (center). This property applies only if the style is one of the following:
  • IliEntryFieldStyle

  • IliTextStyle

  • IliTableComboBoxStyle

StringcolumnNameContains the column name that the gadget must connect to. The column name must designate a valid column of the data source.
BooleancompletionThis property is true if completion is enabled for the field. The completion mechanism allows an incomplete textual representation to be completed using the foreign table. This allows the user to enter the initial characters of a word and have the field automatically complete the word. This property applies only if the style is IliTableComboBoxStyle.
BooleanconstrainedThis property is true if the foreign table limits the set of possible internal values for this field. This property applies only if the style is IliTableComboBoxStyle.
IliDataSourcedataSourceContains 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.
StringdataSourceNameContains the data source name.
StringforeignDataSourceNameContains the foreign data source name. This property applies only if the style is one of the following:
  • IliTableComboBoxStyle

  • IliToggleStyle

  • IliOptionMenuStyle

  • IliToggleSelectorStyle

  • IliStringListStyle

StringforeignDisplayColumnNameContains the foreign display column name. This property applies only if the style is one of the following:
  • IliTableComboBoxStyle

  • IliToggleStyle

  • IliOptionMenuStyle

  • IliToggleSelectorStyle

  • IliStringListStyle

IliTableforeignTableContains 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. This property applies only if the style is one of the following:
  • IliTableComboBoxStyle

  • IliToggleStyle

  • IliOptionMenuStyle

  • IliToggleSelectorStyle

  • IliStringListStyle

StringforeignValueColumnNameContains the foreign value column name. This property applies only if the style is one of the following:
  • IliTableComboBoxStyle

  • IliToggleStyle

  • IliOptionMenuStyle

  • IliToggleSelectorStyle

  • IliStringListStyle

StringformatContains the format used to display the value in a textual form. Note that the format will be temporarily disabled when the entry field gains the focus (if it is editable). This property only applies when the style is one of the following:
  • IliEntryFieldStyle

  • IliTableComboBoxStyle

StringlabelContains the label text. The label serves as a caption (or title) for the gadget. It should not be confused with the label property of the IlvTextField class, which holds a textual representation of the value.
ColorlabelColorContains the label color.
FontlabelFontContains the label font.
StringmaskContains the mask used to edit values in the field. This property only applies when the style is one of the following:
  • IliEntryFieldStyle

  • IliTableComboBoxStyle

IntmaxLengthContains the maximum number of characters the user can type in a DbField. If maxLength has a negative value, it means that there is no limit. This property only applies when the style is one of the following:
  • IliEntryFieldStyle

  • IliTableComboBoxStyle

BooleanreadOnlyThis property is true if the gadget is read-only.
IliDbFieldStylestyleContains the DbField style. It can be one of the following values:
  • IliEntryFieldStyle

  • IliTextStyle

  • IliTableComboBoxStyle

  • IliToggleStyle

  • IliOptionMenuStyle

  • IliToggleSelectorStyle

  • IliStringListStyle

IlvGadgetsubFieldContains the gadget object that corresponds to the DbField style. If the style is IliEntryFieldStyle, the subField property contains an IliEntryField gadget. If the style is IliTextStyle, it contains an IliDbText gadget, and so on. read-only
StringtablePropertyManagerNameContains 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.
BooleanuseTablePropertiesContains 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.
VariantvalueContains the value of the DbField. The type of this property depends on the column's data type.
DatatypevalueTypeContains 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 entry field is connected to a data source.
IntvisibleRowsCountIf the style of the DbField is IliTableComboBoxStyle, the visibleRowsCount property of the table-combo-box is set to this value. See the description of the visibleRowsCount property in the class IliTableComboBox for more information.
VoidputLabelAtLeft()Changes the position of the label so that it appears to the left of the gadget. This method has no effect if the style is one of the following:
  • IliToggleStyle

  • IliToggleSelectorStyle

VoidputLabelOnTop()Changes the position of the label so that it appears above the gadget. This method has no effect if the style is one of the following:
  • IliToggleStyle

  • IliToggleSelectorStyle