Attachmate.Reflection.Objects.Emulation.IbmHosts Library

In This Topic

This library includes the objects required to work with IBM host sessions.

Objects

	Object	Description
	ContextMenu	Provides methods and properties for interacting with a terminal session's context menu
	ContextMenuItem	Represents an individual item within a context menu.
	ContextMenus	Defines properties and operations on the collection of context menus currently defined in the session document
	FieldAttributes	Defines valid values used to determine a field's attributes.
	FileTransfer	Provides properties for configuring host file transfer and methods for executing a file transfer to or from the host.
	HostField	HostField represents a field on the host screen that includes field attributes, a start position, and a field length.
	Hotspot	Maps a key to a sequence of one or more input actions.
	HotSpots	Obtains or specifies information that pertains to hotspots behavior.
	IbmScreen	IbmScreen represents the host application screen. It provides methods and properties to access host screen data.
	IbmTerminal	The IbmTerminal is an IBM 3270 or 5250 host emulation session object.
	InputMapAction	An action that can be mapped to something in an input map.
	InputMapActionSequence	A set of zero or more actions that can be mapped to a mouse button or a key.
	KeyboardMapper	Provides the ability to view keyboard mappings for the terminal session, and to remap keys programmatically.
	KeyboardMapping	Maps a key to a sequence of one or more input actions.
	Macro	Methods, properties, and events associated with running or recording macros.
	MouseButtonCombination	Represents the state of a particular mouse button mapping.
	MouseMapper	Provides the ability to view mouse mappings for the terminal session, and to remap mouse button combinations programmatically.
	MouseMapping	Maps a mouse button/modifier key combination to a sequence of one or more input actions.
	OIA	Provides access to properties of the Operator Information Area (host session status line).
	PrintOptions	PrintOptions object represents print screen and printer emulation configuration options.
	ScreenCharacter	ScreenCharacter represents one character on the host screen.
	ScreenPoint	ScreenPoint represents a coordinate of a row and a column on the host screen.
	ScreenRegion	Defines an area on the host screen for selecting text.
	Theme	Theme object represents a visual theme in the application.
	ThemeColor	Provides implementation of properties and methods to get and set terminal colors within a Reflection theme.
	ThemeCursor	Cursor configuration properties for the current Theme.
	ThemeFont	Font configuration properties for the current Theme.
	ThemeSounds	Sounds configuration properties for the current Theme.
	UiControlActionMapper	Methods and properties associated with accessing and setting the input map action sequence for a given user interface control.

Events

	Event	Description
	AfterSendKeysEventHandler	Handles the BeforeSendKey event to permit users to modify a key value or cancel a send key action before it is sent.
	BeforeSendControlKeyEventHandler	Handles the BeforeSendControlKey event to permit users to modify a control key value or cancel a send control key action before it is sent. To cancel the action, set the Cancel property of the BeforeSendControlKeyEventArgs object passed to the event handler to true.
	BeforeSendKeysEventHandler	The event occurs before a data key is sent to the host.
	CursorInNewFieldEventHandler	The event occurs when the cursor moves into a different field.
	DefinedEventHandler	This 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.
	IBMHostCreditCardRecognizedHandler	Unredacted PAN is displayed or accessed.
	IbmHostEventHandler	IbmHost default event.
	MouseClickEventHandler	This event occurs when a session window is clicked by the mouse.
	MouseClickEventHandlerEx	This event occurs when a session window is clicked by the mouse.

Enumerations

	Enumeration	Description
	AS400AuthorityOption	Specifies the level of authority to associate with a file that is transferred to the host.
	AS400CharSetOption	Specifies the character set to use for transfers to and from an AS/400.
	AS400ColumnSeperatorOption	Defines values that specify which character to use as the column separator in 5250 terminal sessions.
	AS400DateFormatOption	Specifies the date format for selected fields that have an AS/400 field type of date.
	AS400DateSeparatorOption	Specifies a character to use as a date separator in selected fields that have an AS/400 field type of date.
	AS400DecimalSeparatorOption	Specifies a character to use as a decimal separator in selected fields that have an AS/400 field type of packed decimal or zoned decimal.
	AS400HostFileTypeOption	Specifies the type of host file to create.
	AS400HostTPOption	Specifies which transaction program to use.
	AS400NationalCharSetOption	Specifies the character set Reflection uses for character translations during AS/400 data transfers.
	AS400ObjectsOption	Specifies whether data should be transferred to a new member on the AS/400 or to an existing member, and whether the file that will contain the member already exists.
	AS400OutputDestinationOption	Specifies whether host data is received to a PC file or to your display.
	AS400ReceiveConversionOption	Specifies a conversion format for files received from an AS/400.
	AS400SendConversionOption	Specifies a conversion format for files received from an AS/400.
	AS400StatusLineOption	Options for specifying which of three different host status lines appears at the bottom of the terminal window when you are connected to an AS/400.
	AS400TimeFormatOption	Specifies the time format for selected fields that have an AS/400 field type of time.
	AS400TimeSeparatorOption	Specifies a character to use as a time separator in selected fields that have an AS/400 field type of time.
	AS400TransportOption	Specifies the protocol to use for data transfers.
	AS400WordWrapOption	Defines valid values for the 5250 word wrap feature.
	ConnectionStatus	Connection status.
	ContextMenuItemType	Specifies a type of context menu item
	ControlKeyCode	Defines valid values for control keys.
	ConvertCrLfOption	Specifies whether a carriage return and a line-feed character at the end of each line of an binary/ASCII file are removed (when the file is sent to the host) or added (when the file is received from the host).
	CopyDataDelimiterOption	Specifies options for the IbmScreen.CopyDataSeparation property
	CursorBlinkRateOption	Defines valid values that determine the speed at which the cursor blinks in the terminal window.
	CursorMovementStyleOption	Defines valid values that determine how the cursor moves between composed Thai characters.
	CursorShapeOption	Defines valid values that determine the cursor appearance in the terminal window.
	CutFillCharacterOption	Defines valid values that specify whether Cut and Clear actions replace characters with nulls or spaces.
	DbcsUnmappedCharOption	Defines valid values for DBCS unmapped characters.
	DbcsUserDefinedCharacterSourceOption	Defines valid values that specify the location of DBCS user-defined character fonts for 5250 sessions.
	DefaultExistsActionOption	Specifies what happens when, for an IND$FILE transfer, the destination file already exists.
	DefaultTransferTypeOption	Specifies the default type for Mainframe transfers.
	DefinedEventType
	ErrorStatus	Host session error statuses.
	FieldType	Defines valid field type values.
	FileExistsOption	Specifies, for IND$FILE transfers, what happens when the destination file already exists.
	FilenameCase8Dot3Option	Specifies how the Transfer dialog box displays filenames of PC files created in 16-bit applications.
	FileSystemOption	Defines valid values for specifying the file system.
	FileTransferRequestType	Specifies the transfer request file type.
	FileTransferTypeOption	Specifies the transfer protocol for Reflection to use.
	FindOption	Determines the direction to search for text on the screen.
	GetTextArea	Defines options that specify how to handle the screen data between Start Row/Col and End Row/Col.
	GetTextAttr	Describes the field types to return.
	GetTextFlags	Specifies formatting options.
	GetTextWrap	Specifies screen wrapping characteristics.
	GraphicsCrosshairColorOption	Valid values for the color of the graphics cross hair cursor in a 3179G terminal session.
	GraphicsCursorShapeOption	Valid values for the shape of the graphics cursor in 3179G terminal sessions.
	GraphicsDeviceOption	Defines valid values for the type of graphics device Reflection emulates for 3179G terminal sessions.
	HostCodePageOption	Defines valid values for the host code page character set used for character translations.
	HostKeyboardTypeOption	Defines options that specify which keys can be used in numeric fields.
	HostSystem	Options for the 3270 File Transfer host operating system.
	HotspotsMouseButtonOption	Specifies options for mouse button to use when invoking hotspots
	HotspotStyleOption	Specifies options for how hotspots appear on the screen
	IbmTerminalAttributeOption	Identifies a host terminal attribute.
	IbmTerminalType	Defines the IBM Host/Terminal type.
	IDMAttributeOption	Criteria used for obtaining a device name from the ID Management server.
	IndAllocUnitOption	Specifies the unit of disk space for your primary and secondary space allocations.
	INDFileTransferType	Specifies the default type for Mainframe transfers.
	IndRecordFormatOption	Specifies the record format for files created on the host by an IND$FILE transfer.
	IndStrucFieldSizeOption	Specifies whether Reflection uses the Write Structured Field protocol for IND$FILE transfers and if so, sets the buffer size.
	InputFieldUnderlinesOption	Defines options that specify how Reflection underlines input fields on host screens.
	InputMapActionID	Actions that can be mapped to keyboard maps or mouse maps.
	InsertArenaOption	Defines options that specify the extent to which Reflection applies the logic for character insertion, as described for the terminal's InsertProtocol property.
	InsertProtocolOption	Defines options that specify what Reflection does when users attempt to insert a character.
	KeepAlivePacketsOption	Defines options that specify how Reflection periodically polls the host to determine if Telnet connections remain active during intervals when data is not sent to the host.
	KeyboardErrorResetOption	Defines options that specify how keyboard errors are processed.
	Keys	Specifies key codes and modifiers.
	MacroDestinationOption	Indicates the location to which a macro is saved.
	MacroEnumerationOption	Indicates the source of the macros.
	MouseButtons	Constants that define which mouse button was pressed.
	MouseClickCount	Number of clicks for a Mouse Map mapping.
	MouseShapeOption	Defines options that specify the appearance of the mouse pointer in the terminal window.
	MouseWheelDirection	Mouse wheel scroll direction used for a Mouse Map mapping.
	OpenUrlActionLocationOption	Valid values for the second parameter to the openURLAction action. This determines where to open the URL that is specified in the first parameter.
	PasteLineBreakOption	Defines options for specifying the character to insert as a line break when pasting data that contains line breaks from the Clipboard to a field on the terminal screen.
	PrintBackgroundOption	Options for specifying which background color to use when printing the terminal screen.
	PrintCharsPerInchOption	Options for specifying how many characters to print per inch.
	PrintDbcsHorzFontSizeOption	Options for specifying whether Reflection doubles the horizontal size of double-byte characters when it prints host screens or print jobs to make them more legible.
	PrintDbcsRotationAngleOption	Options for specifying whether to rotate characters 270 degrees when printing host print jobs or terminal screens.
	PrintDevicePaperSourceOption	Options for specifying the paper source on the host printer.
	PrinterOrientationOption	Options for specifying the default page orientation used to print host documents.
	PrintFileExistsActionOption	Options for specifying what Reflection does when you send a print job to an existing file.
	PrintOverstrikeOption	Options for specifying whether Reflection simulates bold printing by using offset overstrike printing.
	PrintPaperSizeOption	Options for specifying the paper size to use for the current default Windows printer.
	PrintPaperSourceOption	Options for specifying the paper source to use for the current default Windows printer.
	PrintScreenOption	Options for specifying how the PrintScreen method prints screen text.
	PrintSosiPresentationOption	Options for specifying how Reflection treats shift-out and shift-in (SO/SI) characters when printing host print jobs or terminal screens.
	PrintWhatOption	In 3179G terminal sessions, this setting specifies whether to print only graphics, only text, or graphics and text when printing from the terminal window.
	PutTextModeOption	Defines valid options for configuring the PutText mode set by the IbmScreen PutTextMaskProtectedField property. This mode controls how the PutText methods handle protected fields when placing a string of characters onto the host screen.
	RulerCursorTypeOption	Options for specifying the ruler cursor type.
	ScreenColor	Defines host screen colors specified by the host.
	SelectionMode	Specifies the type of a selected region (Stream or Block).
	TelnetAttnOption	Defines values that specify what happens when the ATTN host key is transmitted.
	TelnetEncryptionStrengthOption	Defines options for specifying the encryption strength for Secure Sockets Layer/Transport Layer Security (SSL/TLS) datastream encryption.
	TelnetSysReqOption	Defines values that specify what happens when the SysReq function is transmitted.
	TerminalModel	Defines the options for terminal models.
	TextBlinkRateOption	Defines values that specify the blink rate for text displayed in the terminal window.
	TextComparisonOption	Defines options that indicate how text is compared against the text on the host screen.
	TLSSSLVersionOption	Specifies options for TLS and SSL versions
	XStatus	X-clock status.

Reference

Attachmate.Reflection.Objects.Emulation.IbmHosts Library

Send Feedback