Class: DuButton

DuButton

For use with DuScriptUI.
An Image Button.
This is not a real class, and cannot be instanciated.
Use DuScriptUI.button to create an Image Button.
The Image Button inherits the Group object from ScriptUI and has all of its properties and methods.

new DuButton()

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 9755
Properties:
Name Type Description
helpLink string A URL to a help page, shown on shift click on the button.
image Image The scriptui object representing the image.
label StaticText The label
optionsPopup DuPopup A popup for .
optionsPanel Group The ScriptUI Group where to add the options (child of the popup).
onClick DuButton~onClick The function to execute when the button is clicked
onAltClick DuButton~onAltClick The function to execute when the button is Alt + clicked
onCtrlClick DuButton~onCtrlClick The function to execute when the button is Ctrl + clicked
onCtrlAltClick DuButton~onCtrlAltClick The function to execute when the button is Ctrl + Alt + clicked
onOptions DuButton~onOptions The function to execute when the options are called (Shift+CLick or click on the options button)

Methods

staticDuButton.setBackgroundColor(color)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 9807
Changes the background color of the button.
Name Type Description
color DuColor the color.

staticDuButton.setTextColor(color)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 9815
Changes the text color of the button.
Name Type Description
color DuColor the color.

Type Definitions

onAltClick()

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 9781
The function to execute when the button is Alt + clicked.

onClick()

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 9775
The function to execute when the button is clicked.

onCtrlAltClick()

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 9793
The function to execute when the button is Ctrl + Alt + clicked.

onCtrlClick()

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 9787
The function to execute when the button is Ctrl + clicked.

onOptions(showUI)

D:/RxLab/src/RxOT/DuAEF/Duik/Duik_API/DuAEF_Duik_api.jsxinc, line 9799
The function to execute when the options are called (Shift+CLick or click on the options button).
Use the showUI parameter to build the options when the button is clicked without showing any UI.
Name Type Description
showUI Boolean This is set to false when the button is clicked: use this parameter to build the options without showing any UI when needed on all button clicks.