ComponentOne True DataControl 8.0
TDataLite Control All Members

 

TDataLite Control All Members

TDataLite Control Properties

 

Appearance

Enables/disables 3-D display effects for the control.

Array

Specifies an XArrayDB object as the control's data source.

BackColor

Sets/returns the background color.

BOFAction

Action taken on reaching BOF (begin of file).

ButtonAdd

Determines if the Add button is visible.

ButtonBookmark

Determines if the Bookmarks button is visible.

ButtonCancel

Determines if the Cancel button is visible.

ButtonDelete

Determines if the Delete button is visible.

ButtonFind

Determines if the Find button is visible.

ButtonFirst

Determines if the First and Last buttons are visible.

ButtonNext

Determines if the Previous and Next buttons are visible.

ButtonPage

Determines if the Previous Page and Next Page buttons are visible.

ButtonQuery

Determines if the Query button is visible.

ButtonUpdate

Determines if the Update button is visible.

CallDataRead

Specifies if the DataRead event is fired.

CallDataWrite

Specifies if the DataWrite event is fired.

Caption

Text displayed in the middle section of the control.

ChangeInProgress

If True, prevents automatic refresh while making batch changes.

ConfirmCancel

Determines whether to show confirmation message box when the Cancel button is pressed.

ConfirmDelete

Determines whether to show confirmation message box when the Delete button is pressed.

Constraints

Contains a collection of constraint objects.

ConvertEmptyToNull

Specifies if empty string values should be converted to Null on save.

ConvertNullToEmpty

Specifies if Null values of string fields should be converted to empty strings on retrieval.

DataMember

Qualifies the DataSource property setting.

DataMode

Specifies the type of data storage on which the control operates.

DataSource

Sets/returns the source of underlying data in DataMode = 0 – DataSource.

Enabled

Enables/disables user interaction.

EOFAction

Action taken on reaching EOF (end of file).

ErrorMsgCaption

Overrides default message box caption for run-time errors.

Fields

Contains a collection of field objects.

Filtered

Enables/disables filtering.

FilterExpressions

Contains a collection of filter expression objects.

Font

Specifies the font used to display the caption text.

ForeColor

Sets/returns the foreground color.

LockType

Sets/returns the type of locking (concurrency) to use.

ManualUpdate

If True, SourceRecordset changes are not automatically saved to the database on Update.

MouseIcon

Sets a custom mouse icon.

MousePointer

The type of mouse pointer displayed when over the control.

NamedBookmarks

Contains a collection of named bookmark objects, for Bookmarks button dialog.

PageSize

Sets/returns the number of records in a page.

Parameters

Contains a collection of parameter objects.

Pivot

This property enables Pivot mode.

PivotColumnDimension

Together with PivotRowDimensions and PivotMeasure, this property constitutes the end-user query

PivotConnectionString

Specifies connection to an OLAP server or an off-line OLAP cube file.

PivotCubeName

Specifies the name of a cube in a cube file or on an OLAP server, see PivotConnectionString.

PivotFieldsAllLevels

In pivot mode, TData control exposes a hierarchical recordset. Each hierarchy level corresponds to a row dimension, the depth of the hierarchy equals the number of fields in PivotRowDimensions.

PivotMeasure

Constitutes the end-user query, determines the data retrieved from the decision cube and exposed in the TData hierarchical recordset.

PivotQuery

Returns a string, the text of a multidimensional query (MDX) that is currently active.

PivotRowDimensions

Determines the data retrieved from the decision cube and exposed in the TData hierarchical recordset.

PooledConnectionCount

Returns the number of connections in the pool shared by all TData controls.

PropertyExpressions

Contains a collection of property expression objects.

QueryFilter

Returns the Filter string that can be applied to an ADO recordset, composed from user-supplied data in query mode.

QueryMode

If True, the control is in query mode.

Recordset

Returns the ADO recordset object representing control's data.

RefreshOnSrcChange

Determines whether SourceRecordset changes trigger refresh.

ResyncAfterUpdate

Determines whether to call SourceRecordset.Resync immediately after SourceRecordset.Update.

Tooltips

Determines if the button tooltips are enabled.

Xtab

If True, the control is used in crosstab mode.

XTabColKey

For crosstab mode, comma-delimited list of key fields defining crosstab columns.

XTabCollate

For crosstab mode with multiple crosstab fields, if set to True, makes all columns for one field appear after all columns for another.

XTabRowKey

For crosstab mode, comma-delimited list of primary key fields defining crosstab rows.

XTabSeparateFields

For crosstab mode, if set to True, exposes crosstab columns as independent fields at design time.

TDataLite Control Methods

 

ArrayIndexToBookmark

Converts array index to bookmark in memory array mode.

BookmarkToArrayIndex

Converts bookmark to array index in memory array mode.

ButtonEnabled

Returns the enabled state of a control button.

Drag

Begins, ends, or cancels a drag operation of the control.

EnableButton

Sets the enabled state of a button.

Move

Moves the position of the control on the form.

PivotOpen

In pivot mode, opens pivot query.

PressButton

Invokes the action of a control’s button.

Refresh

Refetches all data.

RetrieveFields

Retrieves field layout from the source recordset.

SetButtonPicture

Changes the picture on a button.

SetUIString

Changes a string shown to the end-user.

ShowWhatsThis

Displays the appropriate help topic for the control.

ZOrder

Places the control at the front or back of the z-order.

TDataLite Control Events

 

ButtonPressed

Occurs when a control button is pressed.

ButtonStateChanged

Occurs when a control button's enable state changes.

CalcFields

Occurs before calculated field expressions are evaluated.

CalcFieldsComplete

Occurs after calculated field expressions have been evaluated.

DataRead

Occurs immediately after retrieving a row of values from the data source.

DataWrite

Occurs immediately before saving changed values to the data source.

Error

Occurs as a result of an error that takes place when no user code is being executed.

FieldChangeComplete

Occurs after a field value has changed.

Filter

Occurs before filter expressions are evaluated.

FilterComplete

Occurs after filter expressions have been evaluated.

GetBookmarkName

Occurs when Bookmarks Dialog is being opened. Allows you to specify the current bookmark name.

MoveComplete

Occurs after the current row position has changed.

OpenData

Occurs at startup and on every refresh. Allows the user to set the underlying recordset (SourceRecordset property) or XArrayDB (Array property) object.

OpenDataComplete

Occurs at startup and on every refresh, after the OpenData event.

RecordChangeComplete

Occurs after a record has been added/deleted/updated/restored.

RecordsetChangeComplete

Occurs after the whole recordset has changed.

WillChangeField

Occurs before a field value changes.

WillChangeRecord

Occurs before the current row position changes.

WillChangeRecordSet

Occurs before the whole contents of the recordset change due to a pending operation.

WillMove

Occurs before the current row position changes.

WillOpenData

Occurs at startup and on every refresh, before the OpenData event.

 

 


Copyright (c) GrapeCity, inc. All rights reserved.

Product Support Forum  |  Documentation Feedback