| Name | Description | |
|---|---|---|
 | AutoCopyOnSelect | Gets or sets a value indicating whether the terminal automatically copies selected text to the Clipboard. |
| BlanksBetweenFields | Gets or sets the number of consecutive blank spaces between columns of data that are required 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 in the screen. |
| CopyDataSeparation | Gets or sets a value specifying whether the data copied from Reflection 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 Reflection to the BIFF (Binary Interchange File Format) Clipboard format |
| CopyFormatDIB | Gets or sets a value indicating whether to copy from Reflection to the DIB (Device Independent Bitmap) Clipboard format |
| CopyFormatRefMF | Gets or sets a value indicating whether to copy from Reflection to the Reflection proprietary Clipboard format |
| CopyFormatRetainColor | Gets or sets a value indicating whether to retain host colors when copying to the RTF (Rich Text Format) Clipboard format |
| CopyFormatRTF | Gets or sets a value indicating whether to copy from Reflection to the RTF (Rich Text Format) Clipboard format |
| CopyFormatText | Gets or sets a value indicating whether to copy from Reflection to the text Clipboard format |
| CopyFormatUnicode | Gets or sets a value indicating whether to copy from Reflection 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. |
| CopyNumberAsText | Gets or sets a value indicating whether to copy numbers from Reflection as text. Only affects BIFF (Binary Interchange File Format) Clipboard format. |
| 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 or sets the cursor's column location relative to the left edge of the terminal window. |
| CursorRow | Gets or sets the cursor's 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. |
| EventDefined | Returns the event ID number of the last event defined using DefineEvent or the event index number of the last event defined using OnEvent. |
| HotSpots | Gets the HotSpots object which is used to obtain/specify information pertaining to HotSpots behavior. |
| IsKeyboardLocked | Gets a value indicating whether the keyboard is locked. |
| KanaLockState | Gets or sets a value that 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 (IIbmTerminal). |
| 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. |
| PasteIgnoreFieldType | Gets or sets a value that controls how text is pasted on a screen that has restricted locations. When true, pasting into a restricted field is skipped if the text contains an invalid entry for that field and the remaining text is pasted into subsequent fields. When false, pasting stops and the screen is locked when an attempt is made to paste an invalid entry into a restricted field. This property applies only to IBM 5250 terminal sessions. |
| PasteLineBreak | Gets or sets 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. |
| PasteTabReplacement | Gets or sets the string that replaces tabs if the PasteReplaceTabs setting is set to true. |
| PasteUsingFieldDelimiters | Gets or sets a value indicating what happens if the terminal reaches a protected field while pasting text in the following row at the same column location where the paste began. |
| 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. |
| PutTextMaskProtectedField | Gets or sets a value that controls how the PutText method places a string of characters onto the host screen. The PutText method has two modes: Mask and LinearStream. In Mask mode (the default), the PutText method interprets the text as a host screen image and overlays the text onto the current screen starting at the specified screen position. Where the current screen contains an unprotected field, the source string is placed in the field; where the current screen contains a protected field, that portion of the string is skipped. In LinearStream mode, the text is placed sequentially in unprotected fields, and remaining text that exceeds the current unprotected field's length extends into the next unprotected field(s), until all the text has been placed on the 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. |
| Selection | Gets the area of the screen that's currently selected. |
| SelectionMode | Gets or sets options (Block or Stream) that determine the shape 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. |
IIbmScreen Interface Members
In This Topic
The following tables list the members exposed by IIbmScreen.
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. |
| ConfigureHotSpots | Load 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. |
| CopyToBuffer | Copies selected text to one of four clipboard buffers. If an invalid bufferNum value is specified, the request is ignored. Note: This property is supported only by the InfoConnect Desktop product. It is not supported by other Rocket Software products. |
| Cut | Cuts selected text and copies it to the Clipboard. |
| DefineEvent | Defines a specific event. The event remains defined until it is removed with a RemoveEvent() or ClearEvent() call or the host session is closed. |
| 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. |
| FindField | Overloaded. Locates a field 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 screen location. Each object represents one character. |
| 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 contained within the specified row and column. |
| 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. |
| LightPen | Simulates a light pen selection at the specified location in the terminal window. |
| LockInput | Locks the screen so that users cannot use the keyboard to provide input. |
| MoveCursor | Moves the cursor forward or back. |
| MoveCursorTo | Overloaded. Moves the cursor to the specified screen location. |
| OnEvent | Defines commands to be executed when a specified event occurs during a Reflection session. Events defined with this method are equivalent to those defined using the Event Setup dialog box. When you save your settings file, this event becomes part of that settings file and will appear in the list of events shown in the Event Setup dialog box. Events defined by OnEvent will execute after your macro completes.You cannot use this method to accomplish actions during macro execution. |
| Paste | Copies data from the Clipboard to the current cursor location. |
| PasteContinue | Pastes remaining text from a previous Paste command. |
| PasteFromBuffer | Pastes data from one of four clipboard buffers. If an invalid bufferNum value is specified, or if the specified clipboard buffer does not contain data, the request is ignored. Note: This property is supported only by the InfoConnect Desktop product. It is not supported by other Rocket Software products. |
| PasteRange | Pastes the contents of the Clipboard to a defined region of the current screen and, if needed, regions of subsequent screens in the host application. |
| PutCharacter | Puts a ScreenCharacter at the specified screen location. |
| PutText | Overloaded. Puts text at a specified screen location, taking up the number of characters specified by the length parameter. PutText has two modes: Mask and LinearStream. These modes are set with the PutTextMaskProtectedField Property. In Mask mode (the default), text that coincides with protected fields is skipped and is not placed on the screen. In LinearStream mode, protected fields are ignored and the text is placed sequentially in unprotected fields until all of the text is placed on the screen or the specified length is exceeded. |
| RemoveOnEvent | 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. |
| SearchText | Overloaded. Searches the specified text starting from the specified screen location. |
| SelectAll | Selects all of the text on the terminal window. |
| SendControlKey | Sends a host control key to the 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. |
| WaitForControlKey | Waits for the specified control key press. |
| WaitForCursor | Overloaded. Waits for the cursor to be at the specified screen location. |
| WaitForHostSettle | Waits for host screen data to settle. |
| WaitForKeyboardEnabled | Wait for the keyboard to be enabled (unlocked and ready for additional input). |
| WaitForText | Overloaded. Waits for the specified text to appear at the specified screen location. |
Public Events
| Name | Description | |
|---|---|---|
 | AfterSendKeys | Occurs after data keys are rendered on the terminal screen. |
| BeforeSendControlKey | Occurs before a control key is sent to the host. |
| BeforeSendKeys | Occurs before a data key is sent to the host. |
| CursorInNewField | Occurs when the cursor moves into a different field. |
| KeyboardLocked | Occurs when the keyboard is locked. |
| KeyboardUnlocked | Occurs when as the keyboard is unlocked. |
| MouseClick | This event occurs when a session window is clicked by the mouse. |
| NewScreenReady | Occurs when the screen has been quiet for the time duration specified by the ScreenSettleTime property. |
| RwinDefinedEvent | This event is triggered when an event defined by the DefineEvent method occurs. Events defined in this way remain defined as long as your Reflection session lasts, or until they are removed using the RemoveEvent. |
| ScreenChanged | Occurs when host data causes the data on the screen to change. |
See Also