Interface IRecordSetEvent
Record set event information.
Inherited Members
Namespace: Attachmate.Verastream.HostIntegrator.ScriptAPI
Assembly: Attachmate.Verastream.HostIntegrator.ScriptAPI.dll
Syntax
public interface IRecordSetEvent : IEntityEvent, IHostSessionEvent, IModelEvent, IEvent
Properties
PageNumber
Gets the one-based page number of the recordset.
Declaration
int PageNumber { get; }
Property Value
Type | Description |
---|---|
int | The one-based page number of the recordset. |
Remarks
Gets the one-based page number of the recordset. The page number is one
plus the number of times scrolled down minus the number of times
scrolled up.
If no scrolling has occurred, the recordset is considered to be on
the first page. After paging down once, the recordset is considered to
be on the second page.
If the recordset is paged up while on the first page, the state of
the recordset is reset and the counting starts over again. Thus the page
number will always be greater than or equal to one.
RecordSetContext
Gets the record set context.
Declaration
IRecordSetContext RecordSetContext { get; }
Property Value
Type | Description |
---|---|
IRecordSetContext | the record set context |
Remarks
Gets the record set context. The record set context can be used to preserve state information between events.
RecordSetMetaData
Gets the metadata for this recordset.
Declaration
IRecordSetMetaData RecordSetMetaData { get; }
Property Value
Type | Description |
---|---|
IRecordSetMetaData | the metadata for the recordset ApptrieveException if an error occurs obtaining the metadata |
RecordSetName
Gets the record set name.
Declaration
string RecordSetName { get; }
Property Value
Type | Description |
---|---|
string | the name of the record set |