Property Name | Description |
* Terminal Status (NOTE: All terminal status properties are readonly.) | |
CursorRow | The current row position of the cursor. Starting from 0 for the top screen border. |
CursorCol | The current column position of the cursor. Starting from 0 for the left screen border. |
* Display settings | |
CursorType | 0 for block cursor, 1 for underline cursor. |
CursorVisible | 0 for invisible, 1 for visible. |
DarkScreen | 0 for light screen, 1 for dark screen |
CursorBlink | 0 for not blink, 1 for blink |
LineDraw | 0 for using line draw characters in font, 1 for drawing the line by KoalaTerm |
FontName | Name of the display font |
FontSize | Point size of the display font |
FontBold | 0 for non-bold, 1 for bold display font |
FontName132 | Name of the display font (for 132 columns) |
FontSize132 | Point size of the display font (for 132 columns) |
FontBold132 | 0 for non-bold, 1 for bold display font (for 132 columns) |
FontUse80 | 0: use differnt font for 132 columns; 1: use same font |
* Printing settings | |
FFNeeded | 0 for no FF, 1 for FF appended to each print job |
PrintTo | 0: Print to printer driver; 1: Redirect to Windows; 2: Direct to port |
DriverName | Driver name of the printer |
PrinterName | Name of the printer |
DefaultPrinter | 0 for using specified printer, 1 for using default printer |
PrintFontName | Name of printing font |
PrintFontSize | Pointer size of printing font |
PrintFontBold | 0 for non-bold, 1 for bold printing font |
PrintPort | Print port number. 0 for LPT1, 1 for LPT2 ... |
JobTimeout | Timeout (seconds) for finishing a transparent printing job. |
* Terminal settings | |
Interpret | 0 for displaying the control sequeces, 1 for interpreting them |
AutoWrap | 0 for no autowrap, 1 for autowrap |
8BitChars | 0 for 7 bits control characters, 1 for 8 bits |
TermID | Terminal ID. 0-5 for VT420, VT320, VT220, VT102, VT101,VT100 respectively. |
AnswerBack | Answer back string for VT terminal |
HideABM | If 1, KoalaTerm will hide the answer back in KoalaTerm Settings |
Columns | Number of columns in a terminal line |
Lines | Number of lines in a terminal page |
Pages | Total numbe of pages for terminal buffer |
SaveLines | Maximum number of saved history lines |
MouseSupport | Mouse support: 0 - No mouse support; 1 - Linux mouse support |
SaveAll | If 1, everything is saved into history before screen erased |
* Tab settings | |
TabList | An array with 132 elements. Each element represents a flag of tab stop at a column. If the flag is 1, the column is a tab stop. |
* Keyboard settings | |
NewLine | 0 for no newline, 1 for new line. In new line mode, the return key will generate both <CR> and <LF> characters. |
NumericKeypad | Keypad mode: 0 for application mode, 1 for numeric mode |
CusorKeys | Cursor keys mode: 0 for application mode, 1 for normal mode |
MarginBell | 0 for margin bell disabled, 1 for enabled |
WarningBell | 0 to disable and 1 to enable |
BackArrow | If 0, send <Backspace> code for backspace key, if 1, send <Delete> code instead |
NumLock | If 1, use NumLock key to change keypad mode, if 0, use NumLock key as PF1 |
* Communication settings | |
HostName | Name of the connected host |
Proxy | Name of the telnet proxy |
HostType | 0 for telnet, 1 for comm port, 2 for local echo, 3 for modem. |
Port | Port number. Telnet: telnet port; comm: 0 for com1, 1 for com2...; modem: ID of modem. |
Speed | Comm port: baud rate. Telnet: proxy port number |
Parity | 0: No Parity 1: Even 2: Odd 3: Mark 4: Space |
StopBits | 0: 1 bit 1: 1.5 bits 2: 2 bits |
DataLength | 0: 6 bits 1: 7 bits 2 : 8 bits |
LocalEcho | 0: Local echo off. 1: Local echo on |
Local | 0: Online. 1: Local |
FlowControl | 0: No flow control 1: Xon/Xoff 2: Hardware flow control |
* Character set settings | |
* charset codes: | 0: ASCII 1: DEC supplement graphic 2: DEC special graphic 3: DEC technical 4: ISO Latin 1 5: ISO Latin 2 6: ISO Latin 3 7: ISO Latin 4 8: ISO Cyrillic 9: ISO Greek 10: MS DOS 11: MS 866 12: KOI8r 13: ISO Hebrew 14: ISO Latin 5 15: ISO Arabic |
UPSS | User preferred supplemental charset |
PrimarySet | Primary supplemental charset |
SecondarySet | Secondary supplemental charset |
NRC | National replacement charset. See the following code table: |
* NRC charset codes: | 0: USASCII 1: ISO UK 2: DEC Dutch 3: DEC Finnish 4: ISO French 5: DEC Frech Canadian 6: ISO German 7: ISO Italian 8: DEC Norweigian Danish 9: ISO Norweigian Danish 10: DEC Portuguese 11: ISO Spanish 12: DEC Swedish 13: DEC Swiss |
ForceASCII | 1 for forcing every code, even 8-bit codes, to be treated as 7-bit ASCII. |
DBCS | 1 for enabling DBCS (Double Byte Charset) support |
* Color settings | |
Palette | Array of 64 integers for 16 colors. Each color uses 4 integers: R, G, B and flag. |
BackColor | Background color for color mapping. Array of 16 integers for 16 possible combination of attributes. Each combination uses a color index 0 -15. |
ForeColor | Foreground color for color mapping. Array of 16 integers for 16 possible combination of attributes. Each combination uses a color index 0-15. |
Mapped | Mapped flag for color mapping. Array of 16 integers for 16 possible combination of attributes. 1 for mapped, 0 for not mapped. |
* General settings | |
Maximize | 1 for maximize terminal window when created |
CopySpace | 1 for copying spaces when copied to clipboard |
AutoClose | 1 for automatically closing terminal window when disconnected |
AutoExit | 1 for automatically exit KoalaTerm when a window closed |
History | 1 for display scroll history buffer |
FitFont | 1 for automatically change font to fit in window |
LoginScript | 1 for automatically executing login script after connected |
UserID | User ID for login script |
Password | Password for login script |
Script | The login script |
CaptureDebug | 1 for capturing debug information |
AutoCopy | 1 for automatically copy to clipboard after text selected |
Title | The session title to be display on title bar of main window |
HostScript | 1 for allowing host to access protected script functions
Note: this property cannot be altered by script. |
* Button settings | |
ButtonCaption | Array for captions of 32 buttons. |
ButtonString | Array for strings of 32 buttons. |
ButtonAction | Array for action types of 32 buttons. 0: Send sequence. 1: Execute script. 2: Run script file |
* File Transfer Settings | |
AutoRecv | Automatically receiving flag. |
RecvDir | Directory for received files. |
ZModemInit | Initial string for starting ZModem receiving program on host. |
Here are some examples showing how to change terminal settings:
1. Suppose you want to define a button from the host side, let’s say, define the second button as sending sequence "exit<CR>", you can send the following sequence from the host:
<ESC>P$s term.ButtonCaption[1] = "Exit"; term.ButtonString[1] = "exit<CR>"; term.ButtonAction[1] = 0; <ESC>\
2. Suppose you want to use a larger font:
fontsize = term.FontSize; | // get current font size |
if (fontsize < 32) | // maximum size |
fontsize = fontsize + 1; | |
term.FontSize = fontsize; | // change font size. The screen will be refreshed immediately |