ComponentOne True DataControl 8.0
TData Control All Members

 

TData Control All Members

TData Control Properties

 

AllowEarlyOpen

Can be set to False to work around limitations of some data bound controls.

Appearance

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

ApproxCount

Sets/returns the approximate number of rows in recordset in user events mode.

Array

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

AutoRefresh

Controls automatic refresh of detail control upon change in master.

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.

CacheSize

Returns/sets the number of rows to keep cached navigating through the recordset.

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.

CommandTimeout

Amount of time to wait for the command to return (in seconds).

CommandType

Indicates the type of command.

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.

ConnectionString

Determines the ADO connection string used to establish data connection in data source mode.

ConnectionTimeout

Amount of time to wait for the connection to open before aborting it.

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.

CursorLocation

Determines if server-side or client-side cursors are used (which cursor engine used).

CursorType

Sets the cursor type to use for the underlying recordset.

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.

DesignConnection

If True, live database connection is always used at design time.

DesignTimeout

Seconds to wait for database connection at design time before aborting it.

Enabled

Enables/disables user interaction.

EOFAction

Action taken on reaching EOF (end of file).

ErrorMsgCaption

Overrides default message box caption for run-time errors.

ErrorMsgRestore

Specifies whether to prompt for resetting value on field value 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.

LinkType

Specifies how this control is linked to another TData control.

LockType

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

ManualUpdate

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

Master

Specifies the TData control on which this control is dependent.

MaxRecords

Maximum number of records to retrieve when opened.

Mode

Describes the mode in which the current connection is opened.

MouseIcon

Sets a custom mouse icon.

MousePointer

The type of mouse pointer displayed when over the control.

NameSubstitute

Used in containers that don’t support the standard Name property (for example, VC++).

NamedBookmarks

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

Orientation

Control's orientation, either horizontal or vertical.

PageSize

Sets/returns the number of records in a page.

Parameters

Contains a collection of parameter objects.

Password

For OLE DB providers that support password.

PooledConnectionCount

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

PooledConnections

Returns 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.

RecordSource

Source of recordset in data source mode: SQL, other command text or table name.

RefreshOnSrcChange

Determines whether SourceRecordset changes trigger refresh.

ResyncAfterUpdate

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

SafeMode

If True, ADO recordsets are used with extra caution, avoiding certain problems in various OLE DB providers.

SourceConnection

Sets/returns the ADO connection used to connect to underlying data in data source mode.

SourceRecordset

Sets/returns the ADO recordset used as underlying data in data source mode.

Tooltips

Determines if the button tooltips are enabled.

UserName

For OLE DB providers that support user name.

TData 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.

CancelUpdate

Enhanced version of ADO CancelUpdate, includes resetting bound controls.

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.

PressButton

Invokes the action of a control’s button.

RaiseError

Used to specify error description in user mode events.

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.

UpdateFields

Updates the recordset with modified values from bound controls.

ZOrder

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

TData 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.

UserAddData

Occurs when a new row is added in DataMode = 2 – UserEvents.

UserDeleteRow

Occurs when a row needs to be deleted in DataMode = 2 – UserEvents.

UserFindData

Occurs in DataMode = 2 - UserEvents, when the control needs to find a row based upon a simple filter.

UserReadData

Occurs when the control requires data in DataMode = 2 – UserEvents.

UserWriteData

Occurs when a row needs to be modified in DataMode = 2 – UserEvents.

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