Class FieldEventHandler

Abstract base class for a field event listener.

Inheritance

object

MarshalByRefObject

FieldEventHandler

Implements

IEventHandler

Inherited Members

MarshalByRefObject.MemberwiseClone(bool)

MarshalByRefObject.GetLifetimeService()

MarshalByRefObject.CreateObjRef(Type)

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: Attachmate.Verastream.HostIntegrator.ScriptAPI

Assembly: Attachmate.Verastream.HostIntegrator.ScriptAPI.dll

Syntax

public abstract class FieldEventHandler : MarshalByRefObject, IEventHandler

Remarks

Abstract base class for a field event listener. All classes that extend this class appear as field event handlers in the VHI design tool.

Methods

InitializeLifetimeService()

Tell the .NET Framework remoting system that instances of this type have an infinite lifetime.

Declaration

public override object InitializeLifetimeService()

Returns

Type	Description
object	A null value.

Overrides

MarshalByRefObject.InitializeLifetimeService()

ReadField(IReadFieldEvent)

Called to read the field.

Declaration

public virtual string ReadField(IReadFieldEvent vsEvent)

Parameters

Type	Name	Description
IReadFieldEvent	vsEvent	The event instance.

Returns

Type	Description
string	The field value.

Remarks

Called to read the field. The value returned from this method will be considered the value of the field.
Any exception thrown from this event will cause the field read to fail. See RecordSetEventHandler for details about when this event is fired in relation to recordset events. NOTE: IScriptHostSession methods that change the terminal screen cannot be called within this event.

Exceptions

Type	Condition
ApptrieveException	Any exception thrown will cause the field read to fail.

WriteField(IWriteFieldEvent)

Called to write the field.

Declaration

public virtual void WriteField(IWriteFieldEvent vsEvent)

Parameters

Type	Name	Description
IWriteFieldEvent	vsEvent	The event instance.

Remarks

Called to write the field. The write will be considered successful unless an exception is thrown.

Exceptions

Type	Condition
ApptrieveException	Any exception thrown from this event will cause the field write to fail.

Implements

IEventHandler