Unit 'BufDataset' Package
[Overview][Types][Classes][Procedures and functions][Index] [#fcl]

TCustomBufDataset.IndexName

Name of the selected index for the dataset.

Declaration

Source position: bufdataset.pas line 691

published property TCustomBufDataset.IndexName : string
  read GetIndexName
  write SetIndexName;

Description

IndexName is a String property that contains the name for the selected index for the buffered dataset. The value in IndexName is read from the corresponding property in CurrentIndexBuf (when assigned).

If an empty string ('') is assigned to the property, the the default index is selected for the dataset and the property is updated to 'DEFAULT_ORDER'. Any other value assigned to the property is compared to the index definitions for the dataset. If an index cannot be located with the specified name, a Database exception is raised. The index with the specified name (and its storage mechanism) are stored in the CurrentIndexDef and CurrentIndexBuf properties. If the dataset is Active, the Resync method is called to enable the new record order for the dataset.

See also

TDataset.Active

  

Is the dataset open or closed.

TDataset.Resync

  

Resynchronize the data buffer.


Documentation generated on: Nov 22 2024