Function: Prepares the Server to be started. Follow this call by setting the ServerActive property
to True. This must be called before any of the methods described below.
DefineFormat
Parameters:
font,
linecount
Function:
Adds a line formatting definition. This command is called multiple times to build a
display formatting definition for multiple lines which is then sent to the
ActiveTerminal
by
the
SendFormat
command.
If only one line is defined (that is DefineFormat is called only once), then after
SendFormat is called, only one line will be available for display on the ActiveTerminal.
There are a limited number of lines available depending on the font size(s) chosen. Each
font has a defined height:
small: 16
medium: 24
large: 32
The total height of the defined lines cannot exceed 240. If it does, an error code is
generated (see CheckError) and the SendFormat command is ignored.
There is limited display width available for text. Depending on the font you select for a
line:
small: 26 characters
medium: 20 characters
large: 13 characters
If you try to send prompt or display text longer than this, it will be truncated and an
error code is generated (see CheckError).
Must be followed by a
SendFormat
and then an
Input
call to take effect.
SendFormat
Parameters:
termID, FGcolor, BGcolor
Function:
Sends to the
ActiveTerminal
the current Format Definition as created by one or more calls
to the DefineFormat method. It also sets the user-default display foreground and
background colors.
Must be followed by an
Input
method call to take effect.
InputAnyColor
Parameters:
termID, line, position, prompt, shifted, timestamped, FG, BG
Function: This instructs the ActiveTerminal to display the prompt at line and position and wait for
data to be entered from either terminal keypad or scanner. If shifted is set to "true", the
terminal will start in shifted mode. Timestamped appends a (hhmmss) prefix to the
returned data. FG and BG are ForeGround and BackGround color, see table above for
key.
InputAny
(deprecated)
Parameters:
termID, line, position, prompt, shifted, timestamped
Function: Provided for backward compatibility. Use
InputAnyColor
for new applications
84