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

Write field event information.

Inherited Members
IFieldEvent.FieldName
IFieldEvent.FieldMetaData
IRecordEvent.RecordIndex
IRecordEvent.HostRecordIndex
IRecordEvent.IsRecordStateObject(string)
IRecordEvent.GetRecordStateObject(string)
IRecordEvent.SetRecordStateObject(string, object)
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 IWriteFieldEvent : IFieldEvent, IRecordEvent, IRecordSetEvent, IEntityEvent, IHostSessionEvent, IModelEvent, IEvent
Remarks

Write field event information. See WriteField(IWriteFieldEvent)

Properties

FieldWriteValue

Gets the value to be written to the field.

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

the value to be written

Remarks

Gets the value to be written to the field. The model-defined prepending, appending and padding will not have been performed on this value.

Methods

DefaultWriteField()

Writes the value returned by FieldWriteValue to the field.

Declaration
void DefaultWriteField()
Remarks

Writes the value returned by FieldWriteValue to the field. The prepending, appending and padding of spaces will be performed as defined in the model. Any before, underfill and after operations defined on the field will be executed.

ApptrieveException if the write fails

DefaultWriteField(string)

Writes the specified value to the field.

Declaration
void DefaultWriteField(string fieldValue)
Parameters
Type Name Description
string fieldValue

the value to write ApptrieveException if the write fails

Remarks

Writes the specified value to the field. The prepending, appending and padding of spaces will be performed as defined in the model. Any before, underfill and after operations defined on the field will be executed.

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