Interface IModelRecord

A record in a IModelRecordSet.

Inherited Members

IRecord.Names

IRecord.Count

IRecord.GetName(int)

IRecord.Get(string)

IRecord.IndexOf(string)

IRecord.Get(int)

Namespace: Attachmate.Verastream.HostIntegrator.ScriptAPI

Assembly: Attachmate.Verastream.HostIntegrator.ScriptAPI.dll

Syntax

public interface IModelRecord : IRecord

Remarks

A record in a IModelRecordSet. The names of the columns are the names of the fields in the underlying model record set.

Properties

Blank

Checks if the record is considered blank.

Declaration

bool Blank { get; }

Property Value

Type	Description
bool	True if the record is considered blank

Remarks

Checks if the record is considered blank. Blank records are often used for direct record inserts.

Excluded

Checks if the record is excluded.

Declaration

bool Excluded { get; }

Property Value

Type	Description
bool	True if the record is excluded

Remarks

Checks if the record is excluded. Excluded records are not visible to client applications. Often, blank and repeated records are excluded.

Index

Gets the index assigned to this record by the model.

Declaration

int Index { get; }

Property Value

Type	Description
int	The one-based recordset record index

Remarks

Gets the index assigned to this record by the model. This is not the row number in parent recordset IModelRecordSet object. In fact, the record indices are likely not contiguous.

Methods

GetTerminalAttributes(int)

Gets the terminal attributes by column index.

Declaration

ITerminalAttributes GetTerminalAttributes(int index)

Parameters

Type	Name	Description
int	index	The column index

Returns

Type	Description
ITerminalAttributes	The ITerminalAttributes of the first cell in the field

Exceptions

Type	Condition
ApptrieveException	Thrown if the field index is invalid

GetTerminalAttributes(string)

Gets the terminal attributes by field name.

Declaration

ITerminalAttributes GetTerminalAttributes(string field)

Parameters

Type	Name	Description
string	field	The field name

Returns

Type	Description
ITerminalAttributes	The ITerminalAttributes of the first cell in the field.

Exceptions

Type	Condition
ApptrieveException	Thrown if the field name is invalid