Reflection Desktop VBA Guide
Attachmate.Reflection.Objects.Emulation.OpenSystems Library / Attachmate.Reflection.Objects.Emulation.OpenSystems Library / Screen Object
Properties Methods Events

In This Topic
    Screen Object Members
    In This Topic

    The following tables list the members exposed by Screen.

    Public Properties
     NameDescription
    Public PropertyGets or sets how Reflection calculates the cursor row position shown in the status bar display for VT emulations only.  
    Public PropertyGets or sets whether Reflection appends a line-feed character to each transmitted or received carriage return character.  
    Public PropertyGets or sets whether keys repeat when you hold them down. (The SHIFT, ENTER, and CTRL keys never auto repeat.)  
    Public PropertyGets or sets whether Auto Scroll is on for Wyse, DG, and ADDS terminal emulation only.  
    Public PropertyGets or sets whether a break can be transmitted to the host computer.  
    Public PropertyGets or sets the length (in milliseconds) of the break signal.  
    Public PropertyGets or sets whether the CapsLock keyboard function is in effect.  
    Public PropertyGets or sets whether the screen display is cleared when the number of screen columns changes.  
    Public PropertyGets or sets the number of columns (or character positions) to roll right or left during one horizontal scrolling operation with CTRL+Left or CTRL+Right.  
    Public PropertyGets or sets how Reflection handles spaces when aligning data on screen.  
    Public PropertyGets or sets how Reflection handles blank lines in display memory.  
    Public PropertyGets or sets the copy data format.  
    Public PropertyGets or sets whether bitmaps copied to the Clipboard are edited to set the background color to white and near-white colors to black.  
    Public PropertyGets or sets whether bitmaps copied to the Clipboard are dithered to standard VGA colors.  
    Public PropertyGets or sets the copy table method.  
    Public PropertyReturns the column that contains the cursor in the terminal window, relative to the left edge of the screen.  
    Public PropertyReturns the row that contains the cursor in the terminal window, relative to the top of the screen (in host-addressable coordinates).  
    Public PropertyGets or sets the number of columns displayed in the terminal window.  
    Public PropertyGets or sets whether Reflection displays characters received from the host during the execution of any of the following methods: WaitForString, WaitForStrings, ReadChars, ReadLine, or ReadUntil.  
    Public PropertyGets or sets the number of 8-kilobyte blocks allocated to display memory.  
    Public PropertyReturns the index of the top row of display memory (in host-addressable coordinates).  
    Public PropertyGets or sets the number of lines in each page of display memory.  
    Public PropertyGets or sets whether Reflection uses drawing optimization features to control the timing of changes to the screen display.  
    Public PropertyGets or sets whether Reflection supports dynamic update of the number of rows and columns in the display when the user resizes the terminal window.  
    Public PropertyThis property returns or specifies what happens when typing reaches the right margin (that is, the end of a line).  
    Public PropertyWhen this property is set to true, Reflection ignores the current value of the AutoRepeat property and always auto repeats (causing most keys to repeat when you hold the key down).  
    Public PropertyGets or sets how character insertion is handled during IBM 3151 terminal sessions (TerminalType = IBM3151).  
    Public PropertyGets or sets whether to clear the MDT (Modified Data Tag) after data is sent to the host during IBM 3151 terminal sessions (TerminalType = IBM3151).  
    Public PropertyGets or sets what the ENTER key does in a IBM 3151 terminal session (TerminalType = IBM3151).  
    Public PropertyGets or sets whether nulls received from the host are ignored during IBM 3151 terminal sessions (TerminalType = IBM3151).  
    Public PropertyGets or sets what the INSERT key does in a 3151 terminal session (TerminalType = IBM3151).  
    Public PropertyGets or sets the Block mode state for IBM 3151 terminal sessions (TerminalType = IBM3151).  
    Public PropertyGets or sets how line insertion is handled during IBM 3151 terminal sessions (TerminalType = IBM3151).  
    Public PropertyGets or sets how a received carriage return is interpreted in a IBM 3151 terminal session (TerminalType = IBM3151).  
    Public PropertyGets or sets how a received line feed is interpreted in a IBM 3151 terminal session (TerminalType = IBM3151).  
    Public PropertyGets or sets what the RETURN key does in a IBM 3151 terminal session (TerminalType = IBM3151).  
    Public PropertyGets or sets what the SEND key does in a IBM 3151 terminal session (TerminalType = IBM3151).  
    Public PropertyGets or sets whether trailing nulls are sent to the host during IBM 3151 terminal sessions (TerminalType = IBM3151).  
    Public PropertyGets or sets what the TAB key does in a IBM 3151 terminal session (TerminalType = IBM3151).  
    Public PropertyGets or sets the LineTurnAround (LTA) character for IBM 3151 terminal sessions (TerminalType = IBM3151).  
    Public PropertyGets or sets what happens when a 256-color image is pasted from the Clipboard to the Reflection terminal window.  
    Public PropertyGets or sets what happens when a 256-color image is pasted from the Clipboard to the Reflection terminal window.  
    Public PropertyGets or sets what happens when color bitmaps are pasted from the Clipboard.  
    Public PropertyGets or sets how Reflection handles keyboard and mouse actions with events that are scheduled to execute after a period of inactivity.  
    Public PropertyGets or sets whether characters can be added to text in the terminal window without typing over existing characters.  
    Public PropertyThis property returns or specifies how character 92 is displayed by default when HostCharacterSet is set to DECKanji1983 or DECKanji1978.  
    Public PropertyGets or sets whether or not the keyboard and the toolbar are locked (that is, they cannot be used).  
    Public PropertyGets or sets how Reflection manages data that enters display memory.  
    Public PropertyBy default, Reflection scales images down so that an entire image fits on the PC display.  
    Public PropertyGets or sets whether a bell sounds when the cursor reaches the column that is eight spaces left of the right margin.  
    Public PropertyGets or sets what occurs when the mouse is clicked in the left margin of the terminal window.  
    Public PropertyReturns the column location where the mouse was last clicked in the terminal screen.  
    Public PropertyReturns the row location (in host-addressable coordinates) where the mouse was last clicked within the terminal screen.  
    Public PropertyIf you run a host application that requires the terminal to have a single page of memory (24 lines), set this property to false.  
    Public PropertyGets or sets whether the NumLock keyboard function is on or off.  
    Public PropertyOn-demand font-loading (ODL) is a Digital Japan feature that was added to Reflection version 5.2 (along with related features such as VT382 font-preloading and Gyoukan-Keisen line drawing).  
    Public PropertyGets or sets whether the cursor is coupled to the current page in page memory, or if moving the cursor to another page causes that page to be displayed.  
    Public PropertyGets the parent object (Terminal).  
    Public PropertyGets or sets the size of a "paste block" (that is, the number of characters pasted from the Clipboard to the terminal window before a pause occurs).  
    Public PropertyGets or sets how long (in tenths of a second) Reflection waits between "paste blocks" when pasting data from the Clipboard into display memory.  
    Public PropertyGets or sets what happens to the ReGIS cursor when you move the Windows mouse to a location in the Reflection terminal window that is different from the position the host has established.  
    Public PropertyGets or sets whether Reflection restores text colors after ReGIS graphics have been drawn.  
    Public PropertyGets or sets a value indicating whether to retain formatting so that copied text is pasted in the same way as it is displayed in the terminal. When set to false, formatting is removed from copied text.  
    Public PropertyGets or sets whether the foreground and background colors for screen attributes are reversed.  
    Public PropertyGets or sets whether onscreen data is saved in display memory when the host clears the display.  
    Public PropertyPertains to hotspots behavior.  
    Public PropertyRetrieves a Printing object, which is used to obtain and specify information that pertains to printing behavior.  
    Public PropertyGets or sets the time duration during which there are no changes to host data.  
    Public PropertyGets the row number of the top row of the screen (in host-addressable coordinates).  
    Public PropertyGets or sets when Reflection uses an off-screen bitmap to speed up scrolling.  
    Public PropertyReturns information about current selection.  
    Public PropertyGets the type of region that is selected.  
    Public PropertyWhen this property is set to true, Reflection displays control characters but does not execute the functions these characters would otherwise perform.  
    Public Property  
    Public PropertyGets or sets the scroll speed setting.  
    Public PropertyGets or sets the default font size for Tektronix emulation.  
    Public PropertyWhen this property is set to false, CTRL+S executes the hold screen keyboard function, and CTRL+Q cancels the hold screen. (Neither keystroke transmits anything to the host.)  
    Public PropertyGets or sets how visual attributes are applied for TVI terminal emulations (TerminalType = TVI955).  
    Public PropertyGets or sets whether a visual attribute occupies a character space in display memory when Reflection emulates a TVI terminal (TerminalType = TVI955).  
    Public PropertyGets or sets usage and display of the bottom status line for TVI terminal emulations (TerminalType = TVI955).  
    Public PropertyGets or sets which TVI emulation type Reflection uses when TerminalType is set to TVI955.  
    Public PropertyGets or sets the action of the DOWN key in TVI terminal emulations (TerminalType = TVI955).  
    Public PropertyGets or sets which function key set is available to the keyboard for TVI terminal emulations (TerminalType = TVI955).  
    Public PropertyGets or sets how the top and bottom status line appear in the Reflection terminal window in a TVI terminal emulation (TerminalType = TVI955).  
    Public PropertyGets or sets usage and display of the top status line in TVI terminal emulations (TerminalType = TVI955).  
    Public PropertyGets or sets whether the host can transmit ANSI color sequences to Reflection, thereby changing the foreground and background colors for characters displayed in the terminal window.  
    Public PropertyGets or sets whether the Katakana or Kanji character set is used by default when HostCharacterSet is set to DECKanji1983 or DECKanji1978.  
    Public PropertyGets or sets whether the row in which the cursor is located remains in the terminal window regardless of how the terminal window is resized or which screen font size is used.  
    Public Property  
    Public Property  
    Public Property  
    Public PropertyGets or sets a string of characters that mark the beginning or end of a word when using a mouse to select words in the terminal window.  
    Public PropertyGets or sets a string of characters that mark the beginning or end of a word when using a mouse to select words in the terminal window.  
    Public PropertyGets or sets the Wyse terminal display attribute mode (for Wyse terminal emulations only).  
    Public PropertyGets or sets whether a Wyse terminal is in Block Mode.  
    Public PropertyGets or sets the end-of-transmission delimiter for block sends (for Wyse terminal emulations only).  
    Public PropertyGets or sets how a DEL character is handled for Wyse terminal emulation only.  
    Public PropertyGets or sets what is sent to the host when the ENTER key is pressed (for Wyse terminal emulations only).  
    Public PropertyGets or sets how many label lines are visible (for Wyse terminal emulation only).  
    Public PropertyGets or sets whether the terminal is in Protect Mode (for Wyse terminal emulation only).  
    Public PropertyGets or sets how a received carriage return (CR) is interpreted (in Wyse terminal emulations only).  
    Public PropertyGets or sets what is sent to the host when the RETURN key is pressed (for Wyse terminal emulations only).  
    Public PropertyGets or sets whether the Wyse status line at the top of the screen is set to Off, Standard, or Edit.  
    Top
    Public Methods
     NameDescription
    Public MethodClears all display memory including the currently displayed screen.  
    Public MethodRemoves all events defined via DefineEvent.  
    Public MethodClears the current screen in display memory.  
    Public MethodClears current selection. Does not apply to VT terminal emuations.  
    Public MethodCopies ASCII text data to the Clipboard.  
    Public MethodCopies data to the Clipboard.  
    Public MethodCopies data to the Clipboard given the CopyFormatOption.  
    Public MethodAppends selected text to the end of 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 MethodDefines a specific event. The event remains defined until it is removed with a RemoveEvent or ClearEvent call or the host session is closed.  
    Public MethodDisplays the specified local file on the terminal screen.  
    Public MethodDisplays a string in the terminal window as though it had been received from the host.  
    Public MethodDisplays a string in the terminal window as though it had been received from the host.  
    Public MethodSelects all text in the terminal window between the specified starting and ending coordinates.  
    Public MethodSelects all text in the terminal window in all rows between the specified starting and ending coordinates.  
    Public MethodGets the ScreenCharacter at the specified location.  
    Public MethodRetrieves character attributes for the specified position on the screen.  
    Public MethodGets ScreenCharacter objects from the specified location, each representing one character at a screen location.  
    Public MethodRetrieves text from the specified screen region. Text from the "wrapped" region is returned.  
    Public MethodRetrieves text from the specified screen region. Text from the "wrapped" region is returned.  
    Public MethodRetrieves text from the specified screen region.  
    Public MethodLocks the screen and prevents input from the keyboard.  
    Public MethodCopies data from the Clipboard to the current cursor location.  
    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 MethodReads a specified number of characters from the host.  
    Public MethodReads a specified number of characters from the host.  
    Public MethodReads a specified number of characters from the host.  
    Public MethodReads data from the host until a line-feed character is encountered.  
    Public MethodReads data from the host until a line-feed character is encountered.  
    Public MethodReads data from the host until a line-feed character is encountered.  
    Public MethodReads data from the host until one of the specified terminator characters is received. The terminator character is not included in the returned string.  
    Public MethodReads data from the host until one of the specified terminator characters is received. The terminator character is not included in the returned string.  
    Public MethodReads data from the host until one of the specified terminator characters is received. The terminator character is not included in the returned string.  
    Public MethodRemoves a specific event that was defined via DefineEvent.  
    Public MethodWrites the entire display memory contents to a file.  
    Public MethodWrites the specified portion of display memory to a file.  
    Public MethodSearches for the specified text, starting from the specified screen location.  
    Public MethodSearches for the specified text, starting from the specified screen location for "searchRange" byte positions.  
    Public MethodSearches for the specified text on the screen, from the specified starting location to the specified ending location.  
    Public MethodSearches for the specified text on the screen, from the specified starting location and to the specified ending location.  
    Public MethodSelects all of the text on the screen.  
    Public MethodSelects specified display memory text.  
    Public MethodSends a host control key to host.  
    Public MethodSends a host control key to host. The method does not return until the screen has settled for the time duration measured by the ScreenSettleTime property.  
    Public MethodSends the text string to the host.  
    Public MethodSends a text string to the host.  
    Public MethodSets the starting coordinates for selecting text.  
    Public MethodUnlocks the screen. See the LockInput() method for more information.  
    Public MethodWaits for the specified duration.  
    Public MethodWaits for the specified control key press.  
    Public MethodWaits for the host screen data to settle (that is, there is no incoming data for the specified settle time).  
    Public MethodWaits for host screen data to settle (that is, there is no incoming data for the specified settle time).  
    Public MethodWaits for host screen data to settle (that is, there is no incoming data for the specified settle time).  
    Public MethodWaits for host screen data to settle (that is, there is no incoming data for the specified settle time).  
    Public MethodWaits for any data to come from the host during which time the keyboard is disabled.  
    Public MethodWaits for any data to come from the host during which time the keyboard is disabled.  
    Public MethodWaits for any data to come from the host.  
    Public MethodWaits for the specified text to be received from the host.  
    Public MethodWaits for the specified text to be received from the host.  
    Public MethodWaits for the specified text to be received from the host.  
    Public MethodWaits for one of the specified text strings to be received from the host.  
    Public MethodWaits for one of the specified text strings to be received from the host.  
    Public MethodWaits for one of the specified text strings to be received from the host.  
    Public MethodWaits for one of the specified text strings to be received from the host.  
    Public MethodWaits until the specified time.  
    Public MethodWaits until the specified time.  
    Top
    Public Events
     NameDescription
    Public EventThis event is triggered when a key or control key is about to be sent to the host. ControlKeySending allows you to modify a control key value or to cancel a send control key action before it is sent.  
    Public EventThis event is triggered immediately after Reflection transmits a terminal keystroke to the host.  
    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 EventThis event is triggered when the keyboard becomes locked (either by the host or by Reflection).  
    Public EventThis event is triggered when the keyboard becomes unlocked or enabled (either by the host or by Reflection).  
    Public EventThis event is triggered when a key is about to be sent to the host. KeysSending allows you to modify a key value or to cancel a send key action before it is sent.  
    Public EventThis event is triggered immediately after Reflection transmits a character, or string of characters, to the host.  
    Public EventThis event occurs when a session window is clicked by the mouse.  
    Top
    See Also