.NET ScriptAPI Method Reference

.NET ScriptAPI Method Reference

Show / Hide Table of Contents
  • Attachmate.Verastream.HostIntegrator.ScriptAPI
    • AppConnAidKey
    • ApptrieveException
    • AttributeEventHandler
    • ColumnType
    • ColumnValue
    • ContextType
    • CursorPosition
    • DescriptionAttribute
    • EchoType
    • EntityEventHandler
    • ErrorMessage
    • EventHandlerConstant
    • EventHandlerType
    • EventInfo
    • EventTimeoutException
    • FieldEventHandler
    • HostColor
    • HostFont
    • IApplyFilterEvent
    • IAttributeEvent
    • IAttributeMetaData
    • IAuthenticateUserEvent
    • IClientConnectedEvent
    • IClientDisconnectedEvent
    • IClientSession
    • IClientSessionCreatedEvent
    • IClientSessionDestroyedEvent
    • IColumnMetaData
    • IEntityArrivalEvent
    • IEntityDepartureEvent
    • IEntityEvent
    • IEntityMoveCursorEvent
    • IErrorReportedEvent
    • IEvent
    • IEventHandler
    • IExecuteLoginEvent
    • IExecuteLogoutEvent
    • IExecuteOperationEvent
    • IExecuteProcedureEvent
    • IFieldEvent
    • IFieldLocation
    • IFieldMetaData
    • IFormatErrorEvent
    • IGetCurrentHostRecordEvent
    • IGetRecordTypeEvent
    • IHostSession
    • IHostSessionCreatedEvent
    • IHostSessionDestroyedEvent
    • IHostSessionEvent
    • IInsertRecordEvent
    • IIsTerminatedEvent
    • ILifeCycleEvent
    • ILinearTerminalRegion
    • ILogger
    • IMetaData
    • IModelContext
    • IModelCursorEvent
    • IModelEvent
    • IModelLoadedEvent
    • IModelMoveCursorBackwardEvent
    • IModelMoveCursorEvent
    • IModelMoveCursorForwardEvent
    • IModelRecord
    • IModelRecordSet
    • IModelUnloadedEvent
    • IMutableProcedureRecord
    • IMutableProcedureRecordSet
    • IOperationMetaData
    • IParseRecordEvent
    • IParseScreenEvent
    • IProcedureMetaData
    • IProcedureParameters
    • IProcedureRecord
    • IProcedureRecordSet
    • IProcessStringEvent
    • IReadAttributeEvent
    • IReadFieldEvent
    • IRecord
    • IRecordEvent
    • IRecordLocation
    • IRecordSet
    • IRecordSetContext
    • IRecordSetEvent
    • IRecordSetMetaData
    • IRecordSetScreen
    • IRectangularTerminalRegion
    • IScriptHostSession
    • ITerminalAttributes
    • ITerminalCell
    • ITerminalRegion
    • IUnrecognizedScreenEvent
    • IUpdateRecordEvent
    • IVariableMetaData
    • IWriteAttributeEvent
    • IWriteAttributesEvent
    • IWriteFieldEvent
    • IndexValue
    • LifeCycleEventHandler
    • MetaDataType
    • ModelEventHandler
    • OperationEventHandler
    • ProcedureEventHandler
    • ProcedureType
    • RecordSetEventHandler
    • RecordType
    • RegionType
    • RowValue
    • ScreenSize
    • ScrollDirection
    • ScrollMovement
    • TimeoutAttribute
    • VariableInitialization
    • VariableKind
  • Attachmate.Verastream.HostIntegrator.ScriptAPI.Command
    • CheckOperationConditions
    • Command
    • DefaultValue
    • MoveCursor
    • Navigate
    • ReadFromMappedAttribute
    • ReadVariableFromAttribute
    • ReadVariableFromField
    • ReadVariableFromLocation
    • ReadVariableFromTerminal
    • ResetRecordSet
    • Transmit
    • TransmitTerminalKey
    • TransmitToAttribute
    • TransmitToField
    • TransmitToLocation
    • TransmitToOffset
    • UpdateAttribute
    • UpdateAttributes
    • UpdateRecordSetField
    • UpdateRecordSetFields
    • WaitForCommString
    • WaitForCondition
    • WaitForCursorAtAttribute
    • WaitForCursorAtLocation
    • WaitForCursorAtRecordSetField
    • WaitForCursorAtTerminalField
    • WaitForCursorNotAtLocation
    • WaitForCursorNotAtTerminalField
    • WaitForDisplayString
    • WaitForHostSilence
    • WaitForKeyboardEnabled
    • WaitForMultipleEvents
    • WaitForNewHostScreen
    • WaitForUpdate
    • WaitMS
    • WriteToMappedAttribute
    • WriteVariableToAttribute
    • WriteVariableToField
    • WriteVariableToLocation
    • WriteVariableToTerminal
  • WRQ.Verastream.HostIntegrator
    • RcConst

Interface IRecordEvent

Record set event information.

Inherited Members
IRecordSetEvent.RecordSetName
IRecordSetEvent.PageNumber
IRecordSetEvent.RecordSetContext
IRecordSetEvent.RecordSetMetaData
IEntityEvent.EntityName
IEntityEvent.TabStops
IHostSessionEvent.HostSession
IModelEvent.CurrentOperation
IModelEvent.CurrentProcedure
IModelEvent.ModelContext
IModelEvent.ClientSession
IEvent.Logger
IEvent.CheckForTimeout()
IEvent.EventStack
IEvent.GetHandlerProperty(string)
IEvent.IsDesignEnvironment()
IEvent.CreateUserErrorMessage(string)
IEvent.CreateErrorMessage(int)
IEvent.CreateErrorMessage(int, object[])
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.

In This Article
Back to top © 1985-2024 Rocket Software, Inc. or its affiliates. All Rights Reserved