Description: This statement alters the options on a window once it has been opened.
Returns: Nothing
Usage: Script or Steady State
Format: WindowOptions(Object, Option, OptValue);
Or
WindowOptions(Object, 15, Width, Height);
Parameters: Object { Object value } { required } { no default: }
Any expression that returns the object value of any module instance drawn in the window.
Option { numeric } { required } { no default: }
Any numeric expression that specifies which option for the window to alter.
|
Option |
Attribute to alter |
|
0 |
Visibility of the window |
|
1 |
Horizontal scroll line step size |
|
2 |
Horizontal scroll page step size |
|
3 |
Vertical scroll line step size |
|
4 |
Vertical scroll page step size |
|
5 |
Set Horizontal Scroll position |
|
6 |
Set Vertical Scroll position |
|
7 |
Locator reporting rate from the VIC is accelerated. Typically this would be used when fast, dynamic feedback of mouse movement from the VIC is required for a rapid, interactive response. CAUTION: Unnecessary use of this option can seriously degrade the VTS window update rate on the VIC. |
|
8 |
Locator reporting rate from the VIC is returned to normal. Locator position reports are only sent when the VIC considers them significant. This is the default mode of operation. |
|
9 |
Sets the level of alpha-blending (window translucency) of the window. OptValue determines the level of alpha-blending from 0 (completely transparent) to 255 (completely opaque). An OptValue of 128 would give 50 percent translucency. |
|
10 |
Set background color of tooltips |
|
11 |
Set tooltips text color |
|
12 |
Set tooltips show delay |
|
13 |
Set tooltips show duration. This value is limited by the operating system to less than 33 seconds. |
|
14 |
Set tooltips neighbor re-show delay |
|
15 |
Sets the minimum window width and height, using two option value parameters instead of one, e.g. WindowOptions(Self(), 15, Width, Height); |
|
100 |
Set vertical scroll position |
OptValue { numeric } { required } { no default: }
Any numeric expression that specifies the value to set the given option to.
For an Option of 0 (visibility), OptValue produces the following effects:
|
OptValue |
Effect |
|
0 |
Activate and display in current position |
|
1 |
Bring to foreground without activating |
|
2 |
Maximize and activate |
|
3 |
Minimize; deactivate if active |
|
4 |
Hide |
Width { numeric } { required } { no default: }
Used when the Option value is 15. Sets the minimum window width
Height { numeric } { required } { no default: }
Must be present and valid when the Option value is 15. Sets the minimum window height.
Comments: This statement will alter the attributes of the window as it is running. The values that the given options can be set to are from -32763 to 32763.
When the option value is set to 15, the function requires four parameters, all of which must be valid. The last two set the minimum width and height
Example:
If MatchKeys(2, "I");
[
WindowOptions(Self(), 0, 3);
]
If an "I" is pressed on the keyboard, the window that this module is running in will be minimized (turned into an icon).
If ZButton(10, 50, 110, 80, "SetSize", 2, \System\DefFont);
[
WindowOptions(Self(), 15, 200, 150);
]
If ZButton(10, 90, 110, 120, "ClearSize", 3, \System\DefFont);
[
WindowOptions(Self(), 15, 0, 0);
]
See Also: