TIB_Column Object
Properties Methods Events

Unit
IB_Components

Declaration
TIB_Column = class(TObject)

Description
This object is like the VCL TField and TParam combined. It serves as both the input and output column specifier.

Design-time fields are not possible with the native IBO components so it is necessary to do one of two things if you need static references to a column or parameter:



Blob contents can be accessed using the AsString property, Assign() and AssignTo() methods and the CreateBlobStream() method of the TIB_Statement class allows direct usage of the blob streams too. It is not necessary to cast the reference to a TIB_ColumnBlob unless you need something that is specificly made accessible at that class level only.

Introduced Public Properties
Alignment  Used to align the data in the TIB_Grid and other data bound controls.
AsBoolean  Conversion property.
AsComp  Conversion property.
AsCurrency  Conversion property.
AsDate  Conversion property.
AsDateTime  Conversion property.
AsDateTimeEncodeString  Conversion property.
AsDouble  Conversion property.
AsExtended  Conversion property.
AsFloat  Conversion property.
AsInt64  Conversion property.
AsInteger  Conversion property.
AsSmallint  Conversion property.
AsString  Run-time only.
AsVariant  Conversion property.
AsWideString  This is for use with Unicode strings.
AsXML  This property returns the text for a cell of XML for the column's value.
AttributeParams  User defined column properties can be stored via this property.
BDEFieldName  This is the FieldName that the BDE will use.
BestFieldName  A fully qualified column name that omits the table prefix if possible in order to distinguish it from other columns in the dataset.
BlankIsNull 
BlobSize 
BooleanFalse  This property is controlled by the BOOLEAN attribute in the ColumnAttributes property of the connection or dataset.
BooleanTrue  This property is controlled by the BOOLEAN attribute in the ColumnAttributes property of the connection or dataset.
CharCase  Used by databound controls to provide the case expected for this column.
ColData  Direct binary based string of the column's buffer.
Computed  This column is used to tell whether or not the underlying column in a table is derived from a COMPUTED BY expression.
ControlsReadOnly  This property returns whether or not controls associated with this column should allow user manipulation or not.
DataSize  Size of the memory block used to store the contents of this column.
DBFFieldName  This is the FieldName that a DBF file will use.
DefaultWidth  This is a default width of a column in pixels to be used by data bound controls.
DisplayFormat  Used by the DisplayText property to more attractively display data in bound controls that are not in editing mode.
DisplayLabel  Text used as a display label for this column.
DisplayName  This property stores the text which serves as a standard display string to accompany this column as a label in the application.
DisplayText  This property returns the text which serves as a display string for this column in the application.
DisplayWidth  Width in pixels that an IB_Grid's column should use for its width when displaying this column.
DomainName  Name of the InterBase domain to which this column belongs.
DomainNameD  Added quoted delimiters.
EditMask  Used in masked data entry controls for cleaner data entry.
FieldName  Name of column as defined in the SELECT statement.
FieldNo  The numeric position that the column occupies in the row buffer.
ForceControlsReadOnly  This property is to be used at runtime to make a column ReadOnly for a special case that may be temporary.
FullFieldName  A fully qualified column name that includes the name of the table and a period with the alias name of the column.
GridDisplayLabel  Text used as a display label for this column in a grid instead of DisplayLabel.
GridDisplayName  This property stores the text which serves as to override the DisplayName when displaying the column title of a grid.
Index  Numerical reference to the order the TIB_Column is in the TList of columns.
IsAlternate  Work in progress
IsArray  Flag to quickly check if the column is an ARRAY column or not.
IsAttributeSet  User defined column properties' existance can be accessed via this property.
IsBlob  Flag to quickly check if the column is a BLOB column or not.
IsBoolean  Flag to quickly check if the column is defined as a boolean or not.
IsCalculated  Returns whether or not this column is derived by a calculation or not.
IsDateOnly  Flag to quickly check to see if the column is date-only based or not.
IsDateTime  Flag to quickly check to see if the column is date-time based or not.
IsDefaulted  Returns whether or not this column has a server defined default value.
IsForeign  Returns whether or not this column is used in a table's foreign key or not.
IsIndexField  Work in progress
IsLoaded  Returns whether of not this column's content has been Loaded or not.
IsModified  Returns whether of not this column has been modified or not.
IsNotNull  Returns the boolean inverted NULL status of the column.
IsNull  Returns the NULL status of the column.
IsNullable  Returns whether or not this column can contain a NULL on the server.
IsNumeric  Flag to quickly check to see if the column is numeric based or not.
IsPrimary  Returns whether or not this column is used in a table's primary key or not.
IsText  Flag to quickly check to see if the column is text based or not.
IsTimeOnly  Flag to quickly check to see if the column is time-only based or not.
NoCaseFieldName  This property tells the name of the column in the table that is the uppercase equivalent of this column.
OldAsString  Returns the original value of a column if it has changed.
OldAsVariant  Returns the original value of a column if it has changed.
OldColData  Direct binary based string of the column's old value buffer.
OldIsNotNull  Returns whether or not the column was originally NOT NULL.
OldIsNull  Returns whether or not the column was originally NULL.
OrderingLinkItemNo  This provides the value of the OrderingItemNo from the OrderingLinks property that would take effect if this column were used to initiate the Ordering.
OwnerName  Name of the owner of the resource in the database.
PreventEditing  Set the NOEDIT param in the FieldsReadOnly property to configure this value at design-time.
PreventInserting  Set the NOINSERT param in the FieldsReadOnly property to configure this value at design-time.
PreventSearching  Set the NOSEARCH param in the FieldsReadOnly property to configure this value at design-time.
PSQLVAR  Pointer to the SQLVAR SQL column structure used by the IB API.
ReadOnly  Provides information on whether or not this column can be modified.
RelName  Name of the table to which the column belongs.
Required  Returns whether or not this column must provide a value to the server.
Row  Reference to the row to which this object belongs.
SQLLen  The number of characters used in the data portion of the column buffer.
SQLName  Name of the column as it maps to the table.
SQLScale  The number of digits of precision for numerical storage.
SQLSubType  The BLOB type is indicated with this property.
SQLType  Native InterBase SQLType code for this column.
SQLTypeSource  This returns the SQL code that will provide the column type when it was created in a CREATE TABLE statement.
Statement  Reference to the statement to which this object belongs.
Trimming  This property controls how strings are trimmed and gives a few extra nice options.
Value  BDE comaptibility property.
Visible  Used by the TIB_Grid to determine if it should display this column or not.

Introduced Public Methods
Assign   Assigns the data contents of the column or other data member passed in.
AssignTo   Assigns the columns data contents to another data member passed in.
Clear   This function sets a column to NULL.
Create
Destroy
FocusControl   This function scans through all data bound controls and tries to bring to a focused state one which is bound to this column.
GetAttributeParamsEx   This method is for working with the ColumnAttributes settings more accurately.
IsValidChar   This function is used by data-aware controls to determine if a key press is valid for the filed to which it is bound.
LoadFromFile
Revert   Method to cause this column to go back to its original value.
SaveToFile
SetBlobData   Method to transfer data from a raw buffer to the contents of the column.

Introduced Public Events
OnAfterModify  After a column has been modified this event is triggered.
OnBeforeModify  Before a column is modified this event is triggered.
OnGetText  This event is used in conjunction with the AsString property.
OnSetText  This event is used in conjunction with the AsString property.
OnValidate  Event to validate the new value written to the field.