User:Jcreer/SMS:DMI Check Box Elements

From XMS Wiki
< User:JcreerThis is the approved revision of this page, as well as being the most recent.
Jump to navigationJump to search


Elements

Element <check_box>
Info Widget that displays text that is checked/unchecked.
Versions 1, 2
Attributes

default, export_text_checked, export_text_unchecked, text, unique_name,

Children dependency, text_style
Used by item
Example
<check_box>                       	
   <text>Calculate Sediment Transport</text>
   <default>checked</default>
   <unique_name>togCalcSedimentTransport</unique_name>
   <export_text_checked>ON</export_text_checked>
   <export_text_unchecked>OFF</export_text_unchecked>
   <dependency>…</dependency>…
</ check_box >

Attributes

Attribute @ <default>
Info

Sets the initial default value of a widget. Can also be used to state the default combo-box option.

Values

edit_box or any element that begins with “custom_control”:

  • double

check_box:

  • checked
  • unchecked

combo_box:

  • no values or empty string

export_optional:

  • true
  • false
Version 1
Used by

edit_box, check_box, option, any element that begins with “control” (“custom_control” in version 1), combo_box, export_optional

Attribute @ <export_text_checked>
Info

Specified the text to be exported when the check box is set to true

Values string
Version 1
Used by check_box
Attribute @ <export_text_unchecked>
Info

Specified the text to be exported when the check box is set to false

Values string
Version 1
Used by check_box
Attribute @ <text>
Info

Text that is displayed in the SMS user interface.

Values any text string
Version 1
Used by

group, item, text_box, check_box, option, x_column, y_column, column, row, display_options, menu_item declare_page executable

Attribute @ <unique_name>
Info

A unique name given to an widget, which determines how to reference the widget. This is needed if the widget is being used as a dependency (parent), or if the widget value is being exported. When a unique_name is being referenced it should be by the file (nothing if current file), then unique_name. No spaces or punctuation (except _) are allowed in the name. The name must contain at least 1 non-numeric letter. The name must be unique. Names are not case sensitive, hence “aaa” is the same as “AAA”.

Values string (unique)
Version 1
Used by card, text_box, combo_box, edit_box, table, all elements starting with “custom_control”, check_box, text_box, control_curve