Class AttributeEventHandler

Abstract base class for an attribute event listener.

Inheritance

object

MarshalByRefObject

AttributeEventHandler

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 AttributeEventHandler : MarshalByRefObject, IEventHandler

Remarks

Abstract base class for an attribute event listener. All classes that extend this class appear as attribute 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()

ReadAttribute(IReadAttributeEvent)

Called to read the attribute.

Declaration

public virtual string ReadAttribute(IReadAttributeEvent vsEvent)

Parameters

Type	Name	Description
IReadAttributeEvent	vsEvent	The event instance that provides runtime information.

Returns

Type	Description
string	The attribute value.

Remarks

Called to read the attribute. The value returned from this method will be considered the value of the attribute.

Exceptions

Type	Condition
ApptrieveException	Any exception returned will cause the attribute read to fail.

WriteAttribute(IWriteAttributeEvent)

Called to write the attribute.

Declaration

public virtual void WriteAttribute(IWriteAttributeEvent vsEvent)

Parameters

Type	Name	Description
IWriteAttributeEvent	vsEvent	The event instance that provides runtime information.

Remarks

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

Exceptions

Type	Condition
ApptrieveException	Any exception returned will cause the attribute write to fail.

Implements

IEventHandler