InfoConnect for Airlines VBA Guide
IbmScreen Object Members
| Attachmate.Reflection.Objects.Emulation.IbmHosts Library : IbmScreen Object |
The following tables list the members exposed by IbmScreen.
Properties
| Name | Description | |
|---|---|---|
 | AutoCopyOnSelect | Gets or sets a value indicating whether the terminal automatically copies selected text to the clipboard. |
| BlanksBetweenFields | Gets or specifies the number of blank spaces in a row between columns of data in order for the data to be tab-delimited. |
| 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. |
| CopyDataSeparation | Gets or sets a value indicating whether the data copied from InfoConnect should be separated by delimiters at field boundaries or at word boundaries. This option controls formatting for spreadsheet or other cell-based information and affects only the text and BIFF formats. |
| CopyFormatBIFF | Gets or sets a value indicating whether to copy from InfoConnect to the BIFF (Binary Interchange File Format) Clipboard format |
| CopyFormatDIB | Gets or sets a value indicating whether to copy from InfoConnect to the DIB (Device Independent Bitmap) Clipboard format |
| CopyFormatRefMF | Gets or sets a value indicating whether to copy from InfoConnect to the InfoConnect proprietary Clipboard format |
| CopyFormatRTF | Gets or sets a value indicating whether to copy from InfoConnect to the RTF (Rich Text Format) Clipboard format |
| CopyFormatText | Gets or sets a value indicating whether to copy from InfoConnect to the text Clipboard format |
| CopyFormatUnicode | Gets or sets a value indicating whether to copy from InfoConnect to the Unicode text Clipboard format |
| CopyInputFieldsOnly | Gets or sets a value indicating whether a copy (cut or append) operation puts values in unprotected input fields on the Clipboard. |
| CopyTrailingSpaces | Gets or sets a value indicating whether the terminal copies the character spaces that trail a selection when text is copied to the Clipboard. |
| CursorColumn | Gets the current cursor column location relative to the left edge of the terminal window. |
| CursorRow | Gets the current cursor row location relative to the top edge of the terminal window. |
| CutFillCharacter | Gets or sets a value indicating whether Cut and Clear actions replace characters with nulls or spaces. |
| DefineEventList | Gets the event numbers of all of the events currently defined in the system. |
| EnableHotSpots | Gets or sets a value indicating whether hotspots can be used. |
| HotSpots | Gets the HotSpots object. |
| IsKeyboardLocked | Gets a value indicating whether the keyboard is locked. |
| KanaLockState | Returns or specifies Kana Mode from the JIS-layout, which produces half-width Katakana characters. |
| OIA | Gets the OIA object. OIA represents the status line on the screen. |
| Parent | Gets the parent object. The parent is the IIbmTerminal object. |
| PasteAlignText | Gets or sets a value indicating whether to align space separated data with fields on the screen. |
| PasteClearField | Gets or sets a value indicating whether to clear all of the previous data remaining in a field after pasting new data into it. |
| PasteLineBreak | Gets or specifies the character that is inserted in a field on the terminal screen when data containing line breaks is copied from the Clipboard. |
| PasteMaskProtectedFields | Gets or sets a value indicating whether pasted text should be interpreted as a host screen image and overlaid onto the current screen starting at the current cursor position. If true, where the current screen contains an unprotected field, the source image text is pasted; where the current screen contains a protected field, the source image text is skipped. If false, the text is interpreted as a linear stream that can contain new lines and delimiters, and is pasted accordingly. |
| PasteMoveCursor | Gets or sets a value indicating whether to move the cursor to the end of the pasted text. If False, the cursor is restored to the position it was in before text was pasted. |
| PasteReplaceTabs | Gets or sets a value indicating whether to replace tabs in the Clipboard's contents with a specified string before pasting the selection within a host application. The PasteTabReplacement property defines the string. |
| PasteTabReplacement | Gets or specifies the string that replaces tabs if the PasteReplaceTabs setting is set to true. Any random set of characters is acceptable, including character spaces. |
| PasteUsingFieldDelimiters | When a new line is reached during a paste operation, the terminal attempts to paste the next row at the same column location where the paste began. This property returns or specifies what happens if the new location is protected. |
| PasteWrapDown | Gets or sets a value indicating whether pasted text should be wrapped to the field below (instead of to the field to the right). |
| PasteWrapText | Gets or sets a value indicating whether text that exceeds the current line length is pasted in the next field or truncated. |
| PrintOptions | Gets the PrintOptions object. PrintOptions holds configuration options for print emulation and print screen. |
| Rows | Gets the number of rows of the 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 specifies the type of a selected region. |
| ShowBytesRemaining | Gets or sets a value indicating whether the Show Bytes Remaining indicator is displayed on the host status line. |
| ShowHotSpots | Gets or sets a value indicating whether hotspots are visible in the terminal window. |
| ShowOIA | Gets or sets a value indicating whether operation and status messages are displayed in the Operator Information Area (OIA) at the bottom of the terminal window. |
| ShowSosi | Gets or sets a value indicating whether to show shift-out and shift-in (SO/SI) control characters on the terminal screen. |
| UseTableFormat | Gets or sets a value that specifies how spaces are processed when text is copied to the Clipboard. |
Methods and Functions
| Name | Description | |
|---|---|---|
 | CancelSelection | Cancels the text selection in the terminal window. If no text is selected, this method has no effect. |
| ClearEvents | Removes all events defined via DefineEvent. |
| ConfigureHotSpots | Loads the hotspots file as the current hotspots definitions. |
| Copy | Copies selected text to the Clipboard. |
| CopyAppend | Appends selected text to the end of the Clipboard. |
| Cut | Cuts selected text and copies it to the Clipboard. |
| DefineEvent | Defines a specific event. |
| EnableDefineEvent | Enables a defined event. |
| ExtendSelection | Selects all text in the terminal window between the selection start position and the specified coordinates. |
| ExtendSelectionRect | Selects a block of text in the terminal window that includes all rows between the starting row and the specified row. |
| 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. |
| IsEnableDefineEvent | Inspects the current state of a defined event. |
| LightPen | Simulates a light pen selection at the specified location in the terminal window. |
| LockInput | Locks the screen so that users cannot input on keyboard. |
| MoveCursor | Moves the cursor forward or back. |
| 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. |
| PrintScreen | Prints the selected text or the entire terminal screen. |
| PutCharacter | Puts a ScreenCharacter at the specified screen location. |
| PutText1 | Puts the text at the specified screen location, taking up "length" number of byte positions. |
| PutText2 | Puts the text at the specified screen location. |
| RemoveEvent | Removes a specific event that was defined via DefineEvent. |
| 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. The default start position is the current cursor position. |
| Undo | Undoes the last edit operation. |
| 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. |
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. |
| DefinedEvent | This event is triggered when an event defined by the DefineEvent method occurs. Events defined in this way remain defined as long as your InfoConnect session lasts, or until they are removed using the RemoveEvent or ClearEvents methods. |
| 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. |
| MouseClickEx | 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