InfoConnect for Unisys
IIbmScreen Interface Members
Properties  Methods  Events

The following tables list the members exposed by IIbmScreen.

Public Properties
 NameDescription
 PropertyAutoCopyOnSelectGets or sets a value indicating whether the terminal automatically copies selected text to the Clipboard.  
 PropertyBlanksBetweenFieldsGets or sets the number of consecutive blank spaces between columns of data that are required for the data to be tab delimited.  
 PropertyClearSelectionOnCopyGets or sets a value indicating whether text remains selected after it is copied to the Clipboard.  
 PropertyColumnsGets the number of columns in the screen.  
 PropertyCopyDataSeparationGets or sets a value specifying 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.  
 PropertyCopyFormatBIFFGets or sets a value indicating whether to copy from InfoConnect to the BIFF (Binary Interchange File Format) Clipboard format  
 PropertyCopyFormatDIBGets or sets a value indicating whether to copy from InfoConnect to the DIB (Device Independent Bitmap) Clipboard format  
 PropertyCopyFormatRefMFGets or sets a value indicating whether to copy from InfoConnect to the InfoConnect proprietary Clipboard format  
 PropertyCopyFormatRetainColorGets or sets a value indicating whether to retain host colors when copying to the RTF (Rich Text Format) Clipboard format  
 PropertyCopyFormatRTFGets or sets a value indicating whether to copy from InfoConnect to the RTF (Rich Text Format) Clipboard format  
 PropertyCopyFormatTextGets or sets a value indicating whether to copy from InfoConnect to the text Clipboard format  
 PropertyCopyFormatUnicodeGets or sets a value indicating whether to copy from InfoConnect to the Unicode text Clipboard format  
 PropertyCopyInputFieldsOnlyGets or sets a value indicating whether a copy (cut or append) operation puts values in unprotected input fields on the Clipboard.  
 PropertyCopyTrailingSpacesGets or sets a value indicating whether the terminal copies the character spaces that trail a selection when text is copied to the Clipboard.  
 PropertyCursorColumnGets or sets the cursor's column location relative to the left edge of the terminal window.  
 PropertyCursorRowGets or sets the cursor's row location relative to the top edge of the terminal window.  
 PropertyCutFillCharacterGets or sets a value indicating whether Cut and Clear actions replace characters with nulls or spaces.  
 PropertyEnableHotSpotsGets or sets a value indicating whether hotspots can be used.  
 PropertyHotSpotsGets the HotSpots object which is used to obtain/specify information pertaining to HotSpots behavior.  
 PropertyIsKeyboardLockedGets a value indicating whether the keyboard is locked.  
 PropertyKanaLockStateGets or sets a value that specifies Kana Mode from the JIS-layout, which produces half-width Katakana characters.  
 PropertyOiaGets the OIA object. OIA represents the status line on the screen.  
 PropertyParentGets the parent object (IIbmTerminal).  
 PropertyPasteAlignTextGets or sets a value indicating whether to align space separated data with fields on the screen.  
 PropertyPasteClearFieldGets or sets a value indicating whether to clear all of the previous data remaining in a field after pasting new data into it.  
 PropertyPasteLineBreakGets or sets the character that is inserted in a field on the terminal screen when data containing line breaks is copied from the Clipboard.  
 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.  
 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.  
 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.  
 PropertyPasteTabReplacementGets or sets the string that replaces tabs if the PasteReplaceTabs setting is set to true.  
 PropertyPasteUsingFieldDelimitersGets 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.  
 PropertyPasteWrapDownGets or sets a value indicating whether pasted text should be wrapped to the field below (instead of to the field to the right).  
 PropertyPasteWrapTextGets or sets a value indicating whether text that exceeds the current line length is pasted in the next field or truncated.  
 PropertyPrintOptionsGets the PrintOptions object. PrintOptions holds configuration options for print emulation and print screen.  
 PropertyRowsGets the number of rows of the screen.  
 PropertyScreenSettleTimeGets or sets time duration during which there should be no host data changes.  
 PropertySelectionGets the area of the screen that's currently selected.  
 PropertySelectionModeGets or sets options (Block or Stream) that determine the shape of a selected region.  
 PropertyShowBytesRemainingGets or sets a value indicating whether the Show Bytes Remaining indicator is displayed on the host status line.  
 PropertyShowHotSpotsGets or sets a value indicating whether hotspots are visible in the terminal window.  
 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.  
 PropertyShowSosiGets or sets a value indicating whether to show shift-out and shift-in (SO/SI) control characters on the terminal screen.  
 PropertyUseTableFormatGets or sets a value that specifies how spaces are processed when text is copied to the Clipboard.  
Top
Public Methods
 NameDescription
 MethodCancelSelectionCancels the text selection in the terminal window. If no text is selected, this method has no effect.  
 MethodConfigureHotSpotsLoad the hotspots file as the current hotspots definitions.  
 MethodCopyCopies selected text to the Clipboard.  
 MethodCopyAppendAppends selected text to the end of the Clipboard.  
 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 Micro Focus products.

 
 MethodCutCuts selected text and copies it to the Clipboard.  
 MethodExtendSelectionSelects all text in the terminal window between the selection start position and the specified coordinates.  
 MethodExtendSelectionRectSelects a block of text in the terminal window that includes all rows between the starting row and the specified row.  
 MethodFindFieldOverloaded. Locates a field starting from the specified row and column.  
 MethodGetCharacterGets the ScreenCharacter at the specified location.  
 MethodGetCharacterForegroundColorGets the foreground color of the character at the specified location.  
 MethodGetCharactersGets ScreenCharacter objects from the specified screen location. Each object represents one character.  
 MethodGetFieldGets the host field that the specified row and column are part of.  
 MethodGetFieldColorGets the foreground color of the host field that the specified row and column are part of.  
 MethodGetFieldsGets a host field collection that matches specifed fieldAttributes.  
 MethodGetFieldTextGets the text of the field contained within the specified row and column.  
 MethodGetTextGets the text from the specified location.  
 MethodGetTextExGets the text from the specified screen area.  
 MethodIsAttributeTests whether the specified screen location is a field attribute position.  
 MethodLightPenSimulates a light pen selection at the specified location in the terminal window.  
 MethodLockInputLocks the screen so that users cannot use the keyboard to provide input.  
 MethodMoveCursorMoves the cursor forward or back.  
 MethodMoveCursorToOverloaded. Moves the cursor to the specified screen location.  
 MethodPasteCopies data from the Clipboard to the current cursor location.  
 MethodPasteContinuePastes remaining text from a previous Paste command.  
 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 Micro Focus products.

 
 MethodPutCharacterPuts a ScreenCharacter at the specified screen location.  
 MethodPutTextOverloaded. Puts text at the specified screen location.  
 MethodScreenCoordinateToIndexConverts screen position in row and column to linear screen buffer index.  
 MethodScreenIndexToColumnGets the column value of a screen location pointed to by screenIndex.  
 MethodScreenIndexToCoordinateGets the screen coordinate of a screen location pointed to by screenIndex.  
 MethodScreenIndexToRowGets the row value of a screen location pointed to by screenIndex.  
 MethodSearchTextOverloaded. Searches the specified text starting from the specified screen location.  
 MethodSelectAllSelects all of the text on the terminal window.  
 MethodSendControlKeySends a host control key to the host.  
 MethodSendControlKeySyncSends a host control key to the host.  
 MethodSendKeysSends the text string to the host.  
 MethodSetSelectionStartPosSets starting coordinates for selecting text. The default start position is the current cursor position.  
 MethodUndoUndoes the last edit operation.  
 MethodUnlockInputUnlocks the screen. See the LockInput() method for more information.  
 MethodWaitWaits for the specified duration.  
 MethodWaitForControlKeyWaits for the specified control key press.  
 MethodWaitForCursorOverloaded. Waits for the cursor to be at the specified screen location.  
 MethodWaitForHostSettleWaits for host screen data to settle.  
 MethodWaitForKeyboardEnabledWait for the keyboard to be unloacked enabled and ready for additional input.  
 MethodWaitForTextOverloaded. Waits for the specified text to appear at the specified screen location.  
Top
Public Events
 NameDescription
 EventAfterSendKeysOccurs after data keys are rendered on the terminal screen.  
 EventBeforeSendControlKeyOccurs before a control key is sent to the host.  
 EventBeforeSendKeysOccurs before a data key is sent to the host.  
 EventCursorInNewFieldOccurs when the cursor moves into a different field.  
 EventKeyboardLockedOccurs when the keyboard is locked.  
 EventKeyboardUnlockedOccurs when as the keyboard is unlocked.  
 EventMouseClickThis event occurs when a session window is clicked by the mouse.  
 EventNewScreenReadyOccurs when the screen has been quiet for the time duration specified by the ScreenSettleTime property.  
 EventScreenChangedOccurs when host data causes the data on the screen to change.  
Top
See Also