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 expression.
   
Description The 'OPTION' mnemonic allows specific ProvideX environment properties (typically set via INI entries) to be set at run time (on the fly) within a ProvideX session.
 
Item Colours
The following keyword$ values assign colours to specific characteristics
"BtnFocusHilight" Focus highlight
"BtnHoverHilight" Mouse Over highlight
"BtnFaceClr" Button face colour
"BtnFrameClr" Button/check box/radio button frame colour
"CbxMarkClr" Check mark or 'X' in a check box
"RbtMarkClr" Ball within a radio button
"FrameTextClr" Text in a frame.
The value$ may be assigned as colour names
Black   White   DarkGray   Gray  
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:
"BtnNormTopPct" Lightness applied to face at the top of normal button.
"BtnNormTopClr" Colour for blend at the top of normal button.
"BtnNormMidPct" Lightness applied to face in middle of normal button.
"BtnNormMidClr" Colour for blend at in middle of normal button.
"BtnNormBtmPct" Lightness applied to face at the bottom of normal button.
"BtnNormBtmClr" Colour for blend at the bottom of normal button.
"BtnNormMiddle" Mid point percentage from the top of normal button.
"BtnDownTopPct" Lightness applied to face at the top of pushed button.
"BtnDownTopClr" Colour for blend at the top of pushed button.
"BtnDownMidPct" Lightness applied to face in middle of pushed button.
"BtnDownMidClr" Colour for blend at in middle of pushed button.
"BtnDownBtmPct" Lightness applied to face at the bottom of pushed button.
"BtnDownBtmClr" Colour for blend at the bottom of pushed button.
"BtnDownMiddle" Mid point percentage from the top of pushed button.
"FrameTextClr" Colour of any text used in a frame.
"CtlFrameClr" Colour of lines in a frame.
The following 'Item shading' options are +PxPlus Exclusives
"ClrAutoCompBack" ¹ The Background colour to be used for text in auto complete List boxes. (build 9200)
"ClrAutoCompText" ¹ The Text colour to be used for text in auto complete List boxes. (build 9200)
"ClrDisabledBack" ¹ The Background colour to be used for text in disabled List boxes, Multi-lines, Radio-button text and Check boxes (build 9200)
"ClrDisabledText" ¹ The Text colour to be used for text in disabled List boxes, Multi-lines, Radio-button text and Check boxes (build 9200)
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
For 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.

For 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:
"FONT" Sets the current window’ text plane font.
"STDFONT" Sets the session’ default text plane font.
"GRAPHICFONT" Sets the current window’ default graphic font.
"STDGRAPHICFONT" Sets the session’ default graphic font. If set, this must be prior to drawing any GUI controls.
The value$ indicates the current font specification. Refer to the '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. 

Resource Library
Resource libraries are DLLs that may contain icons and bitmaps for use in an application. The following keyword can be used to change the current resource library:  
"RESOURCELIB" Sets or changes the current resource library.
Colour Index
The 'OPTION' mnemonic can be used to manually set the colour index (COLOUR16 to COLOUR254) to specific RGB values:
"COLOURnnn" Sets colour number nnn.
"COLORnnn" Sets color number nnn.
While the colour index allows numbers 0-254, the first 16 are predefined by ProvideX (0 to 15). The remaining colours must be assigned in order without skipping (i.e., COLOUR16 then COLOUR17 then COLOUR18 ...). 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 (if predefined by ProvideX); e.g.,
PRINT 'OPTION'("Colour64","") ! Clear out index 64 for re-use
PRINT 'OPTION'("Colour7","") ! Reset to the ProvideX 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 options
These options are generic to windows processing and can be applied to channel 0.
TIPTIMERCYCLES Defines the number of seconds that a tip will be displayed (version 8.30)
PDF Bookmarks
Bookmarks (used for selecting and automatically displaying specific pages) can be added to generated PDFs:
"BOOKMARK" Set bookmark location, text, and hierarchy. For more information on bookmarks, see *PDF* - PDF Print Interface.
PxPlus Additional options
The following options are
+PxPlus Exclusive
"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 zero restores the standard adjustment.
"ALWAYSONTOP" ¹ This mnemonic controls 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 that only one window should be locked 'OnTop' as the system will not be able to determine which window is the top most should the windows overlap.
"ANIMATE" ¹ The ANIMATE option allows the application to animate the window generally during the transition from visible to hidden or vice-versa. The 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
"SHAKE" The window will shake left-to-right but remain visible

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.

"BLINKTIME" ¹ The BLINKTIME option is used to control 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. The default rate is "500" milliseconds. (build 9182)
"CENTERWDW" ¹ Center the current window (DIALOGUE) on screen. This mnemonic takes into account multiple monitors and places the window in the center of the monitors currently displaying the window.
"FLASH" ¹ Controls flashing of the frame for the current window and the task bar. (build 9182)
"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)
"FRAME" ¹ Controls the type of frame/border for the current window. Possible values are: (build 9163.1)
"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)
"HIDETIPS" ¹ This option issued 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 value) enables Tips.
"HOVERCTL" ¹ This option issued 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 can be 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.(build 9163.1)
"KEYBOARD" ¹ This option can be sent to channel 0 on a WIndows (or WindX) session to change the current keyboard language. (build 9182)
"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 can be used to create windows of different shapes.(build 9163.1)
"MESSAGEBAR" ¹ This option can be 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 can be 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.(build 9163.1)
"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 1.2).(build 9200)
"PDFFONTDIR" ¹ This option can be used tochange the directory the system will search for true type fonts when creating PDF files. It must be changed before the first open of a PDF file to be effective. (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 value is 250 (1/4 of an inch).(build 9200)
"RMOUSECOPY" ¹ This option enables right mouse click Copy/Paste functionality whenever focus is on the windows 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. (build 9182)
SUPPRESS_FF Sets the file FF suppression settings to one of the following values: (build 9200)
"NO" No FF suppression (default setting)
"ALL" All FF's that occur with no intervening data will be suppressed
"FIRST" If the initial output to the file is an 'FF' is will be suppressed
"LAST" If the final output to the file is an 'FF' is will be suppressed
"BOTH" Same as "FIRST" and "LAST"

NOTE: Setting Channel zero sets the FF suppression option for all files subsequentlly opened.

"TIPFONT" ¹ Setting this option n channel 0 changes the current font attributes of the tip window.
"TOOLBAR" ¹ This option can be used to set the height (in pixels expressed as a string) for the tollbar.
"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.
"UTILITY" ¹ This option can be 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 Equal 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).
"XYPOS" ¹ This option can be 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 move the current window to. These numbers are relative the desktop of the workstation or the current window's parent window. Note: When setting a position, the system will validate the location indicated is visible otherwise the window will be centered on the closest monitor to the position supplied.(build 9163.1)
XYWDW ¹ This option can be 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.(build 9182)
ZORDER¹ If value$ IS 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.(build 9182)
 

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

   
 
PxPlus Additional options
The following *WINPRT* options are
+PxPlus Exclusive
"ORIENTATION" This can be 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.