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 PropertyAutoCopyOnSelectGets or sets a value indicating whether the terminal automatically copies selected text to the clipboard.  
    Public PropertyBlanksBetweenFieldsGets or specifies the number of blank spaces in a row between columns of data in order for the data to be tab-delimited.  
    Public PropertyClearSelectionOnCopyGets or sets a value indicating whether text remains selected after it is copied to the Clipboard.  
    Public PropertyColumnsGets the number of columns of the screen.  
    Public PropertyCopyDataSeparationGets 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 PropertyCopyFormatBIFFGets or sets a value indicating whether to copy from Reflection to the BIFF (Binary Interchange File Format) Clipboard format  
    Public PropertyCopyFormatDIBGets or sets a value indicating whether to copy from Reflection to the DIB (Device Independent Bitmap) Clipboard format  
    Public PropertyCopyFormatRefMFGets or sets a value indicating whether to copy from Reflection to the Reflection proprietary Clipboard format  
    Public PropertyCopyFormatRetainColorGets or sets a value indicating whether to retain host colors when copying to the RTF (Rich Text Format) Clipboard format  
    Public PropertyCopyFormatRTFGets or sets a value indicating whether to copy from Reflection to the RTF (Rich Text Format) Clipboard format  
    Public PropertyCopyFormatTextGets or sets a value indicating whether to copy from Reflection to the text Clipboard format  
    Public PropertyCopyFormatUnicodeGets or sets a value indicating whether to copy from Reflection to the Unicode text Clipboard format  
    Public PropertyCopyInputFieldsOnlyGets or sets a value indicating whether a copy (cut or append) operation puts values in unprotected input fields on the Clipboard.  
    Public PropertyCopyNumberAsTextGets or sets a value indicating whether to copy numbers from Reflection as text. Only affects BIFF (Binary Interchange File Format) Clipboard format.  
    Public PropertyCopyTrailingSpacesGets or sets a value indicating whether the terminal copies the character spaces that trail a selection when text is copied to the Clipboard.  
    Public PropertyCursorColumnGets the current cursor column location relative to the left edge of the terminal window.  
    Public PropertyCursorRowGets the current cursor row location relative to the top edge of the terminal window.  
    Public PropertyCutFillCharacterGets or sets a value indicating whether Cut and Clear actions replace characters with nulls or spaces.  
    Public PropertyDefineEventList

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

     
    Public PropertyEnableHotSpotsGets or sets a value indicating whether hotspots can be used.  
    Public PropertyHotSpotsGets the HotSpots object.  
    Public PropertyIsKeyboardLockedGets a value indicating whether the keyboard is locked.  
    Public PropertyKanaLockStateReturns or specifies Kana Mode from the JIS-layout, which produces half-width Katakana characters.  
    Public PropertyOIAGets the OIA object. OIA represents the status line on the screen.  
    Public PropertyParentGets the parent object. The parent is the IIbmTerminal object.  
    Public PropertyPasteAlignTextGets or sets a value indicating whether to align space separated data with fields on the screen.  
    Public PropertyPasteClearFieldGets or sets a value indicating whether to clear all of the previous data remaining in a field after pasting new data into it.  
    Public PropertyPasteIgnoreFieldTypeGets 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 PropertyPasteLineBreakGets 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 PropertyPasteMaskProtectedFieldsGets 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 PropertyPasteMoveCursorGets 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 PropertyPasteReplaceTabsGets 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 PropertyPasteTabReplacementGets 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 PropertyPasteUsingFieldDelimitersWhen 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 PropertyPasteWrapDownGets or sets a value indicating whether pasted text should be wrapped to the field below (instead of to the field to the right).  
    Public PropertyPasteWrapTextGets or sets a value indicating whether text that exceeds the current line length is pasted in the next field or truncated.  
    Public PropertyPrintOptionsGets the PrintOptions object. PrintOptions holds configuration options for print emulation and print screen.  
    Public PropertyPutTextMaskProtectedField

    Gets or sets the mode that controls how the PutText methods place a string of characters onto the host screen. PutText methods have two modes: Mask and LinearStream.

    In Mask mode (the default), the PutText methods interpret the text as a host screen image and overlay 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 and is not placed on the screen.

    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 is placed on the screen.

     
    Public PropertyRowsGets the number of rows of the screen.  
    Public PropertyScreenSettleTimeGets 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 PropertySelectionGets the area of the screen currently selected.  
    Public PropertySelectionModeGets or specifies the type of a selected region.  
    Public PropertyShowBytesRemainingGets or sets a value indicating whether the Show Bytes Remaining indicator is displayed on the host status line.  
    Public PropertyShowHotSpotsGets or sets a value indicating whether hotspots are visible in the terminal window.  
    Public PropertyShowOIAGets 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 PropertyShowSosiGets or sets a value indicating whether to show shift-out and shift-in (SO/SI) control characters on the terminal screen.  
    Public PropertyUseTableFormatGets or sets a value that specifies how spaces are processed when text is copied to the Clipboard.  
    Top
    Public Methods
     NameDescription
    Public MethodCancelSelectionCancels the text selection in the terminal window. If no text is selected, this method has no effect.  
    Public MethodClearEventsRemoves all events defined via DefineEvent.  
    Public MethodConfigureHotSpotsLoads the hotspots file as the current hotspots definitions.  
    Public MethodCopyCopies selected text to the Clipboard.  
    Public MethodCopyAppendAppends selected text to the end of the Clipboard.  
    Public MethodCopyToBuffer

    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.

     
    Public MethodCutCuts selected text and copies it to the Clipboard.  
    Public MethodDefineEventDefines a specific event.  
    Public MethodEnableDefineEvent

    Enables a defined event.

     
    Public MethodExtendSelectionSelects all text in the terminal window between the selection start position and the specified coordinates.  
    Public MethodExtendSelectionRectSelects a block of text in the terminal window that includes all rows between the starting row and the specified row.  
    Public MethodFindField1Locates a field starting from the specified row and column.  
    Public MethodFindField2Locates a field that matches the specified field length, starting from the specified row and column.  
    Public MethodFindField3Locates a field that matches the specified field attributes, starting from the specified row and column.  
    Public MethodFindField4Locates a field that matches the specified field length and field attributes, starting from the specified row and column.  
    Public MethodGetCharacterGets the ScreenCharacter at the specified location.  
    Public MethodGetCharacterForegroundColorGets the foreground color of the character at the specified location.  
    Public MethodGetCharactersGets ScreenCharacter objects from the specified location, each representing one character at a screen location.  
    Public MethodGetFieldGets the host field that the specified row and column are part of.  
    Public MethodGetFieldColorGets the foreground color of the host field that the specified row and column are part of.  
    Public MethodGetFieldsGets a host field collection that matches specifed field attributes.  
    Public MethodGetFieldTextGets 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 MethodGetTextGets the text from the specified location.  
    Public MethodGetTextExGets the text from the specified screen area.  
    Public MethodIsAttributeTests whether the specified screen location is a field attribute position.  
    Public MethodIsEnableDefineEventInspects the current state of a defined event.  
    Public MethodLightPenSimulates a light pen selection at the specified location in the terminal window.  
    Public MethodLockInputLocks the screen so that users cannot input on keyboard.  
    Public MethodMoveCursorMoves the cursor forward or back.  
    Public MethodMoveCursorTo1Moves the cursor to the specified screen location.  
    Public MethodMoveCursorTo2Moves the cursor to the specified screen location.  
    Public MethodPaste

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

     
    Public MethodPasteContinuePastes text leftover from a previous Paste command.  
    Public MethodPasteFromBuffer

    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.

     
    Public MethodPasteRange

    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 MethodPrintScreenPrints the selected text or the entire terminal screen.  
    Public MethodPutCharacterPuts a ScreenCharacter at the specified screen location.  
    Public MethodPutText1

    Puts text at a specified screen location, taking up the number of characters specified by the length parameter. PutText1 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.

     
    Public MethodPutText2

    Puts text at a specified screen location. PutText2 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.

     
    Public MethodRemoveEventRemoves a specific event that was defined via DefineEvent.  
    Public MethodScreenCoordinateToIndexConverts screen position in row and column to linear screen buffer index.  
    Public MethodScreenIndexToColumnGets the column value of a screen location pointed to by screenIndex.  
    Public MethodScreenIndexToCoordinateGets the screen coordinate of a screen location pointed to by screenIndex.  
    Public MethodScreenIndexToRowGets the row value of a screen location pointed to by screenIndex.  
    Public MethodSearchText1Searches the specified text, starting from the specified screen location.  
    Public MethodSearchText2Searches the specified text, starting from the specified screen location for "searchRange" byte positions.  
    Public MethodSearchText3Searches the specified text, starting from the specified screen location and ending at the specified end screen location.  
    Public MethodSearchText4Searches the specified text, starting from the specified screen location and ending at the specified end screen location.  
    Public MethodSelectAllSelects all of the text in the terminal window.  
    Public MethodSendControlKeySend host control key to host.  
    Public MethodSendControlKeySyncSends a host control key to the host.  
    Public MethodSendKeysSends the text string to the host.  
    Public MethodSetSelectionStartPosSets starting coordinates for selecting text. The default start position is the current cursor position.  
    Public MethodUndoUndoes the last edit operation.  
    Public MethodUnlockInputUnlocks the screen. See the LockInput() method for more information.  
    Public MethodWaitWaits for the specified duration before executing the next command in the procedure. The procedure containing the command is paused until the wait expires.  
    Public MethodWaitForControlKeyWaits for the specified control key press.  
    Public MethodWaitForCursor1Waits for the cursor to be at the specified screen location.  
    Public MethodWaitForCursor2Waits for the cursor to be in the rectangle area specified by startRow, startColumn, endRow and endColumn.  
    Public MethodWaitForHostSettleWaits for host screen data to settle.  
    Public MethodWaitForKeyboardEnabledWait for the keyboard to be enabled (unlocked and ready for additional input).  
    Public MethodWaitForText1Waits for the specified text to appear at the specified screen location. TextComparisonOption indicates desired text string comparison.  
    Public MethodWaitForText2Waits for the specified text to appear at the specified rectangle area specified. TextComparisonOption indicates desired text string comparison.  
    Top
    Public Events
     NameDescription
    Public EventAfterSendKeysOccurs after a data key or string is sent to the host.  
    Public EventBeforeSendControlKeyOccurs before a control key is sent to the host.  
    Public EventBeforeSendKeysOccurs before a data key is sent to the host.  
    Public EventCursorInNewFieldOccurs as soon as the cursor moves into a different field.  
    Public EventDefinedEventThis 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 EventKeyboardLockedOccurs as soon as the keyboard is locked.  
    Public EventKeyboardUnlockedOccurs as soon as the keyboard is unlocked.  
    Public EventMouseClickThis event occurs when a session window is clicked by the mouse.  
    Public EventMouseClickExThis event occurs when a session window is clicked by the mouse.  
    Public EventNewScreenReadyOccurs as soon as the screen has been quiet for the time duration specified by the ScreenSettleTime property.  
    Public EventScreenChangedOccurs as soon as the host data causes the data on the screen to change.  
    Top
    See Also

    Reference

    IbmScreen Object
    Attachmate.Reflection.Objects.Emulation.IbmHosts Library

    Send Feedback