Mnemonics 

'OPTION'

On-the-Fly Setting

Behaviour

Format

'OPTION' (keyword$,value[$])

Where:

keyword$

Named property. Case insensitive string expression (characteristic, icon, font, colour index) described below.

value[$]

Value assigned to keyword$. String or numeric expression. (The numeric option was added in PxPlus v11.)

Description

The 'OPTION' mnemonic allows specific PxPlus environment properties (typically set via INI entries) to be set at run time (on the fly) within a session.

Note:
To read the 'OPTION' PxPlus environment properties, use FIN(0, keyword$).

Item Colors

The following keyword$ values assign colors to specific characteristics:

BtnFaceClr

Button face color.

BtnFocusHilight

Focus highlight.

BtnFrameClr

Button/Check Box/Radio Button frame color.

BtnHoverHilight  

Mouse Over highlight.

CbxMarkClr

Check mark or 'X' in a Check Box.

ClrHighlight
ClrHighlightText

Sets the background and text colors used to display currently selected items from a List Box or Drop Box and display the background and text in a Multi-Line when it has focus.

If setting focus on the Multi-Line, selects all of the text.

If selecting a portion of the inputted text for Copy, Cut, Delete or Paste functions, then the color of the selected text will be displayed in the standard Windows color for selected text.

(added in PxPlus 2017)

ClrToolBar

Background color for the tool bar.

(added in PxPlus v9)

FrameDarkClr

Color of shadow line drawn by 'FRAME' mnemonic. (Default: Dark Gray)

(added in PxPlus v11)

FrameLiteClr

Color of highlight line drawn by 'FRAME' mnemonic. (Default: Light Gray)

(added in PxPlus v11)

FrameTextClr

Color of text header used by the 'FRAME' mnemonic.

(added in PxPlus v11)

RbtMarkClr

Ball within a Radio Button.

StdFocusBackClr

Sets the background colors used to display currently selected items from a List Box or Drop Box and display the background color in a Multi-Line when the control has focus.

(added in PxPlus 2018)

StdFocusTextClr

Sets the text colors used to display currently selected items from a List Box or Drop Box and display the text in a Multi-Line when the control has focus.

(added in PxPlus 2018)

StdGridLineClr

Sets the standard/default line color for all subsequent grids. (Default is RGB: 220,220,220.)

(added in PxPlus 2020)

StdLvueHotlinkClr

(Report View Only) Used to define the default hotlink column color for List Views.

(added in PxPlus 2018)

StdLvueHoverBackClr

(Report View Only) Used to specify a system-wide background hover color for all List Views.

(added in PxPlus 2018)

StdLvueHoverTextClr

(Report View Only) Used to define the text color when the mouse is over a row in a List View.

(added in PxPlus 2018)

StdLvueLineClr

(Report View Only) Sets the standard/default line color for all subsequent report style List Views. (Default is RGB: 220,220,220.)

(added in PxPlus 2020)

StdRowHilight1

Color to be used as the background of alternate rows in a List Box or Grid.

(added in PxPlus v11)

StdRowHilight2

Color to be used as the second background of alternate rows in a List Box or Grid.

(StdRowHilight2 was added in PxPlus v11)

TipArrowColor

Used by HTML tips to define the color of the tip arrowhead and the underline below the tip title. (Default: Dark Red)

For information on HTML tips, see Defining an Info Tip.

(added in PxPlus 2016)

TipColor
or
TipColour

Used to define the color for non-HTML tips. Valid formats for defining a color include predefined system color names (e.g. LightRed), RGB values, HSL values, Hex color codes, color blending, and dynamic color lightening. For information on these formats, see Color Properties.

Setting this option sets the 'TC' system parameter to -3.

If 'TC' is set to -3 but the TipColor (or TipColour) setting is not defined, the default Windows color will be used.

(added in PxPlus 2021)

The value$ may be assigned as color names.

Black

 

White

 

DarkGray

 

LightGray

 

LightRed

 

LightMagenta

 

DarkRed

 

DarkMagenta

 

LightGreen

 

LightCyan

 

DarkGreen

 

DarkCyan

 

LightBlue

 

LightYellow

 

DarkBlue

 

DarkYellow

 

or via RGB code (i.e. RGB: n n n where n = 0 - 255) as in:

print (0)'option'("BtnNormMidClr","RGB:192,192,192"),

Item Shading 

The following keyword$ values set shading for specific characteristics:

BtnDownBtmClr

Colour for blend at the bottom of pushed button.

BtnDownBtmPct

Lightness applied to face at the bottom of pushed button.

BtnDownMidClr

Colour for blend at in middle of pushed button.

BtnDownMiddle

Mid-point percentage from the top of pushed button.

BtnDownMidPct

Lightness applied to face in middle of pushed button.

BtnDownTopClr

Colour for blend at the top of pushed button.

BtnDownTopPct

Lightness applied to face at the top of pushed button.

BtnNormBtmClr

Colour for blend at the bottom of normal button.

BtnNormBtmPct

Lightness applied to face at the bottom of normal button.

BtnNormMidClr

Colour for blend at in middle of normal button.

BtnNormMiddle

Mid-point percentage from the top of normal button.

BtnNormMidPct

Lightness applied to face in middle of normal button.

BtnNormTopClr

Colour for blend at the top of normal button.

BtnNormTopPct

Lightness applied to face at the top of normal button.

ClrAutoCompBack

Background colour to be used for text in auto complete List Boxes.

(added in PxPlus v9.00, build 9200)

ClrAutoCompText

Text colour to be used for text in auto complete List Boxes.

(added in PxPlus v9.00, build 9200)

ClrDisabledBack

Background colour to be used for text in disabled List Boxes, Multi-Lines, Radio Button text and Check Boxes.

(added in PxPlus v9.00, build 9200)

ClrDisabledText

Text colour to be used for text in disabled List Boxes, Multi-Lines, Radio Button text and Check Boxes.

(added in PxPlus v9.00, build 9200)

CtlFrameClr

Colour of lines in a frame.

The value$ must be defined as a numeric string, either from 0 to 100 (for colour indexes) or -100 to 100 (for percentages) depending on the associated item.

Example:

print (0)'option'("BtnDownBtmPct","-75")

Icons 

'OPTION'
can be used to control which icon, if any, is to be used within the upper left corner of a window/dialogue:

Icon

Set the icon for current and subsequent windows.

WdwIcon

Set the icon for the current window only.

The value$ assigned may be the path and name of the image .icofile or a full icon specification. If it is null " ", the icon is removed from the current window. If it is an * (asterisk), the default icon is displayed for the window.

Example:

print 'dialogue'(1,1,80,25,"My Window",'CS',opt="i")
print 'option'("WDWICON","C:\Windows\System32\Shell32.dll@137%32")
print 'option'("WDWICON","")
print 'option'("WDWICON","*")

Fonts

The following keyword$ values can be used to change various text plane and graphic fonts:

CB_RB_TextFont

Controls the font to use for Radio Button and Check Box text. Setting to "1" causes the system to display text using fixed text plane font. Default is to use the graphical font ("0").

Font

Sets the current window's text plane font.

GraphicFont

Sets the current window's default graphic font.

StdFont

Sets the session's default text plane font.

StdGraphicFont

Sets the session's default graphic font. If set, this must be prior to drawing any GUI controls.

The value$ indicates the current font specification. See 'FONT' mnemonic for specification. If the numeric font size specified in value$ is negative, then it provides the logical font height, not the point size.

Colour Index 

The 'OPTION' mnemonic can be used to manually set the colour index (Colour16 to Colour254) to specific RGB values:

Colornnn
or
Colournnn

Sets color number nnn.

While the colour index allows numbers 0 - 254, the first 16 are predefined by the system (0 - 15). The remaining colours must be assigned in order without skipping (i.e. Colour16 then Colour17 then Colour18, etc.). The value$ assigned may be any RGB code (RGB: n n n where n = 0 - 255); e.g. A null " ", either removes the assigned number from the table or resets it to the default colour (as predefined by PxPlus).

Example:

print 'option'("Colour64","")

! Clear out index 64 for re-use

print 'option'("Colour7","")

! Reset to the default

Note:
It is easier to simply use the colour once with the 'COLOUR' mnemonic, which automatically adds that colour to the internal colour table.

General Windows/System-Wide Options 

These options are generic to windows processing and can be applied to channel 0:

4D_ML_Adjust

Setting this option to a non-zero numeric value overrides the standard Multi-Line height adjustment to the value specified (in pixels).

Setting the value to "0" restores the standard adjustment.

AlwaysOnTop

This option is used to control locking the current window on top of all other windows.

If value$ is set to "1", then the window is locked on top; else if "0", then the window is released from being locked on top.

Note:
Only one window should be locked 'OnTop' as the system will not be able to determine which window is the top most in case the windows overlap.

Animate

Allows the application to animate the window generally during the transition from visible to hidden or vice-versa.

Possible values are:

"FADE" 2

The window will fade from solid to transparent (or vice versa).

"UP" 2

The window will collapse/expand upward.

"DOWN" 2

The window will collapse/expand downward.

"LEFT" 2

The window will collapse/expand right-to-left.

"RIGHT" 2

The window will collapse/expand left-to-right.

"CENTER" 2

The window will collapse into/expand out from the center.

"SHAKE"

The window will shake left-to-right but remain visible.

Note:
To get the desired results, the options that affect screen movement (UP, DOWN, LEFT, RIGHT and CENTER) should be avoided when using windows that have captions and thick frames. Change the window to use either a thin frame or no frame before using these options.

The FADE and SHAKE options can be used with any window, regardless of the frame style.

2   These option words can be suffixed by "IN" or "OUT" (e.g. "FADEIN", "FADEOUT") to force the specified windows transition. If "IN" is specified, the window will be forced visible. If "OUT" is specified, the window will be forced hidden. Normally, if no suffix is provided (such as "FADE"), the window changes from visible to hidden or vice-versa, depending on its current state.

AutoCompleteLimit 

Sets the AutoComplete limit.

Issuing PRINT 'OPTION'("AutoCompleteLimit", "nnn") or SETDEV (0) SET "AutoCompleteLimit" TO "nnn" can be used to set the AutoComplete limit.

AutoConvertUtf8

Setting this option to "1" (or "Y") in conjunction with setting the 'U8' system parameter will internally convert UTF-8 data to its corresponding single byte character based on the current text plane character set to allow for its display. This conversion will be done on any standard PRINT to the text plane and on all user input of extended characters (e.g. accented characters, high-order ASCII, etc.).

Where there is no corresponding single byte character for a UTF-8 code, a ? (question mark) will be output. If the 'U8' system parameter is not set, this option is ignored.

(added in PxPlus 2014)

AutoSpellCheck

This option is used to set automatic spell checking for Multi-Line controls.

Possible values are:

"YES"

(Default) Spell checking is automatically applied to Multi-Line controls that allow multiple lines of input (greater than 1.5 lines high).

"ALL"

Spell checking is automatically applied to Multi-Line controls that allow multiple lines of input, as well as all Multi-Line controls that allow for 12 or more characters of input and do not have a format mask. Controls that are marked Uppercase only or are used for Arabic (right to left) input are not spell checked.

"NO"

Spell checking is not automatically applied to Multi-Line controls. Only Multi-Line controls with the "S" option specified (see MULTI-LINE directive) will have spell checking enabled.

(added in PxPlus 2019)

BlinkTime

Controls the rate at which data will blink on a graphical device. The value provided defines the rate at which the data appears or disappears in terms of milliseconds (i.e. "500" indicated 500ms or 1/2 a second). A rate of "0" terminates blinking. Default rate is "500" milliseconds.

(added in PxPlus v8.11, build 9182)

BrowserDebug

Setting this option to "1", "Y" or "y" causes the browser developer console to display in a popup window for any subsequently created *BROWSER controls. The browser developer console makes it possible to examine the code and properties of the Web page loaded by the *BROWSER control and debug any errors.

(added in PxPlus 2021)

BrowserLang

Defines the language code that controls the embedded Chromium browser language. See Language Codes for a list of supported languages and codes.

The value of BrowserLang is only read the first time per process that an embedded Chromium browser is created. This will override the BrowserLang INI setting. Defaults to user OS language unless BrowserLangwas set in the INI file. See INI Contents.

(added in PxPlus 2019)

CaptureClientOnly

Controls the SAVE CONTROL output. If set to "1", only the client area (interior) of a window/control will be saved; otherwise, the border and caption for the window/control will be included in the output. Default setting is Off ("0").

(added in PxPlus v11.50)

CbxImage

(Windows Only) Defines the pathname to the image used to create Check Boxes on the screen.

See Customizing Radio Buttons and Check Boxes.

(added in PxPlus 2017)

CbxMarkSize

(Windows Only) If not set, the default size of the Check Box image is based on the height of one line. If set, the size of the Check Box image will be based on the value of CbxMarkSize (in pixels) or the height of the Check Box control, whichever is smaller.

Example:

See Customizing Radio Buttons and Check Boxes.

(added in PxPlus 2017)

CenterWdw

Center the current window (DIALOGUE) on screen. This mnemonic takes into account multiple monitors and places the window in the center of the nearest monitor currently displaying the window.

ClrSelectIgnore

Setting this option controls the colors that are used for displaying a selected line in a list box/list view.

If set to "1" (Default), the Windows default display colors (white characters on blue) are used.
If set to "0", the colors specified for the list box/list view contents are used.

To set the option, issue either of the following:

     PRINT 'OPTION'("ClrSelectIgnore","1") ! (or "0" to turn Off)
     SETDEV (0) SET "ClrSelectIgnore" TO "1"

Copy_1Line_NoCR

This option controls the system built-in text Copy functionality. When set to "1" or "YES" and the text being copied consists of only one line, no trailing line feed will be appended to the text. In all cases, copying multiple lines of text will append a trailing line feed.

(added in PxPlus 2021 Update 1)

DeleteOnClose

Setting this option to "1" will cause the system to attempt to delete the associated file when closed.

(added in PxPlus 2014)

DoubleBfr

Controls the double buffering of screen updates on Windows. If set to "1", screen updates are first done off-screen then copied on-screen in a single update thereby reducing flickering. Default setting is Off (0).

Affects current window only. Set this option after a window is created for each window on which you want double buffering to apply.

(added in PxPlus v10)

Flash

Controls flashing of the frame for the current window and the task bar.

"ON"

Frame and task bar will flash until turned OFF by the application.

"OFF"

Frame and task bar will stop flashing (return to normal display).

""

Frame and task bar will flash at least once and then continue to flash until the application is made 'active' (brought to the forefront of user session).

(added in PxPlus v8.11, build 9182)

Frame

This option is used to control the type of frame/border for the current window. Possible values are:

"NONE"

The window has no border/frame.

"CAPTION"

The window has a border and caption line.

"THICK"

The window has a thick border.

"THIN"

The window has a thin border (usually a single pixel wide black line).

(added in PxPlus v7.00, build 9163.1)

GrayDisabledBmp

This option is used to control the display of images on disabled buttons.

If set to Off ("0" or "N"), the images on disabled buttons will display only as shadows. This means that only the shadow left by the outline of the image will be seen.

If set to On ("1" or "Y"), the images on disabled buttons will be converted to gray scale.

Default setting is "0" or "N" (image displays as a shadow).

Example:

(added in PxPlus 2017)

GridAlignLines

Note:
This option applies only to Grids created after setting the option and only to the Button family of Cell Types: Button, FlatButton, FlatButtonInOnly, TextButton, FlatTextButton and FlatTextButtonInOnly.

When enabled (set to "1" or "Y"), any Multi-Line text (lines separated by line feed $0a$) in a Grid Button-style cell will have each line of text individually aligned as per the 'Align$ property.

If disabled (set to "0" or "N"), the lines will be treated as a block of text, and that full block will be aligned as per the 'Align$ property.

This option was added in PxPlus 2017 with a default setting of enabled. Prior versions of PxPlus did not have this setting, and the Grid output was as if the option was disabled.

(added in PxPlus 2017)

GridMLVersion

This option is used to set the behavior of the Enter key and the Up/Down arrow keys when editing a Grid cell with lines of Multi-Line text.

When set to "1" (Default), pressing Enter or Ctrl - Enter creates a new line, and the Up/Down arrow keys are used to move up/down between the lines of text in the cell.

If set to "0", pressing Ctrl - Enter creates a new line, the Enter key enters/exits the cell, and the Up/Down arrow keys are used to move to other cells.

(added in PxPlus 2019)

HideTips

This option is used to control the display of Floating tips in the system. When set to "1", tips will not be displayed. Setting it to a null value or "0" (Default) enables tips.

HoverCtl

This option is used to define a CTL value that the system will generate when the mouse hovers over the text plane in the current windows. Passing a null value or "0" disables this option.

Invalid_Bmp

This option is used to set the name of a Bitmap/Image file to be used whenever the selected Bitmap is not available for display. Use this option to avoid missing images from your application.

(added in PxPlus v7.00, build 9163.1)

Keyboard

This option can be sent to channel 0 on a Windows (or WindX) session to change the current keyboard language.

(added in PxPlus v8.11, build 9182)

LCL_MTime
LCL_ATime
LCL_CTime
 
(if file system supports)

Setting this option will change the file creation, modified, and last access time based on the value provided in the following format:

     YYYY-MM-DD hh:mm:ss

The date/time returned has be converted to local time on the system thus for files on a shared server the value may differ based on the current time zone.

(added in PxPlus v10.10)

LogFile

This option is used to set the system log file and can be used to override the setting in the INI file. The pathname can include %Y, %M and/or %D, which will each be replaced by the current year, month and day respectively (2 digits).

When defining the log file, you can specify the maximum file size (in megabytes) that you want the log file to grow. See PxPlus Log File.

(added in PxPlus v10)

MaskColour  
or
MaskColor

Sets the colour to be considered completely transparent within the current window. Note that clicking the mouse on a fully transparent section of the window passes the mouse click to the window below.

Setting this value along with removing the window frame is used to create windows of different shapes.

(added in PxPlus v7.00, build 9163.1)

MessageBar 

This option is used to set the height (in pixels expressed as a string) for the message/status bar at the bottom of the window.

ML_Overlap_Adjust

Setting this option to "1" (Default) enables an automatic adjustment of the size/position of overlapping Multi-Line controls.

When enabled, the system will adjust Multi-Lines so that neither the field nor its border overlaps any adjacent Multi-Line.

MouseWheel

This option is used to adjust the MouseWheel increment value. This is the count of logical Up/Down arrow keys that the system will emulate when the wheel is used.

Msg_Is_Tip

This option tells the system that when the mouse hovers over a control, the MSG= value should be used as a TIP when no TIP is assigned. This avoids having to set both the TIP and MSG properties for all the controls.

(added in PxPlus v7.00, build 9163.1)

PasteFilter

This option sets the PasteFilter property for Grid and Multi-Line controls. For Grids, defaults to 1 (On). For Multi-Lines, defaults to "YES" except for Multi-Lines that are >1 line high and accept multiple lines of input, which default to "NO".

(added in PxPlus 2020 Update 1)

RbtImage

(Windows Only) Defines the pathname to the image used to create Radio Buttons on the screen.

See Customizing Radio Buttons and Check Boxes.

(added in PxPlus 2017)

RbtMarkSize

(Windows Only)

If not set, the default size of the Radio Button image is based on the height of one line. If set, the size of the Radio Button image will be based on the value of RbtMarkSize (in pixels) or the height of the Radio Button control, whichever is smaller.

Example:

See Customizing Radio Buttons and Check Boxes.

(added in PxPlus 2017)

ResourceLib

Sets or changes the current resource library/libraries. As of PxPlus V11, the resource library value may contain multiple semi-colon (or comma) separated file names up to a maximum of 10.

RMouseCopy

This option enables right mouse click Copy/Paste functionality whenever focus is on the window and not on a control. It is primarily used when running older Text mode applications and provides the ability to copy/paste text from the screen much like a terminal emulator.

The value can be set "1" to enable the option or "0" (Default) to disable it. Its setting will be automatically cascaded to subsequent windows.

(added in PxPlus v8.11, build 9182)

Save_Msg_Bfr 

This option is used to control the return of error messages generated by a SAVE command.

If initially set to non-blank (by the SETDEV directive or 'OPTION' mnemonic) and a SAVE command is issued, this value will return a list of errors that occurred during the SAVE function.

SignalCaptionChg

Setting this option causes a specified CTL value to be generated when the caption on the current window is changed. Any numeric value may be used as the CTL value, but -1109 is reserved by NOMADS. The setting applies only to the current window. Setting the item to null will turn this option off.

(added in PxPlus 2017)

SortImageList

This option controls the sorting of all 'IMAGE' graphics groups by name. This sort order is used by the NOMADS Panel Designer to determine the order in which the graphics are drawn on a window.

When set to "1", the 'IMAGE' groups are sorted and drawn in alphabetical order by name on the current window. When a new 'IMAGE' group is created, it is inserted into the list of 'IMAGE' groups alphabetically.

When set to "0" (Default), the 'IMAGE' groups are drawn in the order they are created with the default group first followed by all subsequent groups in the order they were created.

(added in PxPlus 2014.01 Update 0005)

StdGridHideButtons

Sets the default 'HideButtons property for all subsequent grids.

(added in PxPlus 2020)

StdGridQueryImg

This option defines the image to use in the query/lookup buttons of a grid.

The value of the setting is an image pathname or internal image (!xxxxxx). An invalid value will result in the original ellipsis (...) being used. This value is only referenced when a grid is first created; therefore, changing the value will not affect any grid already in existence.

(added in PxPlus 2021)

StdSortOrder

The value provided defines the default column sort settings used by the List_Box (Report View) and Grid. Possible values are:

Null

Uses StdSortOrder setting (if StdSortOrder not set, uses raw sort).

R

Raw binary sort.

C

Case insensitive sort.

A

Sort ignores accents.

N

Null values at end of sort.

CA

Ignore case and accents.

CN

Ignore case/Null values last.

AN

Ignore accents/Null values last.

CAN

Ignore case and accents/Null values last.

(added in PxPlus v11.00 and upgraded to a string value in PxPlus v11.50)

Suppress_FF

Sets the file 'FF' suppression settings to one of the following values:

"NO"

No 'FF' suppression. (Default)

"ALL"

Suppresses any 'FF' mnemonic if it will result in a blank page being produced. This setting will not suppress an 'FF' mnemonic at the start of a report where a leading 'FF' is often used to assure output starts at the top of a page.

Note:
PDF and WINPRT output will suppress a leading 'FF', as these by definition always start a report on a new page.

"FIRST"

Suppresses an 'FF' mnemonic if it is the first output to the channel. Only the first 'FF' is suppressed.

"LAST"

Suppresses a trailing 'FF' mnemonic that applications often send to eject the paper at the end of a report. It is always enabled on output to PDF files.

"BOTH"

A combination of "FIRST" and "LAST".

Note:
Setting channel 0 sets the FF suppression option for all files subsequently opened.

(added in PxPlus v9.00, build 9200)

SysMenu#

This option can be used to add a menu item to the system drop-down menu, which displays when clicking the icon in the upper left corner of the PxPlus launch window or when using Alt + Spacebar.

The contents of value$ would be "SysMenu#" where # can be a range between 1 to 10, followed by "Menu Text=###" for displaying the text for the menu item. The "Menu Text" can contain an & (ampersand) preceding any character to be used as a "hot key" to select the menu item when the menu is displayed. When the menu item is selected, the CTL value specified by ### will be generated.

To set a Menu #2, you would issue:

   PRINT 'OPTION'("SysMenu2","Menu Text=###")

   or

   SETDEV (0) SET "SysMenu2" TO "Menu Text=###"

To remove an item from the menu, set the item to null:

   PRINT 'OPTION'("SysMenu2","")

Examples:

   SysMenu1=&Sleepy=1001
   SysMenu2=&Dopey=1002
   SysMenu3=&Bashful=1003
   SysMenu4=D&oc=1004

If no number is specified (i.e. "SysMenu"), the system will set the first unused slot in the system menu. To retrieve the value, use the FIN( ) function.

(added in PxPlus 2016)

TipFont

Setting this option n channel 0 changes the current font attributes of the tip window.

TipTimerCycles

Defines the length of time (in tenths of a second) that a tip will be displayed.

(added in PxPlus v8.30)

ToolBar

This option is used to set the height (in pixels expressed as a string) for the toolbar.

Transparency

Percentage transparent for the current window.

A value of "0" indicates non-transparent, "100" would be completely transparent. Can only be applied to TOP level windows.

UTC_MTime
UTC_ATime
UTC_CTime
 
(if file system supports)

Setting this option will change the file creation, modified, and last access time based on the value in the value provided consisting of UTC in seconds since Jan 1,1970.

(added in PxPlus v10.10)

Utility

This option is used to add lines to the 'Utility' command mode menu option.

The contents of value$ should contain a CTL code in the range of between 3900 and 3999 followed by an = (equals sign) and then the text to display in the menu. When the menu item is selected, the CTL value specified will be sent to the system command processor (actual value will be negated).

Window_NoAuto_Focus

Setting this option to "1" will avoid window frame repaints when changing focus between concurrent windows.

(added in PxPlus 2014)

XYPos
or
XYPos_NoChk

This option is used to change the position of the current window.

The contents of value$ would be two comma separated numbers containing the absolute pixel address (top, left) to which to move the current window. These numbers are relative to the desktop of the workstation or the current window's parent window.

The XYPos and XYPos_NoChk options are identical with the exception that XYPos validates the location (on screen and is visible), while XYPos_NoChk changes the position of the window without validating the location.

Note:
When setting a position, the system will validate the location indicated is visible (if XYPos is used); otherwise, the window will be centered on the closest monitor to the position supplied.

(added in PxPlus v7.00, build 9163.1)

XYWdw

This option is used to change the position of the current window.

The contents of value$ would be four comma separated numbers containing the absolute pixel address (top, left, bottom, and right in pixels) to move/resize the current window to. This is slightly different to XYPOS in that the information pertains to the Child windows as opposed to the outer/dialog window.

(added in PxPlus v8.11, build 9182)

ZOrder

If value$ is "1", the current window will be brought to the top of the Z-Order when input focus switches to the window.

"0" indicates that the Z-Order of the window will not be changed when focus switches to the window.

(added in PxPlus v8.11, build 9182)

Indicates this option can only be used with channel 0 under Windows (or WindX)

*WINPRT* Options

Orientation

This option is used to control the orientation of the next page to be printed. The orientation of the current page cannot be changed.

Possible values are "LANDSCAPE" or "PORTRAIT" (only the first letter is checked).

Source

This option controls the paper source for the next page to be printed. It will take effect on the next 'FF' mnemonic.

The parameter specified must be the numeric value associated with the various paper trays for the printer. Use the FIN(nnn, "SOURCELIST") function to get a list of possible values.

TCP Options

Secure

Sets the current connection on TCP/IP from unsecure to secure. The option, if specified, can contain the pathname to the security certificate to use. Once a connection is set to SECURE, it cannot be set unsecured.

TLS

This option is used to force the current secure connection on TCP/IP to only use a specific TLS protocol version (if the OS supported it) as opposed to the default mode of supporting SSL v2, v3, TLS1, 1.1, 1.2 and 1.3 (negotiated with the other end).

Possible values are:

"1"

TLS1

"1.1"

TLS1.1

"1.2"

TLS1.2

"1.3"

TLS1.3

  ""

Allow SSL v2, v3, TLS1, 1.1, 1.2 and 1.3 (negotiated with the other end)

Example:

   print (chan)'option'("TLS","1.2")

This example would make an existing secure TCP connection force the use of TLS 1.2 protocol.

(added TLS 1.3 support in PxPlus 2020)

PDF Options

Bookmark

Set bookmark location, text and hierarchy. For information on bookmarks, see *PDF* - PDF Print Interface.

Special Processing PDF Options

Although these options relate to PDF processing, these options should be issued against channel 0 prior opening the PDF file.

PDFFactor

This option defines a multiplication factor to be used in computing the extra vertical space (height) to be allocated to PDF fonts.

Increasing this value will result in wider spacing between lines when using the font size for line spacing. This applies only to PDF files using the Haru library. (Default is 1.2.)

(added in PxPlus v9.00, build 9200)

PDFFontDir

(Linux Only) This option can be used to change the location of the font directory when creating PDF files using true type fonts.

Important Note:
It must be changed before the first open of a PDF file to be effective.

(added in PxPlus v9.00, build 9200.1)

PDFMargin

This option controls the number of thousandths of an inch to use for setting the default PDF printer margins. These will be assigned on all edges of the printed document. Default is 250 (1/4 of an inch).

(added in PxPlus v9.00, build 9200)

Debugging Functionality

Debugging functionality includes the ability to add watch values, set dynamic breakpoints, initiate program tracing, as well as the ability to transfer the contents of the debug window to the Clipboard.

This can be set on the fly using the keyword$ "DebugWindow", which determines the specific functionality based on the associated value$ settings.

Example:

print 'option'("DebugWindow","Trace")
print 'option'("DebugWindow","Host Command Open")
print 'option'("DebugWindow","Watch Add x$")
print 'option'("DebugWindow","Host Break Add Program=C:\Work51\email\send_email.pvx,Statement=10,Change=SMTPSERVER$")

The available DebugWindow value$ settings for enhanced debugging functionality are described by category in the table below.

The Windows version of PxPlus also includes a debugging environment that can be accessed via the PxPlus icon drop-down menu by selecting Debugging Environment. See Windows Debugging Environment.

Break Window Specific

Break Window is used to assign logical break points for halting execution in an application. Can be used in combination with other settings. See Multi-Use Commands.

"Break"

Activate Break window.

Command Window Specific

Command Window is used to handle all console commands without disrupting your standard screen display. Can be used in combination with other settings. See Multi-Use Commands.

"Command"

Activate Command mode window.

"Halt"

Simulate a Command window halt (stop program).

"Step"

Simulate a Command mode window step.

Trace Window Specific

Trace Window is used to trace the execution of an application. Can be used in combination with other settings. See Multi-Use Commands.

"DebugPlus [with] [Backtrace] [Enable|Disable]"

Enable/disable DebugPlus Backtrace option.

"File [IO] [Operation] [Trace] [Enable|Disable]"

Enable/disable file IO operation trace option.

"File Opens [Enable|Disable]"

Enable/disable trace file opens option.

"File Opens [Failures] [Enable|Disable]"

Enable/disable trace file open failures option.

"[Host] Log [All] [Errors] [Enable|Disable]"

Enable logging of errors on the host or local machine.

"Host Trace Programs [Enable|Disable]"

Enable/disable host trace programs option.

"Show [Property] [GET] [Enable|Disable]"

Enable/disable show property GET option.

"Show [Property] [SET] [Enable|Disable]"

Enable/disable show property SET option.

"Size=1k"

Set 1K program trace size.

"Size=2k"

Set 2K program trace size.

"Size=8k"

Set 8K program trace size.

"Size=16k"

Set 16K program trace size.

"Size=32k"

Set 32K program trace size.

"Suppress [Program [Trace [Enable|Disable]]]"

Enable/disable suppress program trace option.

"Trace"

Activate Trace window.

Watch Window Specific

Watch Window allows you to constantly monitor variables and/or expressions during program execution. Can be used in combination with other settings. See Multi-Use Commands.

"Size=0"

Select the no-data-break option.

"Size=50"

Select the 50-byte-data-break option.

"Size=100"

Select the 100-byte-data-break option.

"Size=no"

Select the No-data-break option.

"Watch"

Activate Watch Window.

Multi-Use Commands

 

"Host [Break|Trace|Watch] [Enable|Disable]"

Enable/disable host trace option.

"[Host] [Break|Watch] Add "String to Add"

Add a (pre-formatted) item to the Break|Watch window.

When using the following commands, if the Debug window type is not specified, then the last window used will be utilized:

"[Host] [Break|Command|Trace|Watch] Close"

Close window option.

"[Host] [Break|Command|Trace|Watch] Disable"

Disable window without closing.

"[Host] [Break|Trace|Watch] Clear"

Clear window contents.

"[Host] [Break|Trace|Watch] Copy"

Copy window contents to the Clipboard.

Miscellaneous Debug Options

 

PRINT 'OPTION'("Logfile", filename$)

(Windows Only) Allows setting the Log File name on the fly.

PRINT 'OPTION'("TraceWdwToLogfile", "0"|"1")

Copies all information written to the Trace window to the filename$ specified by the "Logfile" setting. "1" enables the functionality and "0" disables it.