IDADatasetEx

 

Specifies whether the dataset is currently active (open) or not. Setting this property to true will automatically open the dataset, while setting it to false will automatically close it.

property Active: Boolean read write

---

Returns True if bookmarked record exists

function BookmarkValid(Bookmark: TBookmark): Boolean

Parameters:

• Bookmark: bookmark that is checked

---

Closes the dataset

procedure Close

---

Indicates whether data-aware controls update their display to reflect changes to the dataset.

function ControlsDisabled: Boolean

---

Returns identificator of current record.

property CurrentRecIdValue: Integer read write

---

Access to the standard VCL TDataSet

property Dataset: TDataSet read

---

Disables dataset constraints

procedure DisableConstraints

---

Disables data display in data-aware controls associated with the dataset.

procedure DisableControls

---

Implementation of Dynamic Where.

property DynamicWhere: TDAWhereBuilder read write

---

Enables dataset constraints

procedure EnableConstraints

---

Enables data display in data-aware controls associated with the dataset.

procedure EnableControls

---

Indicates whether reading the dataset has reached the end of the recordset (EOF = End of File). EOF will only turn true if neither an empty dataset was opened or Next was called while the cursor was already on the last record (it will not turn to true when reaching the last record).

property Eof: Boolean read

---

Finds a field based on its name. If the specified field does not exist, FieldByName raises an exception.

function FieldByName(const aName: string): TDAField

Parameters:

• aName: name of the searched field

---

Indicates the number of fields contained in the dataset.

property FieldCount: Integer read

---

Provides access to all the fields contained in the dataset.

property Fields: TDAFieldCollection read

---

Provides convenient access to all the fields values of the current record without having to go though the Fields collection property.

property FieldValues[Index: Integer]: Variant read

---

Returns an item with the specified name.

function FindField(const aName: string): TDAField

Parameters:

• aName: name of the searched field

---

Frees the resources allocated for a specified bookmark.

procedure FreeBookmark(Bookmark: TBookmark)

Parameters:

• Bookmark: bookmark that should be freed

---

Indicates whether reading the dataset has reached the beginning of the recordset (BOF = Beginning of File). GetBOF will only turn true if neither an empty dataset was opened nor Prior was called while the cursor was on the first record (it will not turn to true automatically when reaching the first record).

function GetBOF: Boolean

---

Allocates a bookmark for the active record

function GetBookMark: TBookmark

---

Indicates the current operating mode

function GetState: TDatasetState

---

Positions on the record to which a specified bookmark points.

procedure GotoBookmark(Bookmark: TBookmark)

Parameters:

• Bookmark: record identified by this Bookmark should be active

---

Indicates whether the dataset contains no records.

property IsEmpty: Boolean read

---

Locates and activates a record by key values.

function Locate(const KeyFields: string; const KeyValues: Variant; Options: TLocateOptions): Boolean

Parameters:

• KeyFields: The semicolon-separated list of fields.
• KeyValues: Values specified by the Variant or Variant array.
• Options: Indicates whether the search is case insensitive and whether partial matches are supported.

---

Defines the name of the data table.

property LogicalName: string read write

---

Retrieves the field values from the record that matches the specified search values.

function Lookup(const KeyFields: string; const KeyValues: Variant; const ResultFields: string): Variant

Parameters:

• KeyFields: the semicolon-separated list of fields
• KeyValues: Values specified by the Variant or Variant array.
• ResultFields: The semicolon-separated list of result fields.

---

Returns a human-readable name for the command. For commands obtained through a TDASchema component, this will be the name that the command (or data table) was defined under in Schema Modeler. When obtaining a command from an IDAConnection, the name can be specified in the call to NewCommand or NewDataset.

property Name: string read

---

Returns data table's field name specified by Index

property Names[Index: Integer]: string read

---

Advances the cursor to the next available record in the dataset. If the current record is the last record available, calling Next will set EOF to indicate the end of the dataset has been reached.

procedure Next

---

Fires after dataset was opened

property OnAfterOpen: TDAAfterOpenDatasetEvent read write
delegate:  procedure OnAfterOpen(const Sender: IDADataset; ActualSQL: string; ElapsedMilliseconds: Cardinal)

---

Fires before dataset was opened

property OnBeforeOpen: TDABeforeOpenDatasetEvent read write
delegate:  procedure OnBeforeOpen(const Sender: IDADataset)

---

Opens the dataset and prepares it for fetching records from the database.

procedure Open

---

Locates a specific parameter, based on its name. If no matching parameter is defined, an exception will be raised.

function ParamByName(const aName: string): TDAParam

Parameters:

• aName: name of the parameter

---

Provides access to the list of parameters defined for the command.

property Params: TDAParamCollection read

---

Returns the counf of records

property RecordCount: Integer read

---

Reopens the dataset.

procedure Refresh

---

Returns record ID

property RowRecIdValue: Integer read

---

Determines the current operating mode of the dataset. The state property determines which operations can be performed with the data in the dataset, such as editing existing records or inserting new ones. The dataset state constantly changes as the application processes data.

property State: TDatasetState read

 

Specifies whether the dataset is currently active (open) or not. Setting this property to true will automatically open the dataset, while setting it to false will automatically close it.

property Active: Boolean read write

---

Returns identificator of current record.

property CurrentRecIdValue: Integer read write

---

Access to the standard VCL TDataSet

property Dataset: TDataSet read

---

Implementation of Dynamic Where.

property DynamicWhere: TDAWhereBuilder read write

---

Indicates whether reading the dataset has reached the end of the recordset (EOF = End of File). EOF will only turn true if neither an empty dataset was opened or Next was called while the cursor was already on the last record (it will not turn to true when reaching the last record).

property Eof: Boolean read

---

Indicates the number of fields contained in the dataset.

property FieldCount: Integer read

---

Provides access to all the fields contained in the dataset.

property Fields: TDAFieldCollection read

---

Provides convenient access to all the fields values of the current record without having to go though the Fields collection property.

property FieldValues[Index: Integer]: Variant read

---

Indicates whether the dataset contains no records.

property IsEmpty: Boolean read

---

Defines the name of the data table.

property LogicalName: string read write

---

Returns a human-readable name for the command. For commands obtained through a TDASchema component, this will be the name that the command (or data table) was defined under in Schema Modeler. When obtaining a command from an IDAConnection, the name can be specified in the call to NewCommand or NewDataset.

property Name: string read

---

Returns data table's field name specified by Index

property Names[Index: Integer]: string read

---

Provides access to the list of parameters defined for the command.

property Params: TDAParamCollection read

---

Returns the counf of records

property RecordCount: Integer read

---

Returns record ID

property RowRecIdValue: Integer read

---

Determines the current operating mode of the dataset. The state property determines which operations can be performed with the data in the dataset, such as editing existing records or inserting new ones. The dataset state constantly changes as the application processes data.

property State: TDatasetState read

 

Returns True if bookmarked record exists

function BookmarkValid(Bookmark: TBookmark): Boolean

Parameters:

• Bookmark: bookmark that is checked

---

Closes the dataset

procedure Close

---

Indicates whether data-aware controls update their display to reflect changes to the dataset.

function ControlsDisabled: Boolean

---

Disables dataset constraints

procedure DisableConstraints

---

Disables data display in data-aware controls associated with the dataset.

procedure DisableControls

---

Enables dataset constraints

procedure EnableConstraints

---

Enables data display in data-aware controls associated with the dataset.

procedure EnableControls

---

Finds a field based on its name. If the specified field does not exist, FieldByName raises an exception.

function FieldByName(const aName: string): TDAField

Parameters:

• aName: name of the searched field

---

Returns an item with the specified name.

function FindField(const aName: string): TDAField

Parameters:

• aName: name of the searched field

---

Frees the resources allocated for a specified bookmark.

procedure FreeBookmark(Bookmark: TBookmark)

Parameters:

• Bookmark: bookmark that should be freed

---

Indicates whether reading the dataset has reached the beginning of the recordset (BOF = Beginning of File). GetBOF will only turn true if neither an empty dataset was opened nor Prior was called while the cursor was on the first record (it will not turn to true automatically when reaching the first record).

function GetBOF: Boolean

---

Allocates a bookmark for the active record

function GetBookMark: TBookmark

---

Indicates the current operating mode

function GetState: TDatasetState

---

Positions on the record to which a specified bookmark points.

procedure GotoBookmark(Bookmark: TBookmark)

Parameters:

• Bookmark: record identified by this Bookmark should be active

---

Locates and activates a record by key values.

function Locate(const KeyFields: string; const KeyValues: Variant; Options: TLocateOptions): Boolean

Parameters:

• KeyFields: The semicolon-separated list of fields.
• KeyValues: Values specified by the Variant or Variant array.
• Options: Indicates whether the search is case insensitive and whether partial matches are supported.

---

Retrieves the field values from the record that matches the specified search values.

function Lookup(const KeyFields: string; const KeyValues: Variant; const ResultFields: string): Variant

Parameters:

• KeyFields: the semicolon-separated list of fields
• KeyValues: Values specified by the Variant or Variant array.
• ResultFields: The semicolon-separated list of result fields.

---

Advances the cursor to the next available record in the dataset. If the current record is the last record available, calling Next will set EOF to indicate the end of the dataset has been reached.

procedure Next

---

Opens the dataset and prepares it for fetching records from the database.

procedure Open

---

Locates a specific parameter, based on its name. If no matching parameter is defined, an exception will be raised.

function ParamByName(const aName: string): TDAParam

Parameters:

• aName: name of the parameter

---

Reopens the dataset.

procedure Refresh

 

Fires after dataset was opened

property OnAfterOpen: TDAAfterOpenDatasetEvent read write
delegate:  procedure OnAfterOpen(const Sender: IDADataset; ActualSQL: string; ElapsedMilliseconds: Cardinal)

---

Fires before dataset was opened

property OnBeforeOpen: TDABeforeOpenDatasetEvent read write
delegate:  procedure OnBeforeOpen(const Sender: IDADataset)