Unit
IB_Components

Declaration
TIB_BDataset = class(TIB_Dataset)

Description
This class serves as a base to the IB_Query component.

It is constructed in such a way that a fully scrollable/updateable dataset is obtained. The buffering of data is all on the client.

All properties and events above the TIB_Dataset class are documented here.

Please see IB_Query for more specific information about how this class is implemented in an application.

Introduced Public Properties

AsXML	This returns the XML equivalent for the entire table.
BookmarkSelected	Access multi-select information for the Dataset based on a Bookmark.
BufferSynchroFlags	This property helps maintain correct synchronization between the client buffer and the server.
CachedDeleteCount	The number of records in the buffer that have been deleted via CachedUpdates.
CachedEditCount	The number of records in the buffer that have been edited via CachedUpdates.
CachedInsertCount	The number of records in the buffer that have been inserted via CachedUpdates.
CachedUpdates	VCL compatibility.
CursorIsKeyFields	Used internally to tell if the CursorFields is also serving as the KeyFields.
FetchWholeRows	This feature is designed to allow the limitations of the buffered query to handle all types of SELECT statements.
Filter	VCL compatibility.
Filtered	VCL compatibility.
FilterOptions	VCL compatibility.
FilterPlan	Provides the ability to specify a particular plan when a dataset is prepared with Filtered=true.
Found	VCL compatibility.
IBODataset	This gives a raw pointer to the parent TDataset class that this instance is serving as an internal cursor to.
IncSearchKeyInt	The amount of time a before a new search string is started when the user is entering in incremental key presses.
IncSearchKeyString	Access to the search string generated by the IncSearchKey() method.
IncSearchLastTick	This keeps track of the timings when incremental searching so that it will be able to calculate the proper timeouts for automatically clearing the incremental searching criteria.
IncSearchSeekInt	The amount of time a matching record is sought for in 1000th of seconds.
IsEmpty	Property which will tell if the dataset is empty or not in the most efficient manner possible.
KeyLinksAutoDefine	Change the default from false to true.
KeySQLSelect	This is the SELECT list that is used to fetch the keys.
NodeList	System reference to the in-memory portion of the buffered dataset.
OrderingRefinePos	The character position that will begin the incremental search.
OrderingRefineStr	This property stores the buffer that is used by the IncSearchString() method to perform incremental searching.
PreparedEdits	Redeclaration of property to better suit a buffered dataset.
RefreshOnParamChange	This property is redeclared in order to change the default behavior of this property for buffered Datasets.
Selected	Access multi-select information for the Dataset based on the RowNum.

Introduced Public Methods

ApplyUpdates	Work in progress.
CalculateFields	Manually initiate the recalculation of calculated fields for the current row.
CancelUpdates	Work in progress.
CheckRecordFilter	Calculate the fields of the row indicated.
ClearIncSearchString	This call will clear out the current incremental search criteria used in conjunction with the key-by-key behavior when calling the IncSearchKey() method.
CommitUpdates	Work in progress.
Create
DefaultDMLCacheReceivedItem
DeleteBufferBookmark	This method will remove a record from the buffer in memory only.
DeleteBufferRowNum	This method will remove a record from the buffer in memory but not generate any SQL to delete the record from the server.
Destroy
FindFirst	VCL compatibility.
FindLast	VCL compatibility.
FindNext	VCL compatibility.
FindPrior	VCL compatibility.
FindRecord	VCL compatibility.
FreeSErverResources
IncSearchKey	Used for processing key-by-key incremental searching.
IncSearchString	Used to process a whole string to be searched for within the current data.
InsertBufferBookmark	W.I.P.
InvalidateBookmark	This method will invalidate a single row from the Dataset such that if it is referred to again it will be fetched from the server again.
InvalidateCalculatedFields	This method will cause the entire dataset to be recalculated if it has any calculated fields declared in it.
InvalidateRowNum	This method will invalidate a single row from the Dataset such that if it is referred to again it will be fetched from the server again.
InvalidateRows	This method will remove all of the individual record buffers for the Dataset and leave the key buffer in tack.
InvalidateSQLWithCursors	By default, the internal cursors are NOT invalidated when the main SQL is invalidated.
Locate	Same as in TDataset
Lookup	Same as in TDataset
LookupKeyForBufferFields	This method is used to locate a record that currently exists in the buffer or if it would when all of the records for the Dataset were fetched from the server.
LookupKeyForFields	This method is used to locate a record that currently exists in the Dataset or if it would when all of the records for the Dataset were fetched from the server.
RevertRecord	Change the record back to the state it was in when the edit or insert mode was started..
SeekKeyForBufferFields	This method is used to locate a record that currently exists in the buffer.
SelectAll	Method to force the Selected state of all rows in the dataset to true or false.
SelectedBookmarks	This method will populate a TStrings list with bookmarks of the selected records.
SelectRange	Gives control over a particular range of rows and their Selected status.
ToggleSelected	Method to toggle the dataset's rows Selected state.
ValidateRows	This method is used to verify if all of the rows in the range specified are valid.

Introduced Public Events

OnFilterRecord	When FetchWholeRows is true this allows a client-side filter to cause records to be left out of the buffer.
OnMultiSelect	This event provides notification of when a multi row selection is performed.
OnRowSelectedChange	This property is being phased out.
OnRowSelectedChanged	This event provides notification of when a row's Selected status is changed.
OnUpdateError	VCL Compatibility.
OnUpdateRecord	VCL Compatibility.