Document toolboxDocument toolbox

(8.D.2.5) CheckboxControl

Overview

Checkbox Control

Discussion

The Checkbox Inspector Control sets a module variable to 1 when checked. The variable will be set to 0 when unchecked.

If readonly property is set to true, then the inspector will check the box if the module variable is non-zero.

The modVar property must be set to point to a module variable. See the ParamSet module for more detail on modVar formatting.

Variables

Properties

Name

Type

Default value

Range

Description

modVar

string

none

Unrestricted

The module variable to control, in . format

readonly

int

0

0:1:1

When true, the checkbox will only display the value of a variable. Checked box means a non-zero value

state

int

false

0:1:1

The current state, true or false, of the checkbox

caption

string

checkbox

Unrestricted

A short text string to display above the checkbox

units

string

none

Unrestricted

When not empty, displays units string below the caption

color.text

int

000000

0:1:ffffff

Color of the text

font.name

string

'MS Shell Dlg 2'

Unrestricted

Any available Windows font may be used. All text in the control uses the same font

font.size

int

8

0:

Size in points to use for the font. If the font is too large for the space available, the text will be clipped

font.style

string

normal

normal/italic/bold

Available styles are normal italic and bold

scaletext

int

false

0:1:1

When true, text font size scales with inspector size

border

int

1

0:1:1

When false, the surrounding border is turned off

caption.height

int

3

Unrestricted

The number of vertical lines to reserve for the caption and units strings. When zero, caption is not displayed

color.bgnd

int

f0f0f0

0:1:ffffff

Color of the inspector background

color.border

int

b4b4b4

0:1:ffffff

Color of the inspector border, if shown

scale

float

1.0

0.5:3.0

Specifies the magnification of all parts of the control. Height is computed from scale and other properties and cannot be manually specified

width

int

69

0:

Width in DPI independent units

x

int

none

Unrestricted

Horizontal position of top left in DPI independent units

y

int

none

Unrestricted

Vertical position of top left in DPI independent units