To properly display this page you need a browser with JavaScript support.
The UserButton objects control the customizable buttons of the job (Job configuration, Customizable buttons). Each button is injected in the scripts as UserButton_1 , UserButton_2 ... in the order they are defined, so a script can change their title, tooltip, visibility or enabled state, for example depending on the document type or the Enterprise stage.
Methods
Returns
Method
Description
short
GetEnabled
()
Returns 1 if the button is enabled.
Returns: 0 = disable, 1 = enable
Example
enabled = UserButton.GetEnabled()
string
GetTitle
()
Returns the title of the button.
Returns: Button title
Example
res = UserButton.GetTitle()
short
GetVisible
()
Gets the visivility of a button
Returns:
0: hide
1: show
string
GetWebStyle
()
Gets the button style for enterprise apps
Returns: , btn-default, btn-success, btn-primary, btn-info, btn-warning, btn-danger
ChronoScan Enterprise only.
Example
style = UserButton.GetWebStyle()
void
SetEnabled
(short enabled)
Enables (1) or disables (0) the button.
Example
'Disable the button
Call UserButton.SetEnabled(0)
void
SetTitle
(string newtitle)
Set button title
Parameters
newtitle (string): The new title for the button
Example
Call UserButton.SetTitle("My new title")
void
SetTooltip
(string tooltip)
Set button tooltip
Parameters
tooltip (string): The new tooltip for the button
Example
res = UserButton.SetTooltip("My new tooltip")
void
SetVisible
(short visible)
shows/hides the button
Params:
0: hide
1: show
void
SetWebStyle
(string webstyle)
Set button style for enterprise apps
Parameters
webstyle (string): Style class (bootstrap based)
Allowed values: btn-default, btn-success, btn-primary, btn-info, btn-warning, btn-danger
ChronoScan Enterprise only.
Example
Call UserButton.SetWebStyle("btn-info")
