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

Attribute 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 IAttributeEvent : IEntityEvent, IHostSessionEvent, IModelEvent, IEvent

Properties

AttributeMetaData

Get the metadata for this attribute.

Declaration
IAttributeMetaData AttributeMetaData { get; }
Property Value
Type Description
IAttributeMetaData

The metadata for the attribute.

Exceptions
Type Condition
ApptrieveException

Attachmate.Verastream.HostIntegrator.ScriptAPI.ApptrieveException thrown when there is an error obtaining the attribute metadata.

AttributeName

The attribute name.

Declaration
string AttributeName { get; }
Property Value
Type Description
string

The name of the attribute.

TerminalRegion

Gets the screen region that describes the location, size and contents of the attribute.

Declaration
ITerminalRegion TerminalRegion { get; }
Property Value
Type Description
ITerminalRegion

The location and contents of the attribute.

Remarks

Gets the screen region that describes the location, size and contents of the attribute. The object returned can be cast to either LinearTerminalRegion or RectangularTerminalRegion depending on the type of region.

Exceptions
Type Condition
ApptrieveException

Attachmate.Verastream.HostIntegrator.ScriptAPI.ApptrieveException thrown when there is no associated terminal region.

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