Interface IRectangularTerminalRegion
Represents a rectangular terminal region.
Namespace: Attachmate.Verastream.HostIntegrator.ScriptAPI
Assembly: Attachmate.Verastream.HostIntegrator.ScriptAPI.dll
Syntax
public interface IRectangularTerminalRegion : ITerminalRegionRemarks
Represents a rectangular terminal region. A rectangular terminal region is defined by a row and column location along with a height and width.
Properties
Height
Gets the number of rows in the region measured in characters.
Declaration
int Height { get; }Property Value
| Type | Description |
|---|---|
| int | Returns the number of rows |
Left
Gets the leftmost column in the region.
Declaration
int Left { get; }Property Value
| Type | Description |
|---|---|
| int | Returns the leftmost column |
Top
Gets the topmost row in the region.
Declaration
int Top { get; }Property Value
| Type | Description |
|---|---|
| int | Returns the topmost row |
Width
Gets the number of columns in the region measured in characters.
Declaration
int Width { get; }Property Value
| Type | Description |
|---|---|
| int | Returns the number of columns |
Methods
GetTerminalCell(int, int)
Provide additional information about a single character within this screen region as a separate immutable object.
Declaration
ITerminalCell GetTerminalCell(int row, int column)Parameters
| Type | Name | Description |
|---|---|---|
| int | row | one-based row number of the character within the region |
| int | column | one-based column number of character within the region |
Returns
| Type | Description |
|---|---|
| ITerminalCell | TerminalCell object defining terminal screen information for this character |
GetText(int)
Gets the screen text for the specified row in the region.
Declaration
string GetText(int row)Parameters
| Type | Name | Description |
|---|---|---|
| int | row | one-based row within the region (not the row number on the screen) |
Returns
| Type | Description |
|---|---|
| string | The text contents of the specified row |