InfoConnect API Guide
Inheritance Hierarchy
In This Topic
    Attachmate.Reflection.Emulation.IbmHosts Namespace
    In This Topic
    Includes types that support working with IBM host terminal emulation.
    Classes
     ClassDescription
    ClassAfterSendKeys event argument class.
    ClassContains the Key and Cancel properties that allow the event handler to cancel the action or modify the key value before the control key is sent to the host.
    ClassContains the Cancel and Key properties that allow the event handler to cancel the action or modify the key value before the key is sent to the host.
    ClassProvides methods and properties for interacting with a terminal session's context menu
    ClassRepresents an individual item within a context menu.
    ClassDefines properties and operations on the collection of context menus currently defined in the session document
    ClassCreditCardRecognized event arguments.
    ClassCursorInNewField event argument.
    ClassRepresents (on a host screen) a field with field attributes, start position, and field length.
    ClassDefines an individual hotspot instance
    ClassHot spot object, defines the set of properties and methods related to hotspots.
    ClassException object thrown by IbmHosts objects to indicate a error condition.
    Class 
    ClassAn action that can be mapped to something in an input map.
    ClassContains a set of actions that are mapped to an input mapping.
    ClassMaps a key to a sequence of one or more input actions.
    ClassRepresents the state of a particular mouse button mapping.
    ClassMaps a mouse button/modifier key combination to a sequence of one or more input actions.
    ClassPrinterPrintOptions object for printer sessions.
    ClassThis event is triggered when an event defined by the DefineEvent method occurs. Events defined in this way remain defined as long as your InfoConnect session lasts, or until they are removed using the RemoveEvent.
    ClassScreenCharacter represents one character on the host screen.
    ClassScreenPoint represents a coordinate of a row and a column on the host screen.
    Interfaces
     InterfaceDescription
    Interface 
    InterfaceProvides methods and properties for interacting with a terminal session's context menu
    InterfaceDefines properties and operations on the collection of context menus currently defined in the session document
    InterfaceProvides properties for configuring host file transfer, and methods for executing a file transfer to or from the host.
    InterfaceDefines methods to configure hotspots and properties to get and set hotspot visibility, position, and other attributes.
    InterfaceThe IIbmPrinter interface is an interface to access an IBM 3270 or 5250 host emulation printer session object.
    InterfaceIIbmScreen defines an interface to host the emulation screen object.
    InterfaceThe IIbmTerminal interface is an interface to access an IBM 3270 or 5250 host emulation session object.
    InterfaceMethods and properties associated with the session document's keyboard map.
    InterfaceDefines methods, properties, and events associated with running or recording macros.
    InterfaceMethods and properties associated with the session document's mouse map.
    InterfaceProperties relating to the host session status line
    InterfaceInterface for print options for printer session
    InterfaceIPrintOptions interface defines an interface for host emulation printing and screen printing options.
    InterfaceDefines an area on the host screen for selecting text.
    InterfaceDefines properties and methods to load, modify, or save an InfoConnect theme.
    InterfaceProvides an interface to get and set terminal colors within an InfoConnect theme.
    InterfaceDefines the attributes (such as shape) of the cursor displayed within an InfoConnect theme.
    InterfaceDefines the font attributes (such as font name, font size) for terminal fonts within an InfoConnect theme.
    InterfaceDefines the sounds played when events (such as Connected and Disconnected) occur during InfoConnect sessions.
    InterfaceMethods and properties associated with accessing and setting the input map action sequence for a given user interface control.
    Delegates
     DelegateDescription
    DelegateHandles the AfterSendKeys event to permit users to obtain the string sent to the host and the row and column on the screen where the keys were sent.
    DelegateHandles 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.

    DelegateHandles the BeforeSendKeys event that permits users to modify a key value and cancel a send key action before it is sent.
    DelegateCreditCardRecognized event handler.
    DelegateCursorInNewField event handler delegate.
    DelegateHandles legacy Reflection for IBM events
    Delegate 
    Delegate 
    DelegateThis event is triggered when an event defined by the DefineEvent method occurs. Events defined in this way remain defined as long as your InfoConnect session lasts, or until they are removed using the RemoveEvent.
    Enumerations
     EnumerationDescription
    EnumerationSpecifies the authority level associated with a file that is transferred to the host.
    EnumerationSpecifies which character set to use for transfers to and from an AS/400.
    EnumerationSpecifies valid character values to use as the column separator in 5250 terminal sessions.
    EnumerationSpecifies the date format for selected fields that have an AS/400 field type of Date.
    EnumerationSpecifies the character to use as a date separator in selected fields that have an AS/400 field type of Date.
    EnumerationSpecifies a character to use as a decimal separator in selected fields that have an AS/400 field type of packed decimal or zoned decimal.
    EnumerationSpecifies which type of host file to create (for AS/400 data transfer in 5250 sessions).
    EnumerationSpecifies which transation program to use.
    EnumerationSpecifies which character set InfoConnect uses for character translations during AS/400 data transfers.
    EnumerationSpecifies whether to tranfer data to a new member on the AS/400 or to an existing member, and whether the file that contains the member already exists. (5250 sessions only.)
    EnumerationSpecifies whether host data should be received to a PC file or to your display.
    EnumerationSpecifies a conversion format for a file being received from an AS/400.
    EnumerationSpecifies a conversion format for files received from an AS/400.
    EnumerationDefines valid values that control rendering of the status line in 5250 terminal sessions.
    EnumerationSpecifies the time format for selected fields that have an AS/400 field type of Time.
    EnumerationSpecifies the character to use as a time separator in selected fields having an AS/400 field type of Time.
    EnumerationSpecifies the protocol to use.
    EnumerationDefines valid values for the 5250 word wrap feature.
    EnumerationSpecifies values for the color mode operation of 3270 terminal sessions.
    EnumerationConnection status.
    EnumerationFor 3270 Printer transport connection type when Use Telnet Extended is selected.
    EnumerationSpecifies a type of context menu item
    EnumerationDefines the valid values for control keys.
    EnumerationSpecifies whether carriage returns and line-feed characters at the end of lines are removed (when you send binary/ASCII files to the host) or added (when you receive these files).
    EnumerationSpecifies options for the IbmScreen.CopyDataSeparation property
    EnumerationDefines values that specify the speed at which the cursor blinks in the terminal window.
    EnumerationDetermines how the cursor moves between composed Thai characters.
    EnumerationDefines values that determine the cursor's appearance in the terminal window.
    EnumerationDefines cut/fill character values, which specify whether Cut and Clear actions replace characters with nulls or spaces.
    EnumerationDefines valid values for DBCS unmapped characters.
    EnumerationSpecifies the location of DBCS user-defined character fonts.
    EnumerationDefines the action that occurs with an IND$FILE transfer when the specified destination file already exists.
    EnumerationSpecifies the default type for mainframe transfers.
    EnumerationSpecifies the host settings.
    Enumeration5250 Printer session Host print transform envelope source
    EnumerationHost session error statuses.
    EnumerationDefines values that determine a field's attributes.
    EnumerationDefines valid field type values.
    EnumerationSpecifies which operation to perform when a file already exists.
    EnumerationSpecifies the filename appearance within the Transfer dialog box for files created in 16-bit applications.
    EnumerationDefines valid values for specifying the file system.
    EnumerationSpecifies the transfer request file type.
    EnumerationSpecifies the transfer protocol that InfoConnect will use.
    EnumerationDetermines the direction in which to search for text on the screen.
    Enumeration5250 Printer session Forms Model
    EnumerationDefines options that specify how to handle the screen data between Start Row/Col and End Row/Col.
    EnumerationDescribes the field types to return.
    EnumerationSpecifies formatting options.
    EnumerationSpecifies screen wrapping characteristics.
    EnumerationDefines valid values for the color of the graphics cross-hair cursor in a 3179G terminal session.
    EnumerationDefines valid values for the shape of the graphics cursor in 3179G terminal sessions.
    EnumerationDefines valid values for the type of graphics device InfoConnect emulates for 3179G terminal sessions.
    EnumerationDefines valid values for the host code page character set used for character translations.
    EnumerationDefines options that specify which keys can be used in numeric fields.
    EnumerationOptions for the host operating system for 3270 file transfer.
    EnumerationSpecifies options for mouse button to use when invoking hotspots
    EnumerationSpecifies options for how hotspots appear on the screen
    EnumerationIdentifies a host terminal attribute.
    EnumerationDefines the IBM Host/Terminal type.
    EnumerationDefines criteria used to obtain a device name from the ID Management server.
    EnumerationSpecifies the unit of disk space for your primary and secondary space allocations.
    EnumerationSpecifies the default type for mainframe transfers.
    EnumerationSpecifies the record format values for files created on the host by an IND$FILE transfer.
    EnumerationSpecifies whether InfoConnect uses the Write Structured Field protocol for IND$FILE transfers and determines the buffer size.
    EnumerationDefines options that specify how InfoConnect underlines input fields on host screens.
    EnumerationActions that can be mapped to keyboard maps or mouse maps.
    EnumerationDefines options that specify the extent to which InfoConnect applies the logic for character insertion, as described for the terminal's InsertProtocol property.
    EnumerationDefines options that specify what InfoConnect does when users attempt to insert a character.
    EnumerationDefines options that specify how InfoConnect periodically polls the host to determine if Telnet connections remain active during intervals when data is not sent to the host.
    EnumerationDefines options that specify how keyboard errors are processed.
    EnumerationIndicates the location to which a macro is saved.
    EnumerationIndicates the source location of a macro.
    Enumeration5250 Printer - Host print transform manufacturer types
    EnumerationNumber of single or double mouse clicks used for a Mouse Map mapping.
    EnumerationDefines options that specify the appearance of the mouse pointer in the terminal window.
    EnumerationMouse wheel scroll direction used for a Mouse Map mapping.
    EnumerationSpecifies what happens after Event occurs.
    EnumerationSpecifies whether Event is enabled or disabled.
    EnumerationIdentifies the event which will trigger the commands specified the Commands argument.
    EnumerationValid values for the second parameter to the openURLAction action. This determines where to open the URL specified in the first parameter.
    Enumeration5250 Printer device initialization - Host Print Transform paper source 1 and 2
    EnumerationDefines options for specifying which character is inserted as a line break when data containing a line break is copied from the Clipboard to a field on the terminal screen.
    EnumerationOptions for specifying the background color to use when printing the terminal screen.
    EnumerationOptions for specifying how many characters to print per inch.
    EnumerationOptions for specifying whether InfoConnect doubles the horizontal size of double-byte characters when it prints host screens or print jobs to make them more legible.
    EnumerationOptions for specifying whether to rotate characters 270 degrees when printing host print jobs or terminal screens.
    EnumerationOptions for specifying the paper source on the host printer.
    EnumerationDefines valid values for the 3270 Printer session national character set
    Enumeration 
    Enumeration 
    EnumerationOptions for specifying the default page orientation used to print host documents.
    EnumerationOptions for specifying what InfoConnect does when you send a print job to an existing file.
    EnumerationOptions for specifying whether InfoConnect simulates bold printing by using offset overstrike printing.
    EnumerationOptions for specifying the paper size to use for the current default Windows printer.
    EnumerationOptions for specifying the paper source to use for the current default Windows printer.
    EnumerationOptions for specifying how the PrintScreen method prints screen text.
    EnumerationOptions for specifying how InfoConnect treats shift-out and shift-in (SO/SI) characters when printing host print jobs or terminal screens.
    EnumerationPrint Type Enum
    EnumerationIn 3179G terminal sessions, this setting specifies whether to print graphics only, text only, or both graphics and text when printing from the terminal window.
    EnumerationDefines valid options for configuring the PutText mode set by the IbmScreen PutTextMaskProtectedField property. This mode controls how the PutText method handles protected fields when placing a string of characters onto the host screen.
    EnumerationOptions for specifying the ruler cursor type.
    EnumerationDefines host screen colors specified by the host.
    EnumerationSpecifies the type of a selected region (Stream or Block).
    EnumerationDefines values that specify what happens when the ATTN host key is transmitted.
    EnumerationDefines options for specifying the encryption strength for Secure Sockets Layer/Transport Layer Security (SSL/TLS) datastream encryption.
    EnumerationDefines values that specify what happens when the SysReq function is transmitted. The definition of this key varies by host application.
    EnumerationDefines the options for terminal models.
    EnumerationDefines values that specify the blink rate for text displayed in the terminal window.
    EnumerationDefines options that indicate how text is compared against the text on the host screen.
    EnumerationSpecifies options for TLS and SSL versions
    EnumerationSpecifies which 3270 operating environment the host is running.
    EnumerationX-clock status.
    See Also