| Name | Description | |
|---|---|---|
 | AutoCopyOnSelect | Gets or sets a value indicating whether selected text is automatically copied to the clipboard. |
| ClearSelectionOnCopy | Gets or sets a value indicating whether text remains selected after it is copied to the Clipboard. |
| Columns | Gets the number of columns of the screen. |
| ControlPageActive | Gets a value indicating whether the current page type is a Control page |
| CursorColumn | Gets or sets the current cursor column location relative to the left edge of the terminal window. |
| CursorFollowsSelection | Gets or sets a value indicating whether the cursor should be placed after the last selected text. |
| CursorRow | Gets or sets the current cursor row location relative to the top edge of the terminal window. |
| EmphasisTransmitType | Gets a value indicating the current emphasis transmit type |
| HostChangedControlPage | Gets a value indicating whether the host has accessed/changed the control page. |
| HostChangedScreen | Gets a value indicating whether the host has changed a character on the screen |
| HotSpots | Gets the HotSpots object. |
| IsKeyboardLocked | Gets a value indicating whether the keyboard is locked. |
| KeyboardWaitStatus | Gets a value indicating whether the keyboard is locked because of a terminal wait status |
| MessageWaiting | Gets a value indicating whether a message is currently waiting |
| Parent | Gets the parent object. The parent is the IUtsTerminal object. |
| Rows | Gets the number of rows of the screen. |
| ScreenSettleState | Gets a value indicating the settle state (stability) of the current screen. |
| ScreenSettleTime | Gets or sets time duration during which there should be no host data changes. This value is used in triggering the NewScreenReady event. The value is not persisted. |
| Selection | Gets the area of the screen currently selected. |
| SelectionMode | Gets or sets the type of a selected region. |
| StripTrailingBlankLines | Gets or sets a value indicating whether trailing blank lines are removed from the cut or copied text. |
| TerminalModel | Gets a value indicating the current configured terminal model |
UtsScreen Object Members
In This Topic
The following tables list the members exposed by UtsScreen.
Public Properties
Public Methods
| Name | Description | |
|---|---|---|
 | CancelSelection | Cancels the text selection in the terminal window. If no text is selected, this method has no effect. |
| Copy | Copies selected text to the Clipboard. |
| CopyAppend | Appends selected text to the end of the Clipboard. |
| CopyToBuffer | Copies selected text to one of 4 clipboard buffers. If an invalid bufferNum value is specified, the request is ignored. |
| Cut | Cuts selected text and copies it to the Clipboard. |
| ExtendSelection | Selects a rectangular block of text in the terminal window between the selection start position (or row 1, column 1, if there is no selection start position) and the specified coordinates. |
| ExtendSelectionRect | Selects all text in the terminal window in all rows between the starting row and the specified row (or row 1, column 1, if there is no selection start position). |
| FindField1 | Locates a field starting from the specified row and column. |
| FindField2 | Locates a field that matches the specified field length, starting from the specified row and column. |
| FindField3 | Locates a field that matches the specified field attributes, starting from the specified row and column. |
| FindField4 | Locates a field that matches the specified field length and field attributes, starting from the specified row and column. |
| GetCharacter | Gets the ScreenCharacter at the specified location. |
| GetCharacterForegroundColor | Gets the foreground color of the character at the specified location. |
| GetCharacters | Gets ScreenCharacter objects from the specified location, each representing one character at a screen location. |
| GetField | Gets the host field that the specified row and column are part of. |
| GetFieldColor | Gets the foreground color of the host field that the specified row and column are part of. |
| GetFields | Gets a host field collection that matches specifed fieldAttributes. |
| GetFieldText | Gets the text of the field that the specified row and column are part of. Use Row and Column parameters to identify the field that you want to get text from. Coordinates are based on 1,1 for the upper-left corner of the terminal window (as they appear on the status line if you move the cursor to the field you want to retrieve). The coordinates can be located anywhere within the field. |
| GetText | Gets the text from the specified location. |
| GetTextEx | Gets the text from the specified screen area. |
| IsAttribute | Tests whether the specified screen location is a field attribute position. |
| LockInput | Locks the screen so that users cannot input on keyboard. |
| MoveCursorTo1 | Moves the cursor to the specified screen location. |
| MoveCursorTo2 | Moves the cursor to the specified screen location. |
| Paste | Copies data from the Clipboard to the cursor location in the terminal window. |
| PasteContinue | Pastes text leftover from a previous Paste command. |
| PasteFromBuffer | Pastes data from a specified clipboard buffer, if the specified buffer contains data. Ignored if an invalid bufferNum value is specified, or if the specified clipboard buffer does not contain data. |
| PutCharacter | Puts a ScreenCharacter at the specified screen location. |
| PutText1 | Puts text at the specified screen location. |
| PutText2 | Puts the text at the specified screen location. |
| ScreenCoordinateToIndex | Converts screen position in row and column to linear screen buffer index. |
| ScreenIndexToColumn | Gets the column value of a screen location pointed to by screenIndex. |
| ScreenIndexToCoordinate | Gets the screen coordinate of a screen location pointed to by screenIndex. |
| ScreenIndexToRow | Gets the row value of a screen location pointed to by screenIndex. |
| SearchText1 | Searches the specified text starting from the specified screen location. |
| SearchText2 | Searches the specified text starting from the specified screen location for "searchRange" byte positions. |
| SearchText3 | Searches the specified text, starting from the specified screen location and ending at the specified end screen location. |
| SearchText4 | Searches the specified text, starting from the specified screen location and ending at the specified end screen location. |
| SelectAll | Selects all of the text in the terminal window. |
| SendControlKey | Send host control key to host. |
| SendControlKeySync | Sends a host control key to the host. |
| SendKeys | Sends the text string to the host. |
| SetSelectionStartPos | Sets starting coordinates for selecting text. You can also set the selection start position by clicking in the terminal window with the mouse. If no selection start position has been set, the default is row 1, column 1. |
| UnlockInput | Unlocks the screen. See the LockInput() method for more information. |
| Wait | Waits for the specified duration before executing the next command in the procedure. The procedure containing the command is paused until the wait expires. |
| WaitForControlKey | Waits for the specified control key press. |
| WaitForCursor1 | Waits for the cursor to be at the specified screen location. |
| WaitForCursor2 | Waits for the cursor to be in the rectangle area specified by startRow, startColumn, endRow and endColumn. |
| WaitForHostSettle | Waits for host screen data to settle. |
| WaitForKeyboardEnabled | Wait for the keyboard to be unloacked enabled and ready for additional input. |
| WaitForText1 | Waits for the specified text to appear at the specified screen location. TextComparisonOption indicates desired text string comparison. |
| WaitForText2 | Waits for the specified text to appear at the specified rectangle area specified. TextComparisonOption indicates desired text string comparison. |
Public Events
| Name | Description | |
|---|---|---|
 | AfterSendKeys | Occurs after a data key or string is sent to the host. |
| BeforeSendControlKey | Occurs before a control key is sent to the host. |
| BeforeSendKeys | Occurs before a data key is sent to the host. |
| CursorInNewField | Occurs as soon as the cursor moves into a different field. |
| KeyboardLocked | Occurs as soon as the keyboard is locked. |
| KeyboardUnlocked | Occurs as soon as the keyboard is unlocked. |
| MouseClick | This event occurs when a session window is clicked by the mouse. |
| NewScreenReady | Occurs as soon as the screen has been quiet for the time duration specified by the ScreenSettleTime property. |
| ScreenChanged | Occurs as soon as the host data causes the data on the screen to change. |
See Also