new DuCheckBox()
Properties:
Name | Type | Description |
---|---|---|
group |
Group | The scriptUI Group containing the label and the image. |
standardImage |
string | The path to the image (or a PNG as a string representation) |
imageOver |
string | The path to the image (or a PNG as a string representation) to display when mouseover |
imageChecked |
string | The path to the image (or a PNG as a string representation) to display when the button is checked |
image |
Image | The scriptui object representing the image, if any |
label |
StaticText | The label, if any |
text |
string | The current text |
textChecked |
string | The text to display when the checkbox is checked |
defaultText |
string | The text to display when the checkbox is unchecked |
checked |
boolean | The checked state of the button |
onClick |
DuCheckBox~onClick | The function to execute when the button is clicked |
Methods
-
static duCheckBox.setChecked(c)
-
Checks or unchecks the button
Parameters:
Name Type Description c
boolean The checked state -
static setChecked(checkedopt)
-
Sets the checked state of the button
Parameters:
Name Type Attributes Default Description checked
boolean <optional>
true The state -
static setHelp(title, text, link)
-
Sets the help information for this button
Parameters:
Name Type Description title
string The title text
string The content link
string A URL to an online help
Type Definitions
-
onClick()
-
The function to execute when the button is clicked.