Local Edit Properties of the HostOptions object
Related Topics

image\validfor_v.gif

Applies To Objects

HostOptions

Description

The properties in this group support the Local Edit features of VT terminals. They are equivalent to the options on the page Settings, Display, Local Edit.

Syntax

Unless noted, all local editing properties have the following syntax:

object.Property

Element

Description

Object

The HostOptions object.

Property

A local edit-related property.

 

Names and Descriptions of individual properties

EditEOBChars Property

Returns or sets character to use to signal the end of block of data. Type the characters to send to indicate the end of a block of data. The default character is FF (^L).

 

EditEOLChars Property

Returns or sets character to use to signal the end of line in a block of data .Type the characters to send to indicate the end of a line in a block of data. The default character is CR (^M).

 

EditEraseAll Property

Returns or sets which type of character to erase. Specify the type of characters that you or the host can erase. If TRUE, all characters can be erased. If FALSE, only unprotected characters can be erased.

 

EditFunctionKeys Property

Returns or sets how the F6 through F20 function keys work in local edit mode. Use a constant or value from the following table.

Constant

Value

Description

xEDITFNKEYSDISABLED

0

Key does nothing.

xEDITFNKEYSIMMEDITAE

1

Key sends its usual escape sequence to the application software and does not affect edit mode.

xEDITFNKEYSPREFIX

2

Key sends its escape sequence to the host before sending a block of data.

xEDITFNKEYSSUFFIX

3

Key sends its escape sequence to the host after sending a block of data.

 

EditGuardedAreaAllProperty

Returns or sets which type of character to send. If FALSE, only unprotected characters are sent. If TRUE, all characters are sent.

 

EditKeyImmediate Property

Returns or sets how to switch modes when SHIFT+SELECT is pressed. If TRUE, the mode switches immediately. If FALSE a request to switch modes is sent to the host.

 

EditLineTransmit Property

Returns or sets what to do when TRANSMIT is pressed. If TRUE, sends a line of eligible characters. If FALSE, sends a full or partial page. The page size depends on the state of EditTransferTermination and EditVT131Transfer properties.

 

EditMode Property

Returns or sets the state of Local Edit. Options | Settings | Display | LocalEdit | EditMode

Constant

Value

Description

xEDITMODEINTERACTIVE

0

Local Edit off.

xEDITMODEENABLED

1

Local Edit on.

xEDITMODEUNAVAILABLE

2

Local Edit disabled.

 

EditMultipleArea Property

Returns or sets which selected area to send. If TRUE, all selected areas on the current page are sent. If FALSE, only the selected area containing the cursor is sent.

 

EditNewLineScrolling Property

Returns or sets whether to scroll at the end of the screen. If TRUE, in Line Transmit mode, text scrolls at the end of the screen.

 

EditSelectedAreaAll Property

Returns or sets which characters to send. If TRUE, only those characters to which the host assigned the selected attribute are sent.

 

EditSpaceCompression Property

Returns or sets whether to send unused fields and spaces in a data block. If TRUE, a record separator is sent in place of unused character fields and spaces in a data block; the last field on a line will contain an EOL character. If FALSE, space character is sent for each unused character position.

 

EditTransferTermination Property

Returns or sets what to send when TRANSMIT is pressed. If TRUE, the scrolling region is sent. If FALSE, a block based on the VT131 Transfer option is sent.

 

EditTransmitImmediate Property

Returns or sets how to send data to the host when TRANSMIT is pressed. If FALSE, ESC S is sent to notify the host that data is available, and the host retrieves the data. If TRUE, data is sent immediately.

 

EditVT131Transfer Property

Returns or sets what terminal type to use to send a data block. If TRUE, data is sent as from a VT131 terminal. If FALSE, data is sent as from an ANSI terminal.