Interface IRecordLocation
Specifies the location of a record within a recordset.
Namespace: Attachmate.Verastream.HostIntegrator.ScriptAPI
Assembly: Attachmate.Verastream.HostIntegrator.ScriptAPI.dll
Syntax
public interface IRecordLocationProperties
EorPatternFound
The end-of-record pattern is found in the current read record.
Declaration
bool EorPatternFound { get; set; }Property Value
| Type | Description |
|---|---|
| bool | true if an EOR pattern is found in the current read record. |
Remarks
The end-of-record pattern is found in the current read record. It is possible for a record to be split across screens or between columns on the same screen and a pattern is used as record separator.
See Also
RecordWhole
A "whole" record is entirely contained within this rectangular region.
Declaration
bool RecordWhole { get; set; }Property Value
| Type | Description |
|---|---|
| bool | true if the record should be considered whole, otherwise false |
Remarks
A "whole" record is entirely contained within this rectangular region. It is possible for a record to be split across screens or between columns on the same screen.
See Also
Methods
GetRecordRegion()
Gets the current location, size and contents of the record within the record set.
Declaration
IRectangularTerminalRegion GetRecordRegion()Returns
| Type | Description |
|---|---|
| IRectangularTerminalRegion | the contents of the record |
See Also
GetRecordStateObject(string)
Gets the object bound to the specified name in this record context, or null if no object is bound to the name.
Declaration
object GetRecordStateObject(string name)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | the name of the object |
Returns
| Type | Description |
|---|---|
| object | the object bound to the specified name or null if none |
See Also
IsRecordStateObject(string)
Tests for the presence of a record context object bound to the specified name.
Declaration
bool IsRecordStateObject(string name)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | the name of the object |
Returns
| Type | Description |
|---|---|
| bool | true if an object is bound to the specified name |
See Also
SetRecordRegion(int, int, int, int)
Changes the location and size of the record within the record set using rectangular coordinates.
Declaration
IRectangularTerminalRegion SetRecordRegion(int left, int top, int width, int height)Parameters
| Type | Name | Description |
|---|---|---|
| int | left | the one-based column within the record set |
| int | top | the one-based row within the record set |
| int | width | the number of columns in the record |
| int | height | the number of rows in the record |
Returns
| Type | Description |
|---|---|
| IRectangularTerminalRegion | the new IRectangularTerminalRegion for the field
|
Remarks
Changes the location and size of the record within the record set using rectangular coordinates.
See Also
SetRecordStateObject(string, object)
Binds an object to this record context, using the name specified.
Declaration
void SetRecordStateObject(string name, object obj)Parameters
| Type | Name | Description |
|---|---|---|
| string | name | the name to which to bind the object |
| object | obj | the object to bind |
Remarks
Binds an object to this record context, using the name specified. If an object of the same name is already bound to the record set context, the object is replaced.