Interface IWriteAttributesEvent

Write attributes 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 IWriteAttributesEvent : IEntityEvent, IHostSessionEvent, IModelEvent, IEvent

Remarks

Write attributes event information. See WriteAttributes(IWriteAttributesEvent)

Properties

AttributeWriteValues

Gets the set of attributes and associated values to be written.

Declaration

IDictionary<string, string> AttributeWriteValues { get; }

Property Value

Type	Description
IDictionary<string, string>	A map of attribute names to attribute values

Methods

DefaultWriteAttributes()

Writes the attributes to the screen using the default algorithm.

Declaration

void DefaultWriteAttributes()

Remarks

Writes the attributes to the screen using the default algorithm. See DefaultWriteAttributes(IDictionary<string, string>) for a description of the default algorithm.

Exceptions

Type	Condition
ApptrieveException

DefaultWriteAttributes(IDictionary<string, string>)

Writes the attributes to the screen using the default algorithm.

Declaration

void DefaultWriteAttributes(IDictionary<string, string> values)

Parameters

Type	Name	Description
IDictionary<string, string>	values	map of attribute names to attribute values

Remarks

Writes the attributes to the screen using the default algorithm. For character mode hosts, attributes will be written in one of two ways:

• Move cursor forward event handler or command list is defined - VHI will iteratively fire the move cursor forward event or iteratively execute the move cursor forward command list. If the cursor moves to a new location, VHI will check if that location corresponds to an attribute that needs writing and write to it. If the cursor does not move to a new location and more attributes still need to be written, VHI will begin iteratively firing the move cursor backward event or move cursor backward command list if defined. If tab stops are defined on the entity, the event or command list must always stop at a tab stop.
• Move cursor forward event handler or command list is NOT defined - VHI will write the attributes in a arbitrary order, issuing a move cursor command to correctly position the cursor at each attribute before writing to it.

Exceptions

Type	Condition
ApptrieveException

WriteAttribute(string, string)

Writes the specified value to the specified attribute.

Declaration

void WriteAttribute(string name, string attrValue)

Parameters

Type	Name	Description
string	name	the attribute name
string	attrValue	the value to write

Remarks

Writes the specified value to the specified attribute. If the cursor is not at the attribute's location, a MoveCursor command will automatically be issued. Upon successfully positioning the cursor at the attribute, the value will be written to the screen, firing the appropriate WriteAttribute(string, string), if any.

Exceptions

Type	Condition
ApptrieveException