InfoConnect for Airlines VBA Guide
AlcScreen Object Members

The following tables list the members exposed by AlcScreen.

Properties
 NameDescription
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 PropertyCursorColumnGets or sets the current cursor column location relative to the left edge of the terminal window.  
Public PropertyCursorRowGets or sets the current cursor row location relative to the top edge of the terminal window.  
Public PropertyIsKeyboardLockedGets a value indicating whether the keyboard is locked.  
Public PropertyParentGets the parent object. The parent is the IAlcTerminal object.  
Public PropertyRowsGets the number of rows of the screen.  
Public PropertyScreenSettleStateGets a value indicating whether the screen is in the settled state (stability).  
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 sets the type of a selected region.  
Top
Methods and Functions
 NameDescription
Public MethodCancelSelectionCancels the text selection in the terminal window. If no text is selected, this method has no effect.  
Public MethodCopyCopies selected text to the Clipboard.  
Public MethodCopyAppendAppends selected text to the end of the Clipboard.  
Public MethodCutCuts selected text and copies it to the Clipboard.  
Public MethodExtendSelectionSelects a rectangular block of text in the terminal window between the selection start position (or row 1, column 1, if there is no selection start position) and the specified coordinates.  
Public MethodExtendSelectionRectSelects all text in the terminal window in all rows between the starting row and the specified row (or row 1, column 1, if there is no selection start position).  
Public MethodGetCharacterGets the ScreenCharacter at the specified location.  
Public MethodGetCharactersGets ScreenCharacter objects from the specified location, each representing one character at a screen location.  
Public MethodGetTextGets the text from the specified location.  
Public MethodGetTextExGets the text from the specified screen area.  
Public MethodLockInputLocks the screen so that users cannot input on keyboard.  
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 MethodPutCharacterPuts a ScreenCharacter at the specified screen location.  
Public MethodPutText1Puts the text at the specified screen location, taking up "length" number of byte positions.  
Public MethodPutText2Puts the text at the specified screen location.  
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. You can also set the selection start position by clicking in the terminal window with the mouse. If no selection start position has been set, the default is row 1, column 1.  
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 unloacked enabled 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
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 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 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