Methods related to ScriptUI
Members
-
staticDuScriptUI.defaultColumnAlignmentArray.<String>
-
The default alignment of children of containers with "column" orientation
- Default Value:
- ["fill","top"]
-
staticDuScriptUI.defaultMarginsint
-
The default margins of containers
- Default Value:
- 2
-
staticDuScriptUI.defaultRowAlignmentArray.<String>
-
The default alignment of children of containers with "row" orientation
- Default Value:
- ["left","center"]
-
staticDuScriptUI.defaultSpacingint
-
The default spacing of containers
- Default Value:
- 2
-
staticDuScriptUI.defaultStackAlignmentArray.<String>
-
The default alignment of children of containers with "stack" orientation
- Default Value:
- ["fill","top"]
-
staticDuScriptUI.IconDuBinary
-
The list of available icons.
Properties:
Name Type Default Description AE_BLUEDuBinary w8_ae_blue AE_ORANGEDuBinary w8_ae_orange BACKDuBinary w12_back BOX_CHECKEDDuBinary w12_box_checked BOX_UNCHECKEDDuBinary w12_box_unchecked BUGDuBinary w16_bug BUG_REPORTDuBinary w12_bugreport CHECKDuBinary w12_check CLOSEDuBinary w12_close DOWNLOADDuBinary w16_download EXPERTDuBinary w16_expert EYE_DROPPERDuBinary w12_eye_dropper EYE_DROPPER_BIGDuBinary w16_eye_dropper FEATUREDuBinary w12_feature FILEDuBinary w12_file FOLDERDuBinary w12_folder GO_TODuBinary w12_goto HEARTDuBinary w12_heart HELPDuBinary w12_help LANGUAGEDuBinary w16_language LANGUAGE_FILEDuBinary w16_language_file LISTDuBinary w16_list MENUDuBinary w12_menu MOREDuBinary w12_more NEXTDuBinary w12_next OPTIONSDuBinary w12_options PINDuBinary w12_pin PINNEDDuBinary w12_pinned PLACEHOLDERDuBinary w16_placeholder PROGRESSDuBinary w320_progress RAINBOX_REDDuBinary w8_rx_red RANDOMDuBinary w16_random RESETDuBinary w12_reset ROOKIEDuBinary w16_rookie RX_PURPLEDuBinary w8_rx_purple SETTINGSDuBinary w12_settings SETTINGS_FILEDuBinary w16_settings_file STANDARDDuBinary w16_standard UPDATEDuBinary w12_update USERDuBinary w16_user -
staticDuScriptUI.progressBar
-
Show this progress bar before long operations with
DuProgressBar.showand DuESF will update it. -
staticDuScriptUI.Stringstring
-
The list of strings used by the UI.
Properties:
Name Type Default Description ABOVEstring Above ABOVE_SHORTstring Ab AE_BLUEstring After Effects Blue AE_BLUE_TIPstring The After Effects highlighting blue AE_ORANGEstring After Effects Orange (CS6) AE_ORANGE_TIPstring The After Effects highlighting orange from good ol'CS6 APPLYstring Apply APPLY_ALLstring Apply all APPLY_SETTINGSstring Apply changes to the settings. APPLY_SETTINGS_ALERTstring You may need to restart the script for all changes to take effect. ARMstring Arm ARTHROPODstring Arthropod BACK_PREVIOUSstring Back BACK_LOCATIONstring Back BACK_LOCATION_SHORTstring Bk BIRDstring Bird BODYstring Body BONEstring Bone BUG_REPORTstring Bug report BUG_REPORT_TIPstring Bug report Tell us what's wrong! CAMERAstring Camera CANCELstring Cancel CALFstring Calf CHARACTERstring Character CHECK_UPDATEstring Check for updates CIRCLEstring Circle CLAWSstring Claws CLOSEstring Close COLOR_HIGHLIGHT_TIPstring Set the highlight color. COPYstring Copy CUSTOMstring Custom CUSTOM_COLOR_TIPstring Select a custom color. CLOSE_SETTINGSstring Close settings DEFAULTstring Default DEV_MODEstring Dev and Debug mode DEV_MODE_TIPstring Use at your own risk! DIGITIGRADEstring Digitigrade EARstring Ear EDITstring Edit EDIT_SETTINGSstring Edit settings EFFECTSstring Effects EXPERTstring Expert EXPERT_UI_TIPstring The smallest UI, for expert users. EXPORT_TRANSLATIONstring Export translation file EXPORT_TRANSLATION_TIPstring Export a translation file to be edited with DuTranslator. EYEstring Eye EYESstring Eyes EYEBROWstring Eye FEATHERstring Feather FEATHERSstring Feathers FEATURE_REQUESTstring Feature request FEATURE_REQUEST_TIPstring Feature request Request something new. FINstring Fin FINGERSstring Fingers FISHstring Fish FISHBONEstring Fishbone FISHBONESstring Fishbones FISH_SPINEstring Fish spine FOOTstring Foot FOREARMstring Forearm FRONTstring Front FRONT_LEGstring Front leg FRONT_SHORTstring Fr GROUPSstring Groups HAIRstring Hair HANDstring Hand HEADstring Head HEELstring Heel HELPstring Help HELP_TIPstring Get help. HIPSstring Hips HOMINOIDstring Hominoid HOOFstring Hoof INVERTstring Invert INVERTEDstring Inverted ISOLATEstring Isolate LANGUAGE_TIPstring Set the language of the interface. LAYERstring Layer LAYERSstring Layers LEFTstring Left LEFT_SHORTstring L LEGstring Leg LIMBstring Limb LOCATION_SHORTstring Loc MAGICstring Magic is happening MASKSstring Masks MIDDLEstring Middle MIDDLE_SHORTstring Md MORE_OPTIONS_TIPstring [Shift]: More options... MOUTHstring Mouth NAMEstring Name NECKstring Neck NEXTstring Next NONEstring None NORMAL_MODEstring Normal mode NOSEstring Normal mode NULL_OBJECTstring Null OKstring OK OPACITYstring Opacity ORIGINALstring Original PATHstring Path PAWstring Paw PENISstring Penis PINCERstring Pincer PLANTIGRADEstring Plantigrade PREVIOUSstring Previous POLYGONstring Polygon POSITIONstring Position PROPERTIESstring Properties RANDOM_TIPstring Set a random value. RECTANGLEstring Rectangle RESET_SETTINGSstring Reset the settings to their default values. RIGHTstring Right RIGHT_SHORTstring R ROOKIEstring Rookie ROOKIE_UI_TIPstring The easiest-to-use mode, but also the biggest UI. ROTATIONstring Rotation ROUNDED_RECTANGLEstring Rounded rectangle RX_PURPLEstring RxLab Purple RX_PURPLE_TIPstring The RxLaboratory Purple RX_REDstring Rainbox Red RX_RED_TIPstring The Rainbox Productions Red SCALEstring Scale SELECT_LAYERSstring Select layers SELECT_GROUPSstring Select groups SET_QUALITYstring Set quality SETTINGSstring Settings SETTINGS_FILEstring Settings file SETTINGS_FILE_TIPstring Set the location of the settings file. SHOULDERstring Shoulder SHOULDERSstring Shoulders SHOULDERS_AND_NECKstring Shoulders & neck SIDEstring Side SIZEstring Size SNAKEstring Snake SPINEstring Spine STANDARDstring Standard STANDARD_UI_TIPstring The standard not-too-big UI. TAILstring Tail TAIL_SHORTstring Tl THIGHstring Thigh TIMELINEstring Timeline TIP_BONEstring Tip TRANSFORMstring Transform TOESstring Toes TYPEstring Type UI_MODE_TIPstring Select the UI mode. UNDERstring Under UNDER_SHORTstring Un UNGULATEstring Ungulate VULVAstring Vulva WINGstring Wing WORKINGstring Working... X_POSITIONstring X Position Y_POSITIONstring Y Position
Methods
-
staticDuScriptUI.addBugButton(container, showLabel){DuButton}
D:/DEV_SRC/RxOT/DuPSF/tools/output/DuPSF.jsxinc, line 9393 -
Creates a button opening the bug report url.
Name Type Default Description containerPanel | Window | Group The ScriptUI Object which will contain and display the button. showLabelbool false optional When true, the button includes a "Bug Report" label. Returns:
Type Description DuButton The bug button created. -
staticDuScriptUI.addDonateButton(container, showLabel){DuButton}
D:/DEV_SRC/RxOT/DuPSF/tools/output/DuPSF.jsxinc, line 9491 -
Creates a button opening the link for like/follow/donation
Name Type Default Description containerPanel | Window | Group The ScriptUI Object which will contain and display the button. showLabelbool false optional When true, the button includes a "I ♥ " + DuESF.scriptNamelabel.Returns:
Type Description DuButton The like button created. -
staticDuScriptUI.addEvent(func, timeOut){int}
D:/DEV_SRC/RxOT/DuPSF/tools/output/DuPSF.jsxinc, line 12150 -
Adds a function to be run periodically, which will be connected to several UI events, fired when the user interacts with the UI.
Name Type Default Description funcfunction The function to connect to the UI timeOutint 3000 optional A timeOut in milliseconds which prevents the function to be run too often Returns:
Type Description int a unique identifier to be used to remove the function later, with DuScriptUI.removeEvent. -
staticDuScriptUI.addFeatureRequestButton(container, showLabel){DuButton}
D:/DEV_SRC/RxOT/DuPSF/tools/output/DuPSF.jsxinc, line 9425 -
Creates a button opening the feature request url.
Name Type Default Description containerPanel | Window | Group The ScriptUI Object which will contain and display the button. showLabelbool false optional When true, the button includes a "Feature Request" label. Returns:
Type Description DuButton The feature request button created. -
staticDuScriptUI.addHelpButton(container, showLabel){DuButton}
D:/DEV_SRC/RxOT/DuPSF/tools/output/DuPSF.jsxinc, line 9457 -
Creates a button opening the help panel.
Name Type Default Description containerPanel | Window | Group The ScriptUI Object which will contain and display the button. showLabelbool false optional When true, the button includes a "Help" label. Returns:
Type Description DuButton The help button created. -
staticDuScriptUI.askLanguage(callback, ui)
D:/DEV_SRC/RxOT/DuPSF/tools/output/DuPSF.jsxinc, line 9528 -
Displays a prompt to select the language of the script.
Won't do nothing if the script already has a language set in the settings.
Use this method before launching the script.Name Type Description callbackfunction The function to execute when the user has chosen the language.
This function should be the one which loads the script.uiPanel | Window optional A container to display the UI. A modal Dialog is created if omitted -
staticDuScriptUI.buildAllTabs()
D:/DEV_SRC/RxOT/DuPSF/tools/output/DuPSF.jsxinc, line 11627 -
Builds all the tabs from all the tab panels
-
staticDuScriptUI.button(container, text, image, helpTip, addOptionsPanel, orientation, alignment, localize, ignoreUIMode, optionsWithoutButton){DuButton}
D:/DEV_SRC/RxOT/DuPSF/tools/output/DuPSF.jsxinc, line 8962 -
Creates a button with an optionnal icon. Must have at least an icon or a text, or both.
Name Type Default Description containerPanel | Window | Group The ScriptUI Object which will contain and display the button. textstring optional The label of the button. Default: empty string imagestring | DuBInary optional The path to the icon (or a PNG as a string representation). Default: empty string helpTipstring optional The helptip. Default: empty string addOptionsPanelbool false optional Adds a panel for options and a button to access it. orientationbool 'row' optional The orientation of the button (icon, text, options button). Default will be changed to 'column' if there's no text. alignmentbool 'left' optional The alignment of the button content ('center', 'right' or 'left' for 'row', 'top' 'bottom', 'center' for column). localizeBoolean true optional Set to false if the text must not be translated. ignoreUIModeBoolean false optional Will show texte even if the ui mode is set to > 1 in the script settings optionsWithoutButtonBoolean false optional Don't add an "ok" button to the options popup Returns:
Type Description DuButton The image button created. -
staticDuScriptUI.checkBox(container, text, image, helpTip, textChecked, imageChecked, orientation){DuCheckBox}
D:/DEV_SRC/RxOT/DuPSF/tools/output/DuPSF.jsxinc, line 9971 -
Creates a checkbox with an optionnal icon. Must have at least an icon or a text, or both.
Name Type Default Description containerPanel | Window | Group The ScriptUI Object which will contain and display the button. textstring The label of the button. Default: empty string imagestring | DuBinary optional The path to the icon. Default: empty string helpTipstring '' optional The helptip. Default: empty string textCheckedstring text optional The label of the button displayed when it is checked. imageCheckedstring | DuBinary optional The image to show when it is checked orientationstring 'row' optional The orientation Returns:
Type Description DuCheckBox The checkbox created. -
staticDuScriptUI.checkUpdate(callback, ui, showAlert)
D:/DEV_SRC/RxOT/DuPSF/tools/output/DuPSF.jsxinc, line 9602 -
Checks if the script can be updated
Name Type Description callbackfunction optional The function to execute when the user has clicked on the "dismiss" button. uiPanel | Window optional A container to display the UI. A modal Dialog is created if omitted showAlertBoolean optional Whether to show an alert if the check failed or if the version is up-to-date. -
staticDuScriptUI.colorSelector(container, helpTip){DuColorSelector}
D:/DEV_SRC/RxOT/DuPSF/tools/output/DuPSF.jsxinc, line 11701 -
Creates a new color selector and adds it to the container
Name Type Description containerWindow | Panel | Group helpTipstring optional The help tip to show on the selector Returns:
Type Description DuColorSelector -
staticDuScriptUI.editText(container, text, prefix, suffix, placeHolder, helpTip, translatable){DuEditText}
D:/DEV_SRC/RxOT/DuPSF/tools/output/DuPSF.jsxinc, line 10742 -
Creates a nice edittext where the edit text is shown only on click.
Name Type Default Description containerWindow | Panel | Group The ScriptUI Object which will contain and display the nice edit text. textstring The initial text in the edit. prefixstring "" optional A text prefix to display. suffixstring "" optional A text suffix to display. placeHolderstring "" optional A place holder default text. helpTipstring "" optional The helpTip of this control translatablebool true optional Whether to translate the texts of this control Returns:
Type Description DuEditText The custom Group containing the edit text. -
staticDuScriptUI.fileSelector(container, text, textField, helpTip, image, mode, orientation){DuFileSelector}
D:/DEV_SRC/RxOT/DuPSF/tools/output/DuPSF.jsxinc, line 11033 -
Creates a file selector with a field for the path and a browse button.
Name Type Default Description containerWindow | Panel | Group The ScriptUI Object which will contain and display the panel. textstring "Browse..." optional The text to display on the button. textFieldboolean true optional Whether to show the text field for the path. helpTipstring '' optional The helptip for this control. imagestring | DuBinary optional The image to use as an icon; a "file" icon by default. modestring 'open' optional The open mode, either 'open' or 'save'. orientationstring 'row' optional The orientation of the control (button+edittext). Returns:
Type Description DuFileSelector The control. -
staticDuScriptUI.folderSelector(container, text, textField, helpTip, orientation){DuFolderSelector}
D:/DEV_SRC/RxOT/DuPSF/tools/output/DuPSF.jsxinc, line 10935 -
Creates a folder selector with a field for the path and a browse button
Name Type Default Description containerWindow | Panel | Group The ScriptUI Object which will contain and display the panel. textstring "Browse..." optional The text to display on the button. textFieldboolean true optional Whether to show the text field for the path. helpTipstring '' optional The helptip for this control. orientationstring 'row' optional The orientation of the control (button+edittext). Returns:
Type Description DuFolderSelector The control. -
staticDuScriptUI.form(container){Form}
D:/DEV_SRC/RxOT/DuPSF/tools/output/DuPSF.jsxinc, line 11355 -
Creates a layout to add forms to a UI, using ScriptUI groups.
You can easily add controls/fields to this form using DuScriptUI.addFieldName Type Description containerWindow | Panel | Group The ScriptUI Object which will contain and display the form. Returns:
Type Description Form The custom Group containing the form. -
staticDuScriptUI.getClosestScreen(location){Object}
D:/DEV_SRC/RxOT/DuPSF/tools/output/DuPSF.jsxinc, line 10343 -
Gets the corners of the screen the closest to (or containing) the location
Name Type Description locationArray.<int> The coordinates Returns:
Type Description Object The screen object with a top, left, right and bottom property. -
staticDuScriptUI.group(container, orientation){Group}
D:/DEV_SRC/RxOT/DuPSF/tools/output/DuPSF.jsxinc, line 9835 -
Adds a group in a container, using DuScriptUI default alignments, and DuScriptUI.defaultSpacing. Margins are set to 0.
Name Type Description containerPanel | Window | Group Where to create the group orientationstring optional The orientation to use. One of "column", "row" or "stack". By default, "column" if added in a row, "row" if added in a column. Returns:
Type Description Group The group created -
staticDuScriptUI.layout(item, force)
D:/DEV_SRC/RxOT/DuPSF/tools/output/DuPSF.jsxinc, line 9780 -
Resets the layout of the whole ui containing a scriptUI item.
Name Type Description itemScriptUI The ScriptUI element which needs to be resized forceBoolean optional Needs to be true if you need to layout before DuESF.stateisDuESF.State.RUNTIME.
That should be the case only for the main UI; Note that you should not need it anyway,DuScriptUI.showUIdoes that for you. -
staticDuScriptUI.mainPanel(container, scriptName, contentAlignment, borderless){DuPanel}
D:/DEV_SRC/RxOT/DuPSF/tools/output/DuPSF.jsxinc, line 7871 -
Creates the main panel for a script
Name Type Default Description containerPanel | null The container ('this' in the root of the calling script), either a Panel (when launched from the 'Window' menu) or null (when launched from 'file/scripts/run...') scriptNamestring DuESF.scriptName optional A name for this UI contentAlignmentArray.<string> DuScriptUI.defaultColumnAlignment optional The alignment of the content in the panel borderlessstring false optional When true, creates a borderless window if container is not a panel Returns:
Type Description DuPanel The panel created, either a ScriptUI Panel or a ScriptUI Window. Example
var ui = DuScriptUI.mainPanel(this,"Test Script"); var refreshButton = ui.content.add('button',undefined,"Refresh"); refreshButton.onClick = function() { ui.refreshUI( new File($.fileName) ); }; //reloads the current script DuScriptUI.showUI(ui); -
staticDuScriptUI.moveInsideScreen(location, size){Array.<int>}
D:/DEV_SRC/RxOT/DuPSF/tools/output/DuPSF.jsxinc, line 10321 -
Moves the coordinates so that the size completely fits inside an existing screen
Name Type Description locationArray.<int> The coordinates [top, left] sizeDimension The rectangle size, an object which has two properties: width and height Returns:
Type Description Array.<int> the new location -
staticDuScriptUI.multiButton(container, text, image, helpTip, ignoreUIMode){DuSelector}
D:/DEV_SRC/RxOT/DuPSF/tools/output/DuPSF.jsxinc, line 11793 -
Creates a multi button popup
Name Type Default Description containerWindow | Panel | Group The ScriptUI Object which will contain and display the multi button. textstring optional The text. imagestring | DuBInary optional The path to the icon (or a PNG as a string representation). Default: empty string helpTipstring optional The help tip to show on the multi button ignoreUIModeBoolean false optional Will show texte even if the ui mode is set to > 1 in the script settings Returns:
Type Description DuSelector - The multiButton -
staticDuScriptUI.popUp(title, alignment, modal){DuPopup}
D:/DEV_SRC/RxOT/DuPSF/tools/output/DuPSF.jsxinc, line 8016 -
Creates a borderless popup
Name Type Default Description titlestring The title of the popup alignmentArray.<string> [ "fill", "top" ] optional The alignement of this window modalboolean false optional Set the popup to a modal dialog Returns:
Type Description DuPopup The popup, a ScriptUI Window which is borderless, with a 'tieTo(control)' method. Example
var popup = DuScriptUI.popUp( ); var popupButton = DuScriptUI.button( myUI, "My Buttton for the popup" ); popup.tieTo( popupButton ); // will show the popup when the button is clicked, just above it. -
staticDuScriptUI.removeEvent(id)
D:/DEV_SRC/RxOT/DuPSF/tools/output/DuPSF.jsxinc, line 12164 -
Removes a function previously added with
DuScriptUI.addEvent.Name Type Description idint The id of the function -
staticDuScriptUI.scriptPanel(container, addSettingsButton, addHelpButton, scriptFile){DuScriptPanel}
D:/DEV_SRC/RxOT/DuPSF/tools/output/DuPSF.jsxinc, line 8348 -
Creates the main panel of a script
Name Type Default Description containerPanel | null The container ('this' in the root of the calling script), either a Panel (when launched from the 'Window' menu) or null (when launched from 'file/scripts/run...') addSettingsButtonbool true optional Whether to create a button to open the settings or not addHelpButtonbool false optional Whether to create a button to open the help panel or not scriptFileFile optional The main script file, needed for the refresh button in debug mode Returns:
Type Description DuScriptPanel The panel created, either a ScriptUI Panel or a ScriptUI Window. Example
var ui = DuScriptUI.mainPanel(this,"Test Script"); var refreshButton = ui.content.add('button',undefined,"Refresh"); refreshButton.onClick = function() { ui.refreshUI( new File($.fileName) ); }; //reloads the current script DuScriptUI.showUI(ui); -
staticDuScriptUI.selector(container, helpTip){DuSelector}
D:/DEV_SRC/RxOT/DuPSF/tools/output/DuPSF.jsxinc, line 10456 -
Creates a drop down selector, using image buttons
Name Type Description containerWindow | Panel | Group The ScriptUI Object which will contain and display the selector. helpTipstring optional The help tip to show on the selector Returns:
Type Description DuSelector - The selector -
staticDuScriptUI.separator(container, name, checkable, drawLine, translatable){DuSeparator}
D:/DEV_SRC/RxOT/DuPSF/tools/output/DuPSF.jsxinc, line 9881 -
Adds separator with an optionnal name in the group
Name Type Default Description containerPanel | Window | Group Where to create the separator namestring optional The name displayed checkableboolean false optional When true, adds a checkbox to the separator drawLineboolean true optional Draws a line when there is no name. When false, the separator is an empty space translatableboolean true optional If false, the name won't be translated Returns:
Type Description DuSeparator The separator -
staticDuScriptUI.setBackgroundColor(uiItem, color, adjusted)
D:/DEV_SRC/RxOT/DuPSF/tools/output/DuPSF.jsxinc, line 9813 -
Changes the color of the background of a ScriptUI Object
Name Type Default Description uiItemScriptUI The ScriptUI Object colorArray The new color [R,V,B,A] Array adjustedBoolean true optional lightens the color if the brightness setting of Ae is not set on the darkest one -
staticDuScriptUI.setTextColor(text, color, adjusted)
D:/DEV_SRC/RxOT/DuPSF/tools/output/DuPSF.jsxinc, line 9794 -
Changes the color of the text of a ScriptUI Object
Name Type Default Description textScriptUI The ScriptUI Object colorDuColor The new color adjustedBoolean false optional lightens the color if the brightness setting of Ae is not set on the darkest one -
staticDuScriptUI.showUI(ui, enterRunTime)
D:/DEV_SRC/RxOT/DuPSF/tools/output/DuPSF.jsxinc, line 8258 -
Resizes and shows the main panel of a script
Name Type Default Description uiPanel | Window The UI created by Duik.ui.createUI enterRunTimeboolean false optional Set to true to automatically set DuESF to runtime state
Set this to false if the ui shown is not the actual main panel of the script and it is shown before the main panel has been loaded. -
staticDuScriptUI.slider(container, defaultValue, min, max, orientation, invertedAppearance, prefix, suffix, textAlignment, valueButtons){DuSlider}
D:/DEV_SRC/RxOT/DuPSF/tools/output/DuPSF.jsxinc, line 11185 -
Creates a slider.
Name Type Default Description containerWindow | Panel | Group The ScriptUI Object which will contain and display the nice edit text. defaultValueint 0 optional The initial value. minint 0 optional The minimal value. maxint 100 optional The maximal value. orientationstring 'column' optional Either 'row' or 'column' invertedAppearanceboolean optional Revert the slider with max value on the left prefixstring optional A text prefix to display. suffixstring optional A text suffix to display. textAlignmentstring 'center' optional The alignment of the text.
One of 'left', 'center', 'right' for column orientation,
And 'top', 'center', 'bottom' for row orientation.valueButtonsArray.<int> [] optional A list of predefined values to add as buttons. - TODO
-
- implement helpTip
Returns:
Type Description DuSlider The custom Group containing the slider. -
staticDuScriptUI.smallbutton(container, text, helpTip, value){DuButton}
D:/DEV_SRC/RxOT/DuPSF/tools/output/DuPSF.jsxinc, line 9265 -
Creates a small button.
Name Type Description containerPanel | Window | Group The ScriptUI Object which will contain and display the button. textstring The label of the button. Default: empty string helpTipstring optional The helptip. Default: empty string valueany optional A user value stored in the button, which is passed to the onClick method Returns:
Type Description DuButton The image button created. -
staticDuScriptUI.staticText(container, text, color, translatable, multiline){StaticText}
D:/DEV_SRC/RxOT/DuPSF/tools/output/DuPSF.jsxinc, line 10880 -
Creates a statictext (with an optionnal color).
Name Type Default Description containerWindow | Panel | Group The ScriptUI Object which will contain and display the nice edit text. textstring The initial text in the edit. colorDuColor optional The color of the text. By default, uses a slightly darker text than the Host App text color translatablebool true optional Set this to false to never translate this text. multilinebool optional Set this to true to add a multiline text. Auto detected by default if the text contains the newline character. Returns:
Type Description StaticText The ScriptUI StaticText created. -
staticDuScriptUI.stringPrompt(title, defaultString){DuPopup}
D:/DEV_SRC/RxOT/DuPSF/tools/output/DuPSF.jsxinc, line 8832 -
Creates a popup to ask for a simple string
Name Type Description titlestring The title of the popup defaultStringstring The placeholder for the edit text Returns:
Type Description DuPopup The popup, with an onAccept( str )callback. -
staticDuScriptUI.tabPanel(container, tabOrientation){DuTabPanel}
D:/DEV_SRC/RxOT/DuPSF/tools/output/DuPSF.jsxinc, line 11495 -
Creates a panel with tabs
Name Type Description containerWindow | Panel | Group The ScriptUI Object which will contain and display the panel. tabOrientationstring The orientation to use for tab buttons. Returns:
Type Description DuTabPanel The panel. -
staticDuScriptUI.toolBar(container){Group}
D:/DEV_SRC/RxOT/DuPSF/tools/output/DuPSF.jsxinc, line 12097 -
Creates a toolbar with a lighter background
Name Type Description containerPanel | Window | Group The ScriptUI Object which will contain and display the toolbar. Returns:
Type Description Group The toolbar, a ScriptUI Group -
staticDuScriptUI.versionButton(container, image){DuButton}
D:/DEV_SRC/RxOT/DuPSF/tools/output/DuPSF.jsxinc, line 9362 -
Creates a button displaying the version of the script and redirecting to the about url.
Name Type Default Description containerPanel | Window | Group The ScriptUI Object which will contain and display the button. imagestring | DuBinary DuESF.scriptIcon optional The path to the icon or a png binstring. Default: empty string Returns:
Type Description DuButton The version button created.