GUI Composer Widgets And Properties

Overview[edit]

GUI Composer projects support various widgets and allow these widgets to bind to variables defined in CCS projects. This page provides a summary of the widgets supported by GUI Composer projects and describes how to bind these widgets to variables defined in CCS projects.

Add widgets [edit]

When developing GUI Composer projects, all widgets supported by GUI Composer are listed on the left hand side of the GUI Composer Application Designer. See Create Application on how to create GUI Composer applications.

View/Edit Widget Properties [edit]

To view the properties of an individual widget in a GUI Composer project, click on the widget and the corresponding properties will be shown on the right hand side of the GUI Composer view. Users can modify any of these properties.

View/Edit Widget Layout [edit]

To change the size and location of a widget, modify the Layout properties and/or the Widget Specific properties.

To change the background colour of a widget, modify the Background properties.

To change the font and text of a widget, modify the Fonts and Text properties.

Widget Binding [edit]

The GUI Composer widgets can be bound to variables defined in CCS projects. To add a variable binding to a widget, add the variable name in the Widget Binding properties. If only the variable name is specified in the Widget Binding property, the widget is bound to the current active debug context. To bind the widget to a variable in a specific debug context, specify value:pm.cpus['<debug context>'].<variable name> where <debug context> is replaced by the name of the debug context and <variable name> is replaced the name of the variable.

GUI Composer Runtime ships with a set of binding examples on how to bind the widgets to variables. The examples are located in the GCInstallRoot\guicomposer\binding_examples directory.

To install the GUI Composer Runtime, please refer to the Getting Started section

GUI Composer Widgets[edit]

Button[edit]

The Button widget maybe used to execute a javascript function when clicked on. It can be configured in widget properties. To write a specific value to a target variable, please use ValueButton widget

Widget Binding Properties[edit]

Label: Optional: Specify the global target program string variable that will be used to populate the label of the button. Leave blank if statically providing button label at design time.

Disabled: Optional: Specify a global target program variable that will specify whether the widget should be disabled. Non zero value mean widget will be disabled, value of 0 will enable the widget.

Visible: Optional: Specify a global target program variable that will determine whether widget is visible or hidden. Value of 0 will hide the widget. Default is visible.

Read Only: Optional: Specify a global target program variable that will determine whether the widget is read only. Target variable value of 1 will make widget read only.

Tooltip: Optional: Specify a global string variable that can be used to dynamically provide tooltip string. If you do not require for tooltip to change, then please use tooltip property in Widget Properties.

Widget Specific Properties[edit]

Type: no description

Name: no description

alt: no description

Value: no description

Tab Index: no description

intermediateChanges: no description

Label: Specify the text to be display as the label of the button.

Show Label: Specify whether to show or hidd the label of the button.

Icon Class: no description

scrollOnFocus: On focus, should this widget scroll into view?

Disabled: Specify whether the widget should be disabled.

Visible: Specify whether widget is visible or hidden.

Read Only: Specify whether the widget is read only.

Tooltip: Static text to display in tooltip popup.

CheckBox[edit]

The CheckBox button may be used to control and show a boolean state of a target variable.

Widget Binding Properties[edit]

Checked: Required: Specify a global target program boolean variable that the checked state of the button is bound to.

Label: checkbox label

Disabled: Optional: Specify a global target program variable that will specify whether the widget should be disabled. Non zero value mean widget will be disabled, value of 0 will enable the widget.

Visible: Optional: Specify a global target program variable that will determine whether widget is visible or hidden. Value of 0 will hide the widget. Default is visible.

Read Only: Optional: Specify a global target program variable that will determine whether the widget is read only. Target variable value of 1 will make widget read only.

Tooltip: Optional: Specify a global string variable that can be used to dynamically provide tooltip string. If you do not require for tooltip to change, then please use tooltip property in Widget Properties.

Widget Specific Properties[edit]

type: no description

Name: no description

alt: no description

Value: no description

Tab Index: no description

intermediateChanges: no description

Label: checkbox label

showLabel: no description

iconClass: no description

Checked: Specify the initial state of the button.

scrollOnFocus: On focus, should this widget scroll into view?

Disabled: Specify whether the widget should be disabled.

Visible: Specify whether widget is visible or hidden.

Read Only: Specify whether the widget is read only.

Tooltip: Static text to display in tooltip popup.

CheckBoxGroup[edit]

Check Box Group may be used to display and control an array of boolean options. This control is useful when a set of options is related.

Widget Binding Properties[edit]

Labels: Optional: Specify a global target variable with the type of String Array (i.e. String[]) to bind to. Each value in the array represents the label of the each checkbox button. Leave blank if providing labels at design time.

Checked States: Required: Specify a global target variable with the type of Boolean Array (i.e. Boolean[]) to bind to. Each value in the array represents the checked state of each checkbox button.

Disabled: Optional: Specify a global target program variable that will specify whether the widget should be disabled. Non zero value mean widget will be disabled, value of 0 will enable the widget.

Visible: Optional: Specify a global target program variable that will determine whether widget is visible or hidden. Value of 0 will hide the widget. Default is visible.

Read Only: Optional: Specify a global target program variable that will determine whether the widget is read only. Target variable value of 1 will make widget read only.

Tooltip: Optional: Specify a global string variable that can be used to dynamically provide tooltip string. If you do not require for tooltip to change, then please use tooltip property in Widget Properties.

Widget Specific Properties[edit]

Name: no description

alt: no description

Tab Index: no description

intermediateChanges: no description

label: no description

iconClass: no description

scrollOnFocus: On focus, should this widget scroll into view?

Labels: Static labels for Checkboxes in this group.

Checked States: Static values to assign to each checkbox in the group.

Disabled: Specify whether the widget should be disabled.

Visible: Specify whether widget is visible or hidden.

Read Only: Specify whether the widget is read only.

Tooltip: Static text to display in tooltip popup.

CheckedListBox[edit]

The CheckedMultiSelect widget is an exact replacement for the HTML SELECT element and was created to provide a thin widget wrapper that provides the ability to select multiple items. You provide a list of acceptable value pairs consisting of text to be displayed and the hidden text value to be submitted with a FORM.

Widget Binding Properties[edit]

Labels: Optional: Specify a global target program string array variable that the labels of the items are bound to.

Values: Optional: Specify a global target program string array variable that the values of the items are bound to.

Selected Value: sum of selected value

Disabled: Optional: Specify a global target program variable that will specify whether the widget should be disabled. Non zero value mean widget will be disabled, value of 0 will enable the widget.

Visible: Optional: Specify a global target program variable that will determine whether widget is visible or hidden. Value of 0 will hide the widget. Default is visible.

Read Only: Optional: Specify a global target program variable that will determine whether the widget is read only. Target variable value of 1 will make widget read only.

Tooltip: Optional: Specify a global string variable that can be used to dynamically provide tooltip string. If you do not require for tooltip to change, then please use tooltip property in Widget Properties.

Widget Specific Properties[edit]

type: no description

Name: no description

alt: no description

Tab Index: no description

intermediateChanges: no description

Multiple Selection: no description

Disabled: Specify whether the widget should be disabled.

Visible: Specify whether widget is visible or hidden.

Read Only: Specify whether the widget is read only.

Tooltip: Static text to display in tooltip popup.

Sort: sort option

Labels: Optional: Specify a global target program string array variable that the labels of the items are bound to.

Values: Optional: Specify a global target program string array variable that the values of the items are bound to.

ComboBox[edit]

ComboBox widget maybe used to allow selection of a single item from a list.

Widget Binding Properties[edit]

Labels: Optional: Specify a global target program string array that will provide labels for selections. If labels will be statically provided at design time then please leave this field blank.

Value: Required: one of value or index. Specify a global target program variable that will hold the value of the current selection.e.g. if selection box has three choices one, two, three, then variable in this field will be set to literal selection.

Disabled: Optional: Specify a global target program variable that will specify whether the widget should be disabled. Non zero value mean widget will be disabled, value of 0 will enable the widget.

Visible: Optional: Specify a global target program variable that will determine whether widget is visible or hidden. Value of 0 will hide the widget. Default is visible.

Read Only: Optional: Specify a global target program variable that will determine whether the widget is read only. Target variable value of 1 will make widget read only.

Tooltip: Optional: Specify a global string variable that can be used to dynamically provide tooltip string. If you do not require for tooltip to change, then please use tooltip property in Widget Properties.

Widget Specific Properties[edit]

Type: no description

Name: no description

Value: no description

Tab Index: no description

Intermediate Changes: no description

trim: no description

propercase: no description

Max Length: no description

Required: no description

Invalid Message: no description

Constraints: no description

Validating Regular Expression: no description

Auto Complete: no description

highlightMatch: One of: "first", "all" or "none". If the ComboBox/FilteringSelect opens with the search results and the searched string can be found, it will be highlighted. If set to "all" then will probably want to change queryExpr parameter to '*${0}*' Highlighting is only performed when labelType is "text", so as to not interfere with any HTML markup an HTML label might contain.

maxHeight: The max height for our dropdown. Set to 0 for no max height. any dropdown taller than this will have scrollbars

DropDown Position: popup positin

Button Position: button positin

Rotate Degree: Rotate Degree

Disabled: Specify whether the widget should be disabled.

Visible: Specify whether widget is visible or hidden.

Read Only: Specify whether the widget is read only.

Tooltip: Static text to display in tooltip popup.

Labels: Optional: Specify a global target program string array that will provide labels for selections. If labels will be statically provided at design time then please leave this field blank.

Sort: sort option

Container[edit]

HTML block container.

Widget Binding Properties[edit]

Disabled: Optional: Specify a global target program variable that will specify whether the widget should be disabled. Non zero value mean widget will be disabled, value of 0 will enable the widget.

Visible: Optional: Specify a global target program variable that will determine whether widget is visible or hidden. Value of 0 will hide the widget. Default is visible.

Read Only: Optional: Specify a global target program variable that will determine whether the widget is read only. Target variable value of 1 will make widget read only.

Tooltip: popup help information

Widget Specific Properties[edit]

Disabled: Specify whether the widget should be disabled.

Visible: Specify whether widget is visible or hidden.

Read Only: Specify whether the widget is read only.

Tooltip: popup help information

ContentPane[edit]

The ContentPane widget is useful when adding a new tab to page that contains tab widget.

Widget Binding Properties[edit]

Disabled: Optional: Specify a global target program variable that will specify whether the widget should be disabled. Non zero value mean widget will be disabled, value of 0 will enable the widget.

Visible: Optional: Specify a global target program variable that will determine whether widget is visible or hidden. Value of 0 will hide the widget. Default is visible.

Read Only: Optional: Specify a global target program variable that will determine whether the widget is read only. Target variable value of 1 will make widget read only.

Tooltip: Optional: Specify a global string variable that can be used to dynamically provide tooltip string. If you do not require for tooltip to change, then please use tooltip property in Widget Properties.

Widget Specific Properties[edit]

URL: no description

Extract Content: no description

Parse On Load: no description

Prevent Cache: no description

Preload: no description

Refresh On Show: no description

doLayout: no description

isContainer: Just a flag indicating that this widget will call resize() on its children. _LayoutWidget based widgets check for if(!this.getParent || !this.getParent()){ and if getParent() returns false because !parent.isContainer, then they resize themselves on initialization.

Disabled: Specify whether the widget should be disabled.

Visible: Specify whether widget is visible or hidden.

Read Only: Specify whether the widget is read only.

Tooltip: Static text to display in tooltip popup.

DropDownSelect[edit]

The DropDownSelect widget is a representation of a button with an arrow to show a drop down menu.

Widget Binding Properties[edit]

Labels: Optional: Specify a global target program string array that will provide labels for selections. If labels will be statically provided at design time then please leave this field blank.

Values: Optional: Specify a global target program string array that will provide Values for selections. if not provided, value will be same as label

Selected Value: Required: one of value or index. Specify a global target program variable that will hold the value of the current selection.e.g. if selection box has three choices one, two, three, then variable in this field will be set to literal selection.

Selected Index: Required: one of value or index. Specify a global target program variable that will hold the index of the current selection. e.g. if selection box has three choices one, two, three, then variable in this field will be set to index of selection, if two is selected then index variable will be set to 1.

Disabled: Optional: Specify a global target program variable that will specify whether the widget should be disabled. Non zero value mean widget will be disabled, value of 0 will enable the widget.

Visible: Optional: Specify a global target program variable that will determine whether widget is visible or hidden. Value of 0 will hide the widget. Default is visible.

Read Only: Optional: Specify a global target program variable that will determine whether the widget is read only. Target variable value of 1 will make widget read only.

Tooltip: Optional: Specify a global string variable that can be used to dynamically provide tooltip string. If you do not require for tooltip to change, then please use tooltip property in Widget Properties.

Widget Specific Properties[edit]

type: no description

Name: no description

alt: no description

Value: Specify the initial selection.

Tab Index: no description

intermediateChanges: no description

showLabel: no description

iconClass: no description

Empty Label: no description

required: Can be true or false, default is false.

state: Shows current state (ie, validation result) of input (Normal, Warning, or Error)

multiple: Specify whether the multiple selections are allowed.

scrollOnFocus: On focus, should this widget scroll into view?

autoWidth: Set to true to make the drop down at least as wide as this widget. Set to false if the drop down should just be its default width

maxHeight: The max height for our dropdown. Set to 0 for no max height. any dropdown taller than this will have scrollbars

DropDown Position: popup positin

Button Position: button positin

Rotate Degree: Rotate Degree

Disabled: Specify whether the widget should be disabled.

Visible: Specify whether widget is visible or hidden.

Read Only: Specify whether the widget is read only.

Tooltip: Static text to display in tooltip popup.

Labels: Optional: Specify a global target program string array that will provide labels for selections. If labels will be statically provided at design time then please leave this field blank.

Values: Optional: Specify a global target program string array that will provide Values for selections. if not provided, value will be same as label

Sort: sort option

GroupBox[edit]

A widget that is based on gc.dijit.GroupBox, it is used to provide a grouping for a set of widgets with a title that groups widgets.

Widget Binding Properties[edit]

Label: container title

Disabled: Optional: Specify a global target program variable that will specify whether the widget should be disabled. Non zero value mean widget will be disabled, value of 0 will enable the widget.

Visible: Optional: Specify a global target program variable that will determine whether widget is visible or hidden. Value of 0 will hide the widget. Default is visible.

Read Only: Optional: Specify a global target program variable that will determine whether the widget is read only. Target variable value of 1 will make widget read only.

Tooltip: Optional: Specify a global string variable that can be used to dynamically provide tooltip string. If you do not require for tooltip to change, then please use tooltip property in Widget Properties.

Widget Specific Properties[edit]

Label: Specify whether the widget should be disabled.

Disabled: Specify whether the widget should be disabled.

Visible: Specify whether widget is visible or hidden.

Read Only: Specify whether the widget is read only.

Tooltip: Static text to display in tooltip popup.

HorizontalRuleLabels[edit]

This widget may be used to add custom labels to a slider widget. GUI Composer automatically adds HorizontalRuleLabel and HorizontalRule widgets when slider is added.

Widget Binding Properties[edit]

Widget Specific Properties[edit]

Count: no description

Rule Style: no description

Label Style: no description

Labels: no description

Numeric Margin: no description

Minimum Value: no description

Maximum Value: no description

constraints: no description

container: For HorizontalSlider, this is either "topDecoration" or "bottomDecoration", and indicates whether this rule goes above or below the slider.

HorizontalRule[edit]

This widget may be used to define that number of hash marks for slider widget. It should be combined with HorizontalRuleLabel. GUI Composer automatically adds HorizontalRuleLabel and HorizontalRule widgets when slider is added.

Widget Binding Properties[edit]

Widget Specific Properties[edit]

Count: no description

Rule Style: no description

container: For HorizontalSlider, this is either "topDecoration" or "bottomDecoration", and indicates whether this rule goes above or below the slider.

HorizontalSlider[edit]

The HorizontalSlider widget is a representation of scale with a handle you can drag left/right to select a value. GUI Composer automatically adds HorizontalRuleLabel and HorizontalRule widgets when slider is added. Outline view maybe used to select indvidual Rule and Labels widgets to customize them.

Widget Binding Properties[edit]

Value: Required: Specify a global target program variable that the current value of the slider is bound to.

Disabled: Optional: Specify a global target program variable that will specify whether the widget should be disabled. Non zero value mean widget will be disabled, value of 0 will enable the widget.

Visible: Optional: Specify a global target program variable that will determine whether widget is visible or hidden. Value of 0 will hide the widget. Default is visible.

Read Only: Optional: Specify a global target program variable that will determine whether the widget is read only. Target variable value of 1 will make widget read only.

Tooltip: Optional: Specify a global string variable that can be used to dynamically provide tooltip string. If you do not require for tooltip to change, then please use tooltip property in Widget Properties.

Widget Specific Properties[edit]

type: Corresponds to the native HTML <input> element's attribute. From dijit.form._FormWidgetMixin.

Name: Name used when submitting form; same as "name" attribute or plain HTML elements. From dijit.form._FormWidgetMixin.

alt: Corresponds to the native HTML <input> element's attribute. From dijit.form._FormWidgetMixin.

Value: Specify the initial value of the slider.

Tab Index: Order fields are traversed when user hits the tab key. From dijit.form._FormWidgetMixin.

Intermediate Changes: Fires onChange for each value change or only on demand. From dijit.form._FormWidgetMixin.

Scroll on Focus: Determines if this this widget scroll into view on focus. From dijit.form._FormWidgetMixin.

Show Buttons: Show increment/decrement buttons at the ends of the slider.

Minimum Value: Specify the minimum value of the slider.

Maximum Value: Specify the maximum value of the slider.

Discrete Values: If specified, indicates that the slider handle has only 'discreteValues' possible positions, and that after dragging the handle, it will snap to the nearest possible position. Thus, the slider has only 'discreteValues' possible values.

Page Increment: If discreteValues is also specified, this indicates the amount of clicks (ie, snap positions) that the slider handle is moved via pageup/pagedown keys. If discreteValues is not specified, it indicates the number of pixels.

Click Select: Determines if clicking the slider bar changes the value or not

Slide Duration: The time in ms to take to animate the slider handle from 0% to 100%, when clicking the slider bar to make the handle move.. Default is registry.defaultDuration.

Disabled: Specify whether the widget should be disabled.

Visible: Specify whether widget is visible or hidden.

Read Only: Specify whether the widget is read only.

Tooltip: Static text to display in tooltip popup.

HyperLink[edit]

Hyperlink container can be used to add local/external links.

Widget Binding Properties[edit]

Label: Specify the text to be display as the label

Disabled: Specify whether the widget should be disabled.

Visible: show or hide widget

Read Only: read only

Tooltip: popup help information

Widget Specific Properties[edit]

Href: no description

Label: displayed text

Target: no description

Disabled: Specify whether the widget should be disabled.

visible: show or hide widget

Read Only: read only

Tooltip: popup help information

Image[edit]

The Image widget may be used to add an image to your application. First add an image to your GUI Composer project (right click in GUI Composer Project and select Add Files), then drag the image widget. A pop up will allow you to select the image. You may also double click on the widget to pop up image selection dialog. This widget is not bound to a target variable, to display different images based on state of a target variable, please use MultiImage widget.

Widget Binding Properties[edit]

image path: Required: Specify a global target program string variable that contains the file URL of an image. The image must be a resource in the GUI application

Disabled: Optional: Specify a global target program variable that will specify whether the widget should be disabled. Non zero value mean widget will be disabled, value of 0 will enable the widget.

Visible: Optional: Specify a global target program variable that will determine whether widget is visible or hidden. Value of 0 will hide the widget. Default is visible.

Read Only: Optional: Specify a global target program variable that will determine whether the widget is read only. Target variable value of 1 will make widget read only.

Tooltip: Optional: Specify a global string variable that can be used to dynamically provide tooltip string. If you do not require for tooltip to change, then please use tooltip property in Widget Properties.

Widget Specific Properties[edit]

name: no description

src: no description

alt: no description

Disabled: Specify whether the widget should be disabled.

Visible: Specify whether widget is visible or hidden.

Read Only: Specify whether the widget is read only.

Tooltip: Static text to display in tooltip popup.

Label[edit]

The Label widget is used to text to your application. Fonts, size may be adjusted through widget Font properties.

Widget Binding Properties[edit]

Label: Optional: Specify a global target program string variable that will be used to populate label widget.

Disabled: Optional: Specify a global target program variable that will specify whether the widget should be disabled. Non zero value mean widget will be disabled, value of 0 will enable the widget.

Visible: Optional: Specify a global target program variable that will determine whether widget is visible or hidden. Value of 0 will hide the widget. Default is visible.

Read Only: Optional: Specify a global target program variable that will determine whether the widget is read only. Target variable value of 1 will make widget read only.

Tooltip: Optional: Specify a global string variable that can be used to dynamically provide tooltip string. If you do not require for tooltip to change, then please use tooltip property in Widget Properties.

Widget Specific Properties[edit]

For: no description

Label: no description

Disabled: Specify whether the widget should be disabled.

Visible: Specify whether widget is visible or hidden.

Read Only: Specify whether the widget is read only.

Tooltip: Static text to display in tooltip popup.

ListBox[edit]

The CheckedMultiSelect widget widget is an exact replacement for the HTML SELECT element and was created to provide a thin widget wrapper that provides the ability to select multiple items. You provide a list of acceptable value pairs consisting of text to be displayed and the hidden text value to be submitted with a FORM.

Widget Binding Properties[edit]

Labels: Optional: Specify a global target program string array variable that the labels of the items are bound to.

Values: Optional: Specify a global target program string array variable that the values of the items are bound to.

Selected Value: Required: Specify a global target program string array variable that the values of the current selections are bound to

Selected Index: current selected index

Disabled: Optional: Specify a global target program variable that will specify whether the widget should be disabled. Non zero value mean widget will be disabled, value of 0 will enable the widget.

Visible: Optional: Specify a global target program variable that will determine whether widget is visible or hidden. Value of 0 will hide the widget. Default is visible.

Read Only: Optional: Specify a global target program variable that will determine whether the widget is read only. Target variable value of 1 will make widget read only.

Tooltip: Optional: Specify a global string variable that can be used to dynamically provide tooltip string. If you do not require for tooltip to change, then please use tooltip property in Widget Properties.

Widget Specific Properties[edit]

type: no description

Name: no description

alt: no description

Tab Index: no description

intermediateChanges: no description

Multiple Selection: no description

Disabled: Specify whether the widget should be disabled.

Visible: Specify whether widget is visible or hidden.

Read Only: Specify whether the widget is read only.

Tooltip: Static text to display in tooltip popup.

Sort: sort option

Labels: Optional: Specify a global target program string array variable that the labels of the items are bound to.

Values: Optional: Specify a global target program string array variable that the values of the items are bound to.

MultiImage[edit]

This widget may be used to display different images based on the status of a target variable. One of its uses might be to display status information, e.g. green image for OK and red image for an error condition.

Widget Binding Properties[edit]

Selection: Required: Specify a global target program string variable that contains the file URL of an image. The image must be a resource in the GUI application. Alternatively, enter a global target program integer variable that provides an index of image to display. e.g. If images green, yellow, red are specified in widget properties, then if target variable has value of 1 then yellow image would be displayed.

Disabled: Optional: Specify a global target program variable that will specify whether the widget should be disabled. Non zero value mean widget will be disabled, value of 0 will enable the widget.

Visible: Optional: Specify a global target program variable that will determine whether widget is visible or hidden. Value of 0 will hide the widget. Default is visible.

Read Only: Optional: Specify a global target program variable that will determine whether the widget is read only. Target variable value of 1 will make widget read only.

Tooltip: Optional: Specify a global string variable that can be used to dynamically provide tooltip string. If you do not require for tooltip to change, then please use tooltip property in Widget Properties.

Widget Specific Properties[edit]

name: no description

images: no description

alt: no description

Disabled: Specify whether the widget should be disabled.

Visible: Specify whether widget is visible or hidden.

Read Only: Specify whether the widget is read only.

Tooltip: Static text to display in tooltip popup.

MultiSelect[edit]

The MultiSelect widget widget is an exact replacement for the native SELECT element and was created to provide a thin widget wrapper that provides the ability to select multiple items. You provide a list of acceptable value pairs consisting of text to be displayed and the hidden text value to be submitted with a FORM.

Widget Binding Properties[edit]

Labels: Optional: Specify a global target program string array variable that the labels of the items are bound to.

Values: Required: Specify a global target program string array variable that the values of the current selections are bound to

Index: current selected index

Value: current selected value

Disabled: Optional: Specify a global target program variable that will specify whether the widget should be disabled. Non zero value mean widget will be disabled, value of 0 will enable the widget.

Visible: Optional: Specify a global target program variable that will determine whether widget is visible or hidden. Value of 0 will hide the widget. Default is visible.

Read Only: Optional: Specify a global target program variable that will determine whether the widget is read only. Target variable value of 1 will make widget read only.

Tooltip: Optional: Specify a global string variable that can be used to dynamically provide tooltip string. If you do not require for tooltip to change, then please use tooltip property in Widget Properties.

Widget Specific Properties[edit]

type: no description

Name: no description

alt: no description

Tab Index: no description

intermediateChanges: no description

Multiple Selection: no description

Size: no description

scrollOnFocus: On focus, should this widget scroll into view?

Disabled: Specify whether the widget should be disabled.

Visible: Specify whether widget is visible or hidden.

Read Only: Specify whether the widget is read only.

Tooltip: Static text to display in tooltip popup.

Sort: sort option

MultiListBox[edit]

The CheckedMultiSelect widget is an exact replacement for the HTML SELECT element and was created to provide a thin widget wrapper that provides the ability to select multiple items. You provide a list of acceptable value pairs consisting of text to be displayed and the hidden text value to be submitted with a FORM.

Widget Binding Properties[edit]

Labels: Optional: Specify a global target program string array variable that the labels of the items are bound to.

Values: Optional: Specify a global target program string array variable that the values of the items are bound to.

Selected Value: sum of selected value

Disabled: Optional: Specify a global target program variable that will specify whether the widget should be disabled. Non zero value mean widget will be disabled, value of 0 will enable the widget.

Visible: Optional: Specify a global target program variable that will determine whether widget is visible or hidden. Value of 0 will hide the widget. Default is visible.

Read Only: Optional: Specify a global target program variable that will determine whether the widget is read only. Target variable value of 1 will make widget read only.

Tooltip: Optional: Specify a global string variable that can be used to dynamically provide tooltip string. If you do not require for tooltip to change, then please use tooltip property in Widget Properties.

Widget Specific Properties[edit]

type: no description

Name: no description

alt: no description

Tab Index: no description

intermediateChanges: no description

Multiple Selection: no description

Disabled: Specify whether the widget should be disabled.

Visible: Specify whether widget is visible or hidden.

Read Only: Specify whether the widget is read only.

Tooltip: Static text to display in tooltip popup.

Sort: sort option

Labels: Optional: Specify a global target program string array variable that the labels of the items are bound to.

Values: Optional: Specify a global target program string array variable that the values of the items are bound to.

NumberSpinner[edit]

The NumberSpinner widget provides arrows to increment/decrement values. It can also accept values that user enters with a keyboard like a TextBox widget. It is useful to provide fine value control in your application.

Widget Binding Properties[edit]

Value: Required: Specify a global target program variable that the current value of the spinner is bound to.

Disabled: Optional: Specify a global target program variable that will specify whether the widget should be disabled. Non zero value mean widget will be disabled, value of 0 will enable the widget.

Visible: Optional: Specify a global target program variable that will determine whether widget is visible or hidden. Value of 0 will hide the widget. Default is visible.

Read Only: Optional: Specify a global target program variable that will determine whether the widget is read only. Target variable value of 1 will make widget read only.

Tooltip: Optional: Specify a global string variable that can be used to dynamically provide tooltip string. If you do not require for tooltip to change, then please use tooltip property in Widget Properties.

Widget Specific Properties[edit]

Name: no description

alt: no description

Value: Specify the initial value of the spinner.

Maximum Value: max value

Minimum Value: min value

Tab Index: no description

Intermediate Changes: no description

trim: no description

uppercase: no description

lowercase: no description

propercase: no description

Max Length: no description

Required: no description

Prompt Message: no description

Invalid Message: no description

Constraints: no description

Tooltip Positions: no description

Range Message: no description

Edit Options: no description

Default Timeout: no description

Timeout Change Rate: no description

Small Delta: no description

Large Delta: no description

scrollOnFocus: On focus, should this widget scroll into view?

state: Shows current state (ie, validation result) of input (Normal, Warning, or Error)

Disabled: Specify whether the widget should be disabled.

Visible: Specify whether widget is visible or hidden.

Read Only: Specify whether the widget is read only.

Tooltip: Static text to display in tooltip popup.

ProgressBar[edit]

Progress Bar may be used to indicate progress of a long running operation. A variable needs to contain a value from 0-100 to indicate progress.

Widget Binding Properties[edit]

Value: Required: Specify a global target program variable that will be used to display progress status. Valid values are from 0-100 to indicate percentage completion.

Disabled: Optional: Specify a global target program variable that will specify whether the widget should be disabled. Non zero value mean widget will be disabled, value of 0 will enable the widget.

Visible: Optional: Specify a global target program variable that will determine whether widget is visible or hidden. Value of 0 will hide the widget. Default is visible.

Read Only: Optional: Specify a global target program variable that will determine whether the widget is read only. Target variable value of 1 will make widget read only.

Tooltip: Optional: Specify a global string variable that can be used to dynamically provide tooltip string. If you do not require for tooltip to change, then please use tooltip property in Widget Properties.

Widget Specific Properties[edit]

Value: no description

Maximum Value: no description

Places: no description

Indeterminate: no description

Disabled: Specify whether the widget should be disabled.

Visible: Specify whether widget is visible or hidden.

Read Only: Specify whether the widget is read only.

Tooltip: Static text to display in tooltip popup.

RadioButtonGroup[edit]

The RadioButtonGroup widget is a representation of a group of check box buttons.

Widget Binding Properties[edit]

Labels: Optional: Specify a String array global target program variable that will provide labels of the buttons are bound to.

Values: Optional: Specify a global target program array of values to assign to each button in the group.

Selected Value: Required: one of valueSelection, textSelection or selection. Specify a global target program variable that the value of the current selection is bound to.

Selected Label: Required: one of valueSelection, textSelection or selection. Specify a global target program variable that the label of the current selection is bound to.

Selected Index: Required: one of valueSelection, textSelection or selection. Specify a global target program variable that the index of the current selection is bound to.

Disabled: Optional: Specify a global target program variable that will specify whether the widget should be disabled. Non zero value mean widget will be disabled, value of 0 will enable the widget.

Visible: Optional: Specify a global target program variable that will determine whether widget is visible or hidden. Value of 0 will hide the widget. Default is visible.

Read Only: Optional: Specify a global target program variable that will determine whether the widget is read only. Target variable value of 1 will make widget read only.

Tooltip: Optional: Specify a global string variable that can be used to dynamically provide tooltip string. If you do not require for tooltip to change, then please use tooltip property in Widget Properties.

Widget Specific Properties[edit]

Name: no description

alt: no description

Selected Value: Value of the currently selected button (or it's label if no value is specified).

Tab Index: no description

intermediateChanges: no description

label: no description

iconClass: no description

Checked: no description

scrollOnFocus: On focus, should this widget scroll into view?

Labels: Static labels for Radio Buttons in this group.

Values: Static values to assign to each button in the group.

Disabled: Specify whether the widget should be disabled.

Visible: Specify whether widget is visible or hidden.

Read Only: Specify whether the widget is read only.

Tooltip: Static text to display in tooltip popup.

RadioListBox[edit]

This widget provides a list of items with radio buttons where only one item is active.

Widget Binding Properties[edit]

Labels: Optional: Specify a global target program string array variable that the labels of the items are bound to.

Values: Optional: Specify a global target program string array variable that the values of the items are bound to.

Selected Value: Required: Specify a global target program string array variable that the values of the current selections are bound to

Selected Index: current selected index

Disabled: Optional: Specify a global target program variable that will specify whether the widget should be disabled. Non zero value mean widget will be disabled, value of 0 will enable the widget.

Visible: Optional: Specify a global target program variable that will determine whether widget is visible or hidden. Value of 0 will hide the widget. Default is visible.

Read Only: Optional: Specify a global target program variable that will determine whether the widget is read only. Target variable value of 1 will make widget read only.

Tooltip: Optional: Specify a global string variable that can be used to dynamically provide tooltip string. If you do not require for tooltip to change, then please use tooltip property in Widget Properties.

Widget Specific Properties[edit]

type: no description

Name: no description

alt: no description

Tab Index: no description

intermediateChanges: no description

Multiple Selection: no description

Disabled: Specify whether the widget should be disabled.

Visible: Specify whether widget is visible or hidden.

Read Only: Specify whether the widget is read only.

Tooltip: Static text to display in tooltip popup.

Sort: sort option

Labels: Optional: Specify a global target program string array variable that the labels of the items are bound to.

Values: Optional: Specify a global target program string array variable that the values of the items are bound to.

TabContainer[edit]

A TabContainer is a container that has multiple panes, but shows only one pane at a time. For more information, see dijit.layout.TabContainer. Data access for widgets that are on non-active tabs is disabled to optimize performance.

Widget Binding Properties[edit]

Selected Tab Index: Current selected tab index

Disabled: Optional: Specify a global target program variable that will specify whether the widget should be disabled. Non zero value mean widget will be disabled, value of 0 will enable the widget.

Visible: Optional: Specify a global target program variable that will determine whether widget is visible or hidden. Value of 0 will hide the widget. Default is visible.

Read Only: Optional: Specify a global target program variable that will determine whether the widget is read only. Target variable value of 1 will make widget read only.

Tooltip: Optional: Specify a global string variable that can be used to dynamically provide tooltip string. If you do not require for tooltip to change, then please use tooltip property in Widget Properties.

Widget Specific Properties[edit]

doLayout: no description

Tab Position: no description

Nested: no description

tabStrip: Defines whether the tablist gets an extra class for layouting, putting a border/shading around the set of tabs.

persist: Remembers the selected child across sessions

selectedChildWidget: References the currently selected child widget, if any

isContainer: Just a flag indicating that this widget descends from dijit._Container

controllerWidget: object which implements the controller which is responsible for the tabs and their selection

Disabled: Specify whether the widget should be disabled.

Visible: Specify whether widget is visible or hidden.

Read Only: Specify whether the widget is read only.

Tooltip: Static text to display in tooltip popup.

TextArea[edit]

The TextArea widget is a display only that maybe used to provide detailed status or diagnostic information. It dynamically resizes to fit the content of the text inside.

Widget Binding Properties[edit]

Value: Required: Specify a global target program variable that will provide contents of text area.

Disabled: Optional: Specify a global target program variable that will specify whether the widget should be disabled. Non zero value mean widget will be disabled, value of 0 will enable the widget.

Visible: Optional: Specify a global target program variable that will determine whether widget is visible or hidden. Value of 0 will hide the widget. Default is visible.

Read Only: Optional: Specify a global target program variable that will determine whether the widget is read only. Target variable value of 1 will make widget read only.

Tooltip: Optional: Specify a global string variable that can be used to dynamically provide tooltip string. If you do not require for tooltip to change, then please use tooltip property in Widget Properties.

Widget Specific Properties[edit]

Name: no description

MaxLength: no description

alt: no description

Text: no description

Tab Index: no description

Intermediate Changes: no description

cols: no description

rows: The number of characters per line.

trim: Removes leading and trailing whitespace if true. Default is false.

uppercase: Converts all characters to uppercase if true. Default is false.

lowercase: Converts all characters to lowercase if true. Default is false.

propercase: Converts the first character of each word to uppercase if true.

scrollOnFocus: On focus, should this widget scroll into view?

Disabled: Specify whether the widget should be disabled.

Visible: Specify whether widget is visible or hidden.

Read Only: Specify whether the widget is read only.

Tooltip: Static text to display in tooltip popup.

Auto Resize: automatically change window size

TextBox[edit]

Text Box may be used to display a string or a number and allow user to enter strings or values.

Widget Binding Properties[edit]

Value: Required: Specify a global target program variable that will provide contents of the textbox.

Disabled: Optional: Specify a global target program variable that will specify whether the widget should be disabled. Non zero value mean widget will be disabled, value of 0 will enable the widget.

Visible: Optional: Specify a global target program variable that will determine whether widget is visible or hidden. Value of 0 will hide the widget. Default is visible.

Read Only: Optional: Specify a global target program variable that will determine whether the widget is read only. Target variable value of 1 will make widget read only.

Tooltip: Optional: Specify a global string variable that can be used to dynamically provide tooltip string. If you do not require for tooltip to change, then please use tooltip property in Widget Properties.

Widget Specific Properties[edit]

Type: no description

Name: no description

alt: no description

Value: no description

Tab Index: no description

Intermediate Changes: no description

Trim: no description

Upper Case: no description

Lower Case: no description

Proper Case: no description

Max Length: no description

selectOnClick: no description

placeHolder: no description

scrollOnFocus: On focus, should this widget scroll into view?

Disabled: Specify whether the widget should be disabled.

Visible: Specify whether widget is visible or hidden.

Read Only: Specify whether the widget is read only.

Tooltip: Static text to display in tooltip popup.

TitlePane[edit]

Title Pane may be used to provide a simple menu in your application.

Widget Binding Properties[edit]

Disabled: Optional: Specify a global target program variable that will specify whether the widget should be disabled. Non zero value mean widget will be disabled, value of 0 will enable the widget.

Visible: Optional: Specify a global target program variable that will determine whether widget is visible or hidden. Value of 0 will hide the widget. Default is visible.

Read Only: Optional: Specify a global target program variable that will determine whether the widget is read only. Target variable value of 1 will make widget read only.

Tooltip: Optional: Specify a global string variable that can be used to dynamically provide tooltip string. If you do not require for tooltip to change, then please use tooltip property in Widget Properties.

Widget Specific Properties[edit]

Title: no description

URL: no description

Extract Content: no description

Parse On Load: no description

Prevent Cache: no description

Preload: no description

Refresh On Show: no description

doLayout: no description

Duration: no description

open: Whether pane is opened or closed.

Hide Default Border: no description

isContainer: Just a flag indicating that this widget will call resize() on its children.

Disabled: Specify whether the widget should be disabled.

Visible: Specify whether widget is visible or hidden.

Read Only: Specify whether the widget is read only.

Tooltip: Static text to display in tooltip popup.

ToggleButton[edit]

The ToggleButton widget is simila to ValueButton where a target variable can be written to, but it has additional visual indication of the button state.

Widget Binding Properties[edit]

Label: Optional: Specify a global target string variable that will be used to be display as the label of the button.

Checked: Required: Specify a global target program boolean variable that the checked state of the button is bound to.

Disabled: Optional: Specify a global target program variable that will specify whether the widget should be disabled. Non zero value mean widget will be disabled, value of 0 will enable the widget.

Visible: Optional: Specify a global target program variable that will determine whether widget is visible or hidden. Value of 0 will hide the widget. Default is visible.

Read Only: Optional: Specify a global target program variable that will determine whether the widget is read only. Target variable value of 1 will make widget read only.

Tooltip: Optional: Specify a global string variable that can be used to dynamically provide tooltip string. If you do not require for tooltip to change, then please use tooltip property in Widget Properties.

Widget Specific Properties[edit]

Name: no description

alt: no description

Value: no description

Tab Index: no description

intermediateChanges: no description

Label: Specify the text to be display as the label of the button.

Show Label: Specify whether to show or hide the label of the button.

Icon Class: no description

Checked: Specify the initial state of the button.

scrollOnFocus: On focus, should this widget scroll into view?

Disabled: Specify whether the widget should be disabled.

Visible: Specify whether widget is visible or hidden.

Read Only: Specify whether the widget is read only.

Tooltip: Static text to display in tooltip popup.

ValueButton[edit]

The ValueButton widget can write a single value to a variable that has been bound to it. The value to be written can be specified in Widget Specific section of properties.

Widget Binding Properties[edit]

Label: Optional: Specify a a global target program variable that will provide the text to be displayed in the button. If you are statically providing a label for the button at design time, then leave this field blank.

value: Required: Specify a a global target program variable that will be written to the value specified in widget specific bindings {value field} when the button is pressed.

Disabled: Optional: Specify a global target program variable that will specify whether the widget should be disabled. Non zero value mean widget will be disabled, value of 0 will enable the widget.

Visible: Optional: Specify a global target program variable that will determine whether widget is visible or hidden. Value of 0 will hide the widget. Default is visible.

Read Only: Optional - Specify a global target program variable that will determine whether the widget is read only. Target variable value of 1 will make widget read only.

Tooltip: Optional: Specify a global string variable that can be used to dynamically provide tooltip string. If you do not require for tooltip to change, then please use tooltip property in Widget Properties.

Widget Specific Properties[edit]

Type: no description

Name: no description

alt: no description

Value: Specify the value to be set to the variable when the button is clicked.

Tab Index: no description

intermediateChanges: no description

Label: Specify the text to be display as the label of the button.

Show Label: Specify whether to show or hidd the label of the button.

Icon Class: no description

scrollOnFocus: On focus, should this widget scroll into view?

Disabled: Specify whether the widget should be disabled.

Visible: Specify whether widget is visible or hidden.

Read Only: Specify whether the widget is read only.

Tooltip: Static text to display in tooltip popup.

VerticalRuleLabels[edit]

This widget may be used to add custom labels to a slider widget. GUI Composer automatically adds VerticalRuleLabel and VerticalRule widgets when slider is added.

Widget Binding Properties[edit]

Widget Specific Properties[edit]

Count: no description

Rule Style: no description

Label Style: no description

Labels: no description

Numeric Margin: no description

Minimum Value: no description

Maximum Value: no description

constraints: no description

container: For HorizontalSlider, this is either "rightDecoration" or "leftDecoration", and indicates whether this rule goes above or below the slider.

VerticalRule[edit]

This widget may be used to define that number of hash marks for slider widget. It should be combined with HorizontalRuleLabel. GUI Composer automatically adds VerticalRuleLabel and VerticalRule widgets when slider is added.

Widget Binding Properties[edit]

Widget Specific Properties[edit]

Count: no description

Rule Style: no description

container: This is either "leftDecoration" or "rightDecoration", to indicate whether this rule goes to the left or to the right of the slider. Note that on RTL system, "leftDecoration" would actually go to the right, and vice-versa.

VerticalSlider[edit]

The VerticalSlider widget is a representation of scale with a handle you can drag left/right to select a value. GUI Composer automatically adds VerticalRuleLabel and VerticalRule widgets when slider is added. Outline view maybe used to select indvidual Rule and Labels widgets to customize them.

Widget Binding Properties[edit]

Value: Required: Specify a global target program variable that the current value of the slider is bound to.

Disabled: Optional: Specify a global target program variable that will specify whether the widget should be disabled. Non zero value mean widget will be disabled, value of 0 will enable the widget.

Visible: Optional: Specify a global target program variable that will determine whether widget is visible or hidden. Value of 0 will hide the widget. Default is visible.

Read Only: Optional: Specify a global target program variable that will determine whether the widget is read only. Target variable value of 1 will make widget read only.

Tooltip: Optional: Specify a global string variable that can be used to dynamically provide tooltip string. If you do not require for tooltip to change, then please use tooltip property in Widget Properties.

Widget Specific Properties[edit]

type: Corresponds to the native HTML <input> element's attribute. From dijit.form._FormWidgetMixin.

Name: Name used when submitting form; same as "name" attribute or plain HTML elements. From dijit.form._FormWidgetMixin.

alt: Corresponds to the native HTML <input> element's attribute. From dijit.form._FormWidgetMixin.

Value: Specify the initial value of the slider.

Tab Index: Order fields are traversed when user hits the tab key. From dijit.form._FormWidgetMixin.

Intermediate Changes: Fires onChange for each value change or only on demand. From dijit.form._FormWidgetMixin.

Scroll on Focus: Determines if this this widget scroll into view on focus. From dijit.form._FormWidgetMixin.

Show Buttons: Show increment/decrement buttons at the ends of the slider.

Minimum Value: Specify the minimum value of the slider.

Maximum Value: Specify the maximum value of the slider.

Discrete Values: If specified, indicates that the slider handle has only 'discreteValues' possible positions, and that after dragging the handle, it will snap to the nearest possible position. Thus, the slider has only 'discreteValues' possible values.

Page Increment: If discreteValues is also specified, this indicates the amount of clicks (ie, snap positions) that the slider handle is moved via pageup/pagedown keys. If discreteValues is not specified, it indicates the number of pixels.

Click Select: Determines if clicking the slider bar changes the value or not

Slide Duration: The time in ms to take to animate the slider handle from 0% to 100%, when clicking the slider bar to make the handle move.. Default is registry.defaultDuration.

Disabled: Specify whether the widget should be disabled.

Visible: Specify whether widget is visible or hidden.

Read Only: Specify whether the widget is read only.

Tooltip: Static text to display in tooltip popup.

DGrid[edit]

Data Grid provides a simple 2D table that can be populated via 2D array.

Widget Binding Properties[edit]

Column Names: Specify a list of column names

Data: Specify a set of data

Disabled: Optional: Specify a global target program variable that will specify whether the widget should be disabled. Non zero value mean widget will be disabled, value of 0 will enable the widget.

Visible: Optional: Specify a global target program variable that will determine whether widget is visible or hidden. Value of 0 will hide the widget. Default is visible.

Read Only: Optional: Specify a global target program variable that will determine whether the widget is read only. Target variable value of 1 will make widget read only.

Tooltip: Optional: Specify a global string variable that can be used to dynamically provide tooltip string. If you do not require for tooltip to change, then please use tooltip property in Widget Properties.

Widget Specific Properties[edit]

Name: no description

Column Names: Specify a list of column names

Data: Specify a set of data

Disabled: Specify whether the widget should be disabled.

Visible: Specify whether widget is visible or hidden.

Read Only: Specify whether the widget is read only.

Tooltip: Static text to display in tooltip popup.

AnalogGauge[edit]

The AnalogGauge widget shows an analogue value on a scale, its look and feel may be customized through ==== Widget Specific Properties ====.

Widget Binding Properties[edit]

Value: Required: Specify a global target program variable that the current value of the gauge is bound to.

Minimum Value: Optional: Specify a global target program variable that the minimum value of the gauge is bound to.

Maximum Value: Optional: Specify a global target program variable that the maximum value of the gauge is bound to.

Disabled: Optional: Specify a global target program variable that will specify whether the widget should be disabled. Non zero value mean widget will be disabled, value of 0 will enable the widget.

Visible: Optional: Specify a global target program variable that will determine whether widget is visible or hidden. Value of 0 will hide the widget. Default is visible.

Read Only: Optional: Specify a global target program variable that will determine whether the widget is read only. Target variable value of 1 will make widget read only.

Tooltip: Optional: Specify a global string variable that can be used to dynamically provide tooltip string. If you do not require for tooltip to change, then please use tooltip property in Widget Properties.

Widget Specific Properties[edit]

Title: no description

Unit: no description

Show Odometer: no description

Widget Size: no description

Minimum Value: Specify the minimum value of the gauge.

Maximum Value: Specify the maximum value of the gauge.

Current Value: Specify the initial value of the gauge.

Threshold Value: Specify the value when the indicator LED starts to blink.

Number Format: no description

Fractional Decimals: no description

Section Ratio: no description

Frame Design: no description

Background Design: no description

Disabled: Specify whether the widget should be disabled.

Visible: Specify whether widget is visible or hidden.

Read Only: Specify whether the widget is read only.

Tooltip: Static text to display in tooltip popup.

DigitalGauge[edit]

The DigitalGauge widget shows an digital value on a scale, its look and feel may be customized through ==== Widget Specific Properties ====.

Widget Binding Properties[edit]

Value: Required: Specify a global target program variable that the current value of the gauge is bound to.

Minimum Value: Optional: Specify a global target program variable that the minimum value of the gauge is bound to.

Maximum Value: Optional: Specify a global target program variable that the maximum value of the gauge is bound to.

Disabled: Optional: Specify a global target program variable that will specify whether the widget should be disabled. Non zero value mean widget will be disabled, value of 0 will enable the widget.

Visible: Optional: Specify a global target program variable that will determine whether widget is visible or hidden. Value of 0 will hide the widget. Default is visible.

Read Only: Optional: Specify a global target program variable that will determine whether the widget is read only. Target variable value of 1 will make widget read only.

Tooltip: Optional: Specify a global string variable that can be used to dynamically provide tooltip string. If you do not require for tooltip to change, then please use tooltip property in Widget Properties.

Widget Specific Properties[edit]

Title: no description

Unit: no description

Show LCD: no description

Widget Size: no description

Minimum Value: Specify the minimum value of the gauge.

Maximum Value: Specify the maximum value of the gauge.

Current Value: Specify the initial value of the gauge.

Threshold Value: Specify the value when the indicator LED starts to blink.

Number Format: no description

Fractional Decimals: no description

Gradient Ratio: no description

Frame Design: no description

Background Design: no description

Disabled: Specify whether the widget should be disabled.

Visible: Specify whether widget is visible or hidden.

Read Only: Specify whether the widget is read only.

Tooltip: Static text to display in tooltip popup.

FuelGauge[edit]

The FuelGauge widget shows an analog fuel gauge, its look and feel may be customized through ==== Widget Specific Properties ====.

Widget Binding Properties[edit]

Value: Required: Specify a global target program variable that the current value of the gauge is bound to.

Minimum Value: Optional: Specify a global target program variable that the minimum value of the gauge is bound to.

Maximum Value: Optional: Specify a global target program variable that the maximum value of the gauge is bound to.

Disabled: Optional: Specify a global target program variable that will specify whether the widget should be disabled. Non zero value mean widget will be disabled, value of 0 will enable the widget.

Visible: Optional: Specify a global target program variable that will determine whether widget is visible or hidden. Value of 0 will hide the widget. Default is visible.

Read Only: Optional: Specify a global target program variable that will determine whether the widget is read only. Target variable value of 1 will make widget read only.

Tooltip: Optional: Specify a global string variable that can be used to dynamically provide tooltip string. If you do not require for tooltip to change, then please use tooltip property in Widget Properties.

Widget Specific Properties[edit]

Title: no description

Unit: no description

Widget Size: no description

Orientation: no description

Minimum Value: Specify the minimum value of the gauge.

Maximum Value: Specify the maximum value of the gauge.

Current Value: Specify the initial value of the gauge.

Threshold Value: Specify the value when the indicator LED starts to blink.

Number Format: no description

Fractional Decimals: no description

Frame Design: no description

Background Design: no description

Disabled: Specify whether the widget should be disabled.

Visible: Specify whether widget is visible or hidden.

Read Only: Specify whether the widget is read only.

Tooltip: Static text to display in tooltip popup.

TemperatureGauge[edit]

The TemperatureGauge widget is a representation of an a temperature gauge, its look and feel may be customized through ==== Widget Specific Properties ====.

Widget Binding Properties[edit]

Value: Required: Specify a global target program variable that the current value of the gauge is bound to.

Minimum Value: Optional: Specify a global target program variable that the minimum value of the gauge is bound to.

Maximum Value: Optional: Specify a global target program variable that the maximum value of the gauge is bound to.

Disabled: Optional: Specify a global target program variable that will specify whether the widget should be disabled. Non zero value mean widget will be disabled, value of 0 will enable the widget.

Visible: Optional: Specify a global target program variable that will determine whether widget is visible or hidden. Value of 0 will hide the widget. Default is visible.

Read Only: Optional: Specify a global target program variable that will determine whether the widget is read only. Target variable value of 1 will make widget read only.

Tooltip: Optional: Specify a global string variable that can be used to dynamically provide tooltip string. If you do not require for tooltip to change, then please use tooltip property in Widget Properties.

Widget Specific Properties[edit]

Title: no description

Unit: no description

Show LCD: no description

Widget Height: no description

Widget Width: no description

Minimum Value: Specify the minimum value of the meter.

Maximum Value: Specify the maximum value of the meter.

Current Value: Specify the initial value of the meter.

Threshold Value: Specify the value when the indicator LED starts to blink.

Number Format: no description

Fractional Decimals: no description

Section Ratio: no description

Frame Design: no description

Background Design: no description

Disabled: Specify whether the widget should be disabled.

Visible: Specify whether widget is visible or hidden.

Read Only: Specify whether the widget is read only.

Tooltip: Static text to display in tooltip popup.

AnalogMeter[edit]

The AnalogMeter widget is a representation of an analog meter, its look and feel may be customized through ==== Widget Specific Properties ====.

Widget Binding Properties[edit]

Value: Required: Specify a global target program variable that the current value of the meter is bound to.

Minimum Value: Optional: Specify a global target program variable that the minimum value of the meter is bound to.

Maximum Value: Optional: Specify a global target program variable that the maximum value of the meter is bound to.

Disabled: Optional: Specify a global target program variable that will specify whether the widget should be disabled. Non zero value mean widget will be disabled, value of 0 will enable the widget.

Visible: Optional: Specify a global target program variable that will determine whether widget is visible or hidden. Value of 0 will hide the widget. Default is visible.

Read Only: Optional: Specify a global target program variable that will determine whether the widget is read only. Target variable value of 1 will make widget read only.

Tooltip: Optional: Specify a global string variable that can be used to dynamically provide tooltip string. If you do not require for tooltip to change, then please use tooltip property in Widget Properties.

Widget Specific Properties[edit]

Title: no description

Unit: no description

Show LCD: no description

Widget Height: no description

Widget Width: no description

Minimum Value: Specify the minimum value of the meter.

Maximum Value: Specify the maximum value of the meter.

Current Value: Specify the initial value of the meter.

Threshold Value: Specify the value when the indicator LED starts to blink.

Number Format: no description

Fractional Decimals: no description

Section Ratio: no description

Frame Design: no description

Background Design: no description

Disabled: Specify whether the widget should be disabled.

Visible: Specify whether widget is visible or hidden.

Read Only: Specify whether the widget is read only.

Tooltip: Static text to display in tooltip popup.

DigitalMeter[edit]

The DigitalMeter widget is a representation of an digital meter, its look and feel may be customized through ==== Widget Specific Properties ====.

Widget Binding Properties[edit]

Value: Required: Specify a global target program variable that the current value of the meter is bound to.

Minimum Value: Optional: Specify a global target program variable that the minimum value of the meter is bound to.

Maximum Value: Optional: Specify a global target program variable that the maximum value of the meter is bound to.

Disabled: Optional: Specify a global target program variable that will specify whether the widget should be disabled. Non zero value mean widget will be disabled, value of 0 will enable the widget.

Visible: Optional: Specify a global target program variable that will determine whether widget is visible or hidden. Value of 0 will hide the widget. Default is visible.

Read Only: Optional: Specify a global target program variable that will determine whether the widget is read only. Target variable value of 1 will make widget read only.

Tooltip: Optional: Specify a global string variable that can be used to dynamically provide tooltip string. If you do not require for tooltip to change, then please use tooltip property in Widget Properties.

Widget Specific Properties[edit]

Title: no description

Unit: no description

Show LCD: no description

Widget Height: no description

Widget Width: no description

Minimum Value: Specify the minimum value of the meter.

Maximum Value: Specify the maximum value of the meter.

Current Value: Specify the initial value of the meter.

Threshold Value: Specify the value when the indicator LED starts to blink.

Number Format: no description

Fractional Decimals: no description

Gradient Ratio: no description

Frame Design: no description

Background Design: no description

Disabled: Specify whether the widget should be disabled.

Visible: Specify whether widget is visible or hidden.

Read Only: Specify whether the widget is read only.

Tooltip: Static text to display in tooltip popup.

Dial[edit]

The Dial widget maybe used to provide a user input to control a numeric variable. It's scale, look and feel settings may be configured through ==== Widget Specific Properties ====.

Widget Binding Properties[edit]

Value: Required: Specify a global target program variable that the current value of the dial is bound to.

Minimum Value: Optional: Specify a global target program variable that the minimum value of the dial is bound to.

Maximum Value: Optional: Specify a global target program variable that the maximum value of the dial is bound to.

Disabled: Optional: Specify a global target program variable that will specify whether the widget should be disabled. Non zero value mean widget will be disabled, value of 0 will enable the widget.

Visible: Optional: Specify a global target program variable that will determine whether widget is visible or hidden. Value of 0 will hide the widget. Default is visible.

Read Only: Optional: Specify a global target program variable that will determine whether the widget is read only. Target variable value of 1 will make widget read only.

Tooltip: Optional: Specify a global string variable that can be used to dynamically provide tooltip string. If you do not require for tooltip to change, then please use tooltip property in Widget Properties.

Widget Specific Properties[edit]

Title: no description

Unit: no description

Widget Size: no description

Minimum Value: Specify the minimum value of the dial.

Maximum Value: Specify the maximum value of the dial.

Set Value On Drag: no description

Current Value: Specify the initial value of the dial.

Tick Labels: no description

Number Format: no description

Fractional Decimals: no description

Frame Design: no description

Dial Design: no description

Disabled: Specify whether the widget should be disabled.

Visible: Specify whether widget is visible or hidden.

Read Only: Specify whether the widget is read only.

Tooltip: Static text to display in tooltip popup.

LineGraph[edit]

The LineGraph widget is graph that can show up to 8 lines where each line represent the values of a variable of an Array type. Each refresh cycle will read entire array to update the graph. Line graph has an Export context menu that allows to save data buffer being displayed in a text file.

Widget Binding Properties[edit]

Series 0 Value: Required: Specify a global target variable of an Array type that will be used to display a single series on the graph.

Series 1 Value: Optional: Specify a global target variable of an Array type that will be used to display a single series on the graph.

Series 2 Value: Optional: Specify a global target variable of an Array type that will be used to display a single series on the graph.

Series 3 Value: Optional: Specify a global target variable of an Array type that will be used to display a single series on the graph.

Series 4 Value: Optional: Specify a global target variable of an Array type that will be used to display a single series on the graph.

Series 5 Value: Optional: Specify a global target variable of an Array type that will be used to display a single series on the graph.

Series 6 Value: Optional: Specify a global target variable of an Array type that will be used to display a single series on the graph.

Series 7 Value: Optional: Specify a global target variable of an Array type that will be used to display a single series on the graph.

Disabled: Optional: Specify a global target program variable that will specify whether the widget should be disabled. Non zero value mean widget will be disabled, value of 0 will enable the widget.

Visible: Optional: Specify a global target program variable that will determine whether widget is visible or hidden. Value of 0 will hide the widget. Default is visible.

Read Only: Optional: Specify a global target program variable that will determine whether the widget is read only. Target variable value of 1 will make widget read only.

Tooltip: Optional: Specify a global string variable that can be used to dynamically provide tooltip string. If you do not require for tooltip to change, then please use tooltip property in Widget Properties.

Widget Specific Properties[edit]

Title: no description

Height: no description

Width: no description

Auto Scale: Enable/Disable auto scale, select expandOnly to track min/max scale value.

X-Axis Minimum Value: Specify the minimum value of the X-axis

X-Axis Maximum Value: Specify the maximum value of the X-axis

Show X-Axis Ticks: no description

X-Axis Label: Specify the text to be displayed as the X-axis label.

Y-Axis Minimum Value: Specify the minimum value of the Y-axis

Y-Axis Maximum Value: Specify the maximum value of the Y-axis

Show Y-Axis Ticks: no description

Y-Axis Label: Specify the text to be displayed as the Y-axis label.

Series 0 Label

Series 1 Label: no description

Series 2 Label: no description

Series 3 Label: no description

Series 4 Label: no description

Series 5 Label: no description

Series 6 Label: no description

Series 7 Label: no description

Series 0 Color: no description

Series 1 Color: no description

Series 2 Color: no description

Series 3 Color: no description

Series 4 Color: no description

Series 5 Color: no description

Series 6 Color: no description

Series 7 Color: no description

Background Color: no description

Show Legend: no description

Show Grid Lines: Show the horizontal and vertical grid lines.

Disabled: Specify whether the widget should be disabled.

Visible: Specify whether widget is visible or hidden.

Read Only: Specify whether the widget is read only.

Tooltip: Static text to display in tooltip popup.

ScalarLineGraph[edit]

The ScalarLineGraph widget is a graph that displays a single value over time. A scalar variable needs to be specified in series binding property section. Each refresh cycle will read the scalar variable and append it to a buffer which is graphed. Once buffer is full FIFO scheme is used to shift values. Size of the accumulation buffer may be adjusted through ==== Widget Specific Properties ====. Scalar line graph has an Export context menu that allows to save data buffer being displayed in a text file.

Widget Binding Properties[edit]

Value 0: Required: Specify a scalar global target program variable that will be graphed. Scalar line graph accumulates single value at each refresh cycle storing them in a buffer and graphing over time. The buffer length can be specified in ==== Widget Specific Properties ==== section.

Value 1: Required: Specify a scalar global target program variable that will be graphed. Scalar line graph accumulates single value at each refresh cycle storing them in a buffer and graphing over time. The buffer length can be specified in ==== Widget Specific Properties ==== section.

Value 2: Required: Specify a scalar global target program variable that will be graphed. Scalar line graph accumulates single value at each refresh cycle storing them in a buffer and graphing over time. The buffer length can be specified in ==== Widget Specific Properties ==== section.

Value 3: Required: Specify a scalar global target program variable that will be graphed. Scalar line graph accumulates single value at each refresh cycle storing them in a buffer and graphing over time. The buffer length can be specified in ==== Widget Specific Properties ==== section.

Value 4: Required: Specify a scalar global target program variable that will be graphed. Scalar line graph accumulates single value at each refresh cycle storing them in a buffer and graphing over time. The buffer length can be specified in ==== Widget Specific Properties ==== section.

Value 5: Required: Specify a scalar global target program variable that will be graphed. Scalar line graph accumulates single value at each refresh cycle storing them in a buffer and graphing over time. The buffer length can be specified in ==== Widget Specific Properties ==== section.

Value 6: Required: Specify a scalar global target program variable that will be graphed. Scalar line graph accumulates single value at each refresh cycle storing them in a buffer and graphing over time. The buffer length can be specified in ==== Widget Specific Properties ==== section.

Value 7: Required: Specify a scalar global target program variable that will be graphed. Scalar line graph accumulates single value at each refresh cycle storing them in a buffer and graphing over time. The buffer length can be specified in ==== Widget Specific Properties ==== section.

Disabled: Optional: Specify a global target program variable that will specify whether the widget should be disabled. Non zero value mean widget will be disabled, value of 0 will enable the widget.

Visible: Optional: Specify a global target program variable that will determine whether widget is visible or hidden. Value of 0 will hide the widget. Default is visible.

Read Only: Optional: Specify a global target program variable that will determine whether the widget is read only. Target variable value of 1 will make widget read only.

Tooltip: Optional: Specify a global string variable that can be used to dynamically provide tooltip string. If you do not require for tooltip to change, then please use tooltip property in Widget Properties.

Widget Specific Properties[edit]

Title: no description

Height: no description

Width: no description

Buffer Length: Specify the maximum number of the historical values are shown in the graph. If the number of values exceeds the buffer length, only the most recent values are shown.

Auto Scale: Enable/Disable auto scale, select expandOnly to track min/max scale value.

X-Axis Minimum Value: Specify the minimum value of the X-axis

X-Axis Maximum Value: Specify the maximum value of the X-axis

Show X-Axis Ticks: no description

X-Axis Label: Specify the text to be displayed as the X-axis label.

Y-Axis Minimum Value: Specify the minimum value of the Y-axis

Y-Axis Maximum Value: Specify the maximum value of the Y-axis

Show Y-Axis Ticks: no description

Y-Axis Label: Specify the text to be displayed as the Y-axis label.

Value 0 Label: no description

Value 1 Label: no description

Value 2 Label: no description

Value 3 Label: no description

Value 4 Label: no description

Value 5 Label: no description

Value 6 Label: no description

Value 7 Label: no description

Series 0 Color: no description

Series 1 Color: no description

Series 2 Color: no description

Series 3 Color: no description

Series 4 Color: no description

Series 5 Color: no description

Series 6 Color: no description

Series 7 Color: no description

Background Color: no description

Show Legend: no description

Show Grid Lines: Show the horizontal and vertical grid lines.

Disabled: Specify whether the widget should be disabled.

Visible: Specify whether widget is visible or hidden.

Read Only: Specify whether the widget is read only.

Tooltip: Static text to display in tooltip popup.

ScatterPlot[edit]

The ScatterPlot is a graph that displays X-Y data. Each refresh cycle will read the X array and Y array to update the graph. Scatter plot has an Export context menu that allows to save data buffer being displayed in a text file.

Widget Binding Properties[edit]

Series 0 X-Value: Required: Specify a scalar global target program variable that will be graphed. Scalar line graph accumulates single value at each refresh cycle storing them in a buffer and graphing over time. The buffer length can be specified in ==== Widget Specific Properties ==== section.

Series 0 Y-Value: Required: Specify a scalar global target program variable that will be graphed. Scalar line graph accumulates single value at each refresh cycle storing them in a buffer and graphing over time. The buffer length can be specified in ==== Widget Specific Properties ==== section.

Series 1 X-Value: Required: Specify a scalar global target program variable that will be graphed. Scalar line graph accumulates single value at each refresh cycle storing them in a buffer and graphing over time. The buffer length can be specified in ==== Widget Specific Properties ==== section.

Series 1 Y-Value: Required: Specify a scalar global target program variable that will be graphed. Scalar line graph accumulates single value at each refresh cycle storing them in a buffer and graphing over time. The buffer length can be specified in ==== Widget Specific Properties ==== section.

Disabled: Optional: Specify a global target program variable that will specify whether the widget should be disabled. Non zero value mean widget will be disabled, value of 0 will enable the widget.

Visible: Optional: Specify a global target program variable that will determine whether widget is visible or hidden. Value of 0 will hide the widget. Default is visible.

Read Only: Optional: Specify a global target program variable that will determine whether the widget is read only. Target variable value of 1 will make widget read only.

Tooltip: Optional: Specify a global string variable that can be used to dynamically provide tooltip string. If you do not require for tooltip to change, then please use tooltip property in Widget Properties.

Widget Specific Properties[edit]

Title: no description

Height: no description

Width: no description

Auto Scale: Enable/Disable auto scale, select expandOnly to track min/max scale value.

X-Axis Minimum Value: Specify the minimum value of the X-axis

X-Axis Maximum Value: Specify the maximum value of the X-axis

Show X-Axis Ticks: no description

X-Axis Label: Specify the text to be displayed as the X-axis label.

Y-Axis Minimum Value: Specify the minimum value of the Y-axis

Y-Axis Maximum Value: Specify the maximum value of the Y-axis

Show Y-Axis Ticks: no description

Y-Axis Label: Specify the text to be displayed as the Y-axis label.

Series 0 Label: no description

Series 1 Label: no description

Series 0 Color: no description

Series 1 Color: no description

Background Color: no description

Show Grid Lines: Show the horizontal and vertical grid lines.

Show Series Line: Show the line that connect the data points for each series.

Show Legend: no description

Disabled: Specify whether the widget should be disabled.

Visible: Specify whether widget is visible or hidden.

Read Only: Specify whether the widget is read only.

Tooltip: Static text to display in tooltip popup.

{{

switchcategory:MultiCore=

For technical support on MultiCore devices, please post your questions in the C6000 MultiCore Forum
For questions related to the BIOS MultiCore SDK (MCSDK), please use the BIOS Forum

Please post only comments related to the article GUI Composer Widgets And Properties here.

Keystone=

For technical support on MultiCore devices, please post your questions in the C6000 MultiCore Forum
For questions related to the BIOS MultiCore SDK (MCSDK), please use the BIOS Forum

Please post only comments related to the article GUI Composer Widgets And Properties here.

C2000=For technical support on the C2000 please post your questions on The C2000 Forum. Please post only comments about the article GUI Composer Widgets And Properties here.

DaVinci=For technical support on DaVincoplease post your questions on The DaVinci Forum. Please post only comments about the article GUI Composer Widgets And Properties here.

MSP430=For technical support on MSP430 please post your questions on The MSP430 Forum. Please post only comments about the article GUI Composer Widgets And Properties here.

OMAP35x=For technical support on OMAP please post your questions on The OMAP Forum. Please post only comments about the article GUI Composer Widgets And Properties here.

OMAPL1=For technical support on OMAP please post your questions on The OMAP Forum. Please post only comments about the article GUI Composer Widgets And Properties here.

MAVRK=For technical support on MAVRK please post your questions on The MAVRK Toolbox Forum. Please post only comments about the article GUI Composer Widgets And Properties here.

For technical support please post your questions at http://e2e.ti.com. Please post only comments about the article GUI Composer Widgets And Properties here.

}}

Links

Amplifiers & Linear
Audio
Broadband RF/IF & Digital Radio
Clocks & Timers
Data Converters

DLP & MEMS
High-Reliability
Interface
Logic
Power Management

Processors

Switches & Multiplexers
Temperature Sensors & Control ICs
Wireless Connectivity

GUI Composer Widgets And Properties

Contents

Overview[edit]

Add widgets [edit]

View/Edit Widget Properties [edit]

View/Edit Widget Layout [edit]

Widget Binding [edit]

GUI Composer Widgets[edit]

Button[edit]

Widget Binding Properties[edit]

Widget Specific Properties[edit]

CheckBox[edit]

Widget Binding Properties[edit]

Widget Specific Properties[edit]

CheckBoxGroup[edit]

Widget Binding Properties[edit]

Widget Specific Properties[edit]

CheckedListBox[edit]

Widget Binding Properties[edit]

Widget Specific Properties[edit]

ComboBox[edit]

Widget Binding Properties[edit]

Widget Specific Properties[edit]

Container[edit]

Widget Binding Properties[edit]

Widget Specific Properties[edit]

ContentPane[edit]

Widget Binding Properties[edit]

Widget Specific Properties[edit]

DropDownSelect[edit]

Widget Binding Properties[edit]

Widget Specific Properties[edit]

GroupBox[edit]

Widget Binding Properties[edit]

Widget Specific Properties[edit]

HorizontalRuleLabels[edit]

Widget Binding Properties[edit]

Widget Specific Properties[edit]

HorizontalRule[edit]

Widget Binding Properties[edit]

Widget Specific Properties[edit]

HorizontalSlider[edit]

Widget Binding Properties[edit]

Widget Specific Properties[edit]

HyperLink[edit]

Widget Binding Properties[edit]

Widget Specific Properties[edit]

Image[edit]

Widget Binding Properties[edit]

Widget Specific Properties[edit]

Label[edit]

Widget Binding Properties[edit]

Widget Specific Properties[edit]

ListBox[edit]

Widget Binding Properties[edit]

Widget Specific Properties[edit]

MultiImage[edit]

Widget Binding Properties[edit]

Widget Specific Properties[edit]

MultiSelect[edit]

Widget Binding Properties[edit]

Widget Specific Properties[edit]

MultiListBox[edit]

Widget Binding Properties[edit]

Widget Specific Properties[edit]

NumberSpinner[edit]

Widget Binding Properties[edit]

Widget Specific Properties[edit]

ProgressBar[edit]

Widget Binding Properties[edit]

Widget Specific Properties[edit]

RadioButtonGroup[edit]

Widget Binding Properties[edit]

Widget Specific Properties[edit]

RadioListBox[edit]

Widget Binding Properties[edit]

Widget Specific Properties[edit]

TabContainer[edit]

Widget Binding Properties[edit]

Widget Specific Properties[edit]