Reflection Desktop VBA Guide
Attachmate.Reflection.Objects.Emulation.IbmHosts Library / Attachmate.Reflection.Objects.Emulation.IbmHosts Library / IbmScreen Object
Properties Methods Events

In This Topic
    IbmScreen Object Members
    In This Topic

    The following tables list the members exposed by IbmScreen.

    Public Properties
     NameDescription
    Public PropertyGets or sets a value indicating whether the terminal automatically copies selected text to the clipboard.  
    Public PropertyGets or specifies the number of blank spaces in a row between columns of data in order for the data to be tab-delimited.  
    Public PropertyGets or sets a value indicating whether text remains selected after it is copied to the Clipboard.  
    Public PropertyGets the number of columns of the screen.  
    Public PropertyGets or sets a value indicating 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.  
    Public PropertyGets or sets a value indicating whether to copy from Reflection to the BIFF (Binary Interchange File Format) Clipboard format  
    Public PropertyGets or sets a value indicating whether to copy from Reflection to the DIB (Device Independent Bitmap) Clipboard format  
    Public PropertyGets or sets a value indicating whether to copy from Reflection to the Reflection proprietary Clipboard format  
    Public PropertyGets or sets a value indicating whether to retain host colors when copying to the RTF (Rich Text Format) Clipboard format  
    Public PropertyGets or sets a value indicating whether to copy from Reflection to the RTF (Rich Text Format) Clipboard format  
    Public PropertyGets or sets a value indicating whether to copy from Reflection to the text Clipboard format  
    Public PropertyGets or sets a value indicating whether to copy from Reflection to the Unicode text Clipboard format  
    Public PropertyGets or sets a value indicating whether a copy (cut or append) operation puts values in unprotected input fields on the Clipboard.  
    Public PropertyGets or sets a value indicating whether the terminal copies the character spaces that trail a selection when text is copied to the Clipboard.  
    Public PropertyGets the current cursor column location relative to the left edge of the terminal window.  
    Public PropertyGets the current cursor row location relative to the top edge of the terminal window.  
    Public PropertyGets or sets a value indicating whether Cut and Clear actions replace characters with nulls or spaces.  
    Public Property

    Gets the event numbers of all of the events currently defined in the system.

     
    Public PropertyGets or sets a value indicating whether hotspots can be used.  
    Public PropertyGets the HotSpots object.  
    Public PropertyGets a value indicating whether the keyboard is locked.  
    Public PropertyReturns or specifies Kana Mode from the JIS-layout, which produces half-width Katakana characters.  
    Public PropertyGets the OIA object. OIA represents the status line on the screen.  
    Public PropertyGets the parent object. The parent is the IIbmTerminal object.  
    Public PropertyGets or sets a value indicating whether to align space separated data with fields on the screen.  
    Public PropertyGets or sets a value indicating whether to clear all of the previous data remaining in a field after pasting new data into it.  
    Public PropertyGets 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.
     
    Public PropertyGets or specifies the character that is inserted in a field on the terminal screen when data containing line breaks is copied from the Clipboard.  
    Public PropertyGets 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.  
    Public PropertyGets 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.  
    Public PropertyGets 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.  
    Public PropertyGets 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.  
    Public PropertyWhen 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.  
    Public PropertyGets or sets a value indicating whether pasted text should be wrapped to the field below (instead of to the field to the right).  
    Public PropertyGets or sets a value indicating whether text that exceeds the current line length is pasted in the next field or truncated.  
    Public PropertyGets the PrintOptions object. PrintOptions holds configuration options for print emulation and print screen.  
    Public PropertyGets the number of rows of the screen.  
    Public PropertyGets 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.  
    Public PropertyGets the area of the screen currently selected.  
    Public PropertyGets or specifies the type of a selected region.  
    Public PropertyGets or sets a value indicating whether the Show Bytes Remaining indicator is displayed on the host status line.  
    Public PropertyGets or sets a value indicating whether hotspots are visible in the terminal window.  
    Public PropertyGets 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.  
    Public PropertyGets or sets a value indicating whether to show shift-out and shift-in (SO/SI) control characters on the terminal screen.  
    Public PropertyGets or sets a value that specifies how spaces are processed when text is copied to the Clipboard.  
    Top
    Public Methods
     NameDescription
    Public MethodCancels the text selection in the terminal window. If no text is selected, this method has no effect.  
    Public MethodRemoves all events defined via DefineEvent.  
    Public MethodLoads the hotspots file as the current hotspots definitions.  
    Public MethodCopies selected text to the Clipboard.  
    Public MethodAppends selected text to the end of the Clipboard.  
    Public Method

    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 Micro Focus products.

     
    Public MethodCuts selected text and copies it to the Clipboard.  
    Public MethodDefines a specific event.  
    Public Method

    Enables a defined event.

     
    Public MethodSelects all text in the terminal window between the selection start position and the specified coordinates.  
    Public MethodSelects a block of text in the terminal window that includes all rows between the starting row and the specified row.  
    Public MethodLocates a field starting from the specified row and column.  
    Public MethodLocates a field that matches the specified field length, starting from the specified row and column.  
    Public MethodLocates a field that matches the specified field attributes, starting from the specified row and column.  
    Public MethodLocates a field that matches the specified field length and field attributes, starting from the specified row and column.  
    Public MethodGets the ScreenCharacter at the specified location.  
    Public MethodGets the foreground color of the character at the specified location.  
    Public MethodGets ScreenCharacter objects from the specified location, each representing one character at a screen location.  
    Public MethodGets the host field that the specified row and column are part of.  
    Public MethodGets the foreground color of the host field that the specified row and column are part of.  
    Public MethodGets a host field collection that matches specifed fieldAttributes.  
    Public MethodGets 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.  
    Public MethodGets the text from the specified location.  
    Public MethodGets the text from the specified screen area.  
    Public MethodTests whether the specified screen location is a field attribute position.  
    Public MethodInspects the current state of a defined event.  
    Public MethodSimulates a light pen selection at the specified location in the terminal window.  
    Public MethodLocks the screen so that users cannot input on keyboard.  
    Public MethodMoves the cursor forward or back.  
    Public MethodMoves the cursor to the specified screen location.  
    Public MethodMoves the cursor to the specified screen location.  
    Public Method

    Copies data from the Clipboard to the cursor location in the terminal window.

     
    Public MethodPastes text leftover from a previous Paste command.  
    Public Method

    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 Micro Focus products.

     
    Public Method

    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.

     
    Public MethodPrints the selected text or the entire terminal screen.  
    Public MethodPuts a ScreenCharacter at the specified screen location.  
    Public MethodPuts the text at the specified screen location, taking up "length" number of byte positions.  
    Public MethodPuts the text at the specified screen location.  
    Public MethodRemoves a specific event that was defined via DefineEvent.  
    Public MethodConverts screen position in row and column to linear screen buffer index.  
    Public MethodGets the column value of a screen location pointed to by screenIndex.  
    Public MethodGets the screen coordinate of a screen location pointed to by screenIndex.  
    Public MethodGets the row value of a screen location pointed to by screenIndex.  
    Public MethodSearches the specified text, starting from the specified screen location.  
    Public MethodSearches the specified text, starting from the specified screen location for "searchRange" byte positions.  
    Public MethodSearches the specified text, starting from the specified screen location and ending at the specified end screen location.  
    Public MethodSearches the specified text, starting from the specified screen location and ending at the specified end screen location.  
    Public MethodSelects all of the text in the terminal window.  
    Public MethodSend host control key to host.  
    Public MethodSends a host control key to the host.  
    Public MethodSends the text string to the host.  
    Public MethodSets starting coordinates for selecting text. The default start position is the current cursor position.  
    Public MethodUndoes the last edit operation.  
    Public MethodUnlocks the screen. See the LockInput() method for more information.  
    Public MethodWaits for the specified duration before executing the next command in the procedure. The procedure containing the command is paused until the wait expires.  
    Public MethodWaits for the specified control key press.  
    Public MethodWaits for the cursor to be at the specified screen location.  
    Public MethodWaits for the cursor to be in the rectangle area specified by startRow, startColumn, endRow and endColumn.  
    Public MethodWaits for host screen data to settle.  
    Public MethodWait for the keyboard to be enabled (unlocked and ready for additional input).  
    Public MethodWaits for the specified text to appear at the specified screen location. TextComparisonOption indicates desired text string comparison.  
    Public MethodWaits for the specified text to appear at the specified rectangle area specified. TextComparisonOption indicates desired text string comparison.  
    Top
    Public Events
     NameDescription
    Public EventOccurs after a data key or string is sent to the host.  
    Public EventOccurs before a control key is sent to the host.  
    Public EventOccurs before a data key is sent to the host.  
    Public EventOccurs as soon as the cursor moves into a different field.  
    Public EventThis 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 or ClearEvents methods.  
    Public EventOccurs as soon as the keyboard is locked.  
    Public EventOccurs as soon as the keyboard is unlocked.  
    Public EventThis event occurs when a session window is clicked by the mouse.  
    Public EventThis event occurs when a session window is clicked by the mouse.  
    Public EventOccurs as soon as the screen has been quiet for the time duration specified by the ScreenSettleTime property.  
    Public EventOccurs as soon as the host data causes the data on the screen to change.  
    Top
    See Also