Interface IRecordEvent
Record set event information.
Inherited Members
Namespace: Attachmate.Verastream.HostIntegrator.ScriptAPI
Assembly: Attachmate.Verastream.HostIntegrator.ScriptAPI.dll
Syntax
public interface IRecordEvent : IRecordSetEvent, IEntityEvent, IHostSessionEvent, IModelEvent, IEvent
Properties
HostRecordIndex
Gets the one-based index of this record on the screen.
Declaration
int HostRecordIndex { get; }
Property Value
Type | Description |
---|---|
int | the one-based host record index |
Remarks
Gets the one-based index of this record on the screen. This is the index of the record within the current screen, not the index of the record within the recordset. This method will return one for the first record of every screen in the recordset.
RecordIndex
Gets the one-based index of the record within the recordset.
Declaration
int RecordIndex { get; }
Property Value
Type | Description |
---|---|
int | The one-based record index |
Methods
GetRecordStateObject(string)
Gets the object bound to the specified name in this record set context, or null if no object is bound to the name.
Declaration
object GetRecordStateObject(string name)
Parameters
Type | Name | Description |
---|---|---|
string | name | the name of the object |
Returns
Type | Description |
---|---|
object | the object bound to the specified name or null if none |
IsRecordStateObject(string)
Tests for the presence of a record set context object bound to the specified name.
Declaration
bool IsRecordStateObject(string name)
Parameters
Type | Name | Description |
---|---|---|
string | name | the name of the object |
Returns
Type | Description |
---|---|
bool | true if an object is bound to the specified name |
SetRecordStateObject(string, object)
Binds an object to this record set context, using the name specified.
Declaration
void SetRecordStateObject(string name, object obj)
Parameters
Type | Name | Description |
---|---|---|
string | name | the name to which to bind the object |
object | obj | the object to bind |
Remarks
Binds an object to this record set context, using the name specified. If an object of the same name is already bound to the record set context, the object is replaced.