.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 IRecordSetEvent

Record set event information.

Inherited Members
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 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

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