User:Jcreer/SMS:DMI Check Box Elements: Difference between revisions

From XMS Wiki
Jump to navigationJump to search
(Created page with "=====Element ''<check_box>''===== {|class="wikitable" |- |width="70"|'''Info''' |width="530"|Widget that displays text that is checked/unchecked. |- |'''Versions''' |1, 2 |- |...")
 
No edit summary
 
(13 intermediate revisions by the same user not shown)
Line 1: Line 1:
__NOINDEX__
{{TOCright}}
==Elements==
=====Element ''<check_box>''=====
=====Element ''<check_box>''=====
{|class="wikitable"
{|class="wikitable"
Line 9: Line 12:
|-
|-
|'''Attributes'''
|'''Attributes'''
|none
|
default,
export_text_checked,
export_text_unchecked,
text,
unique_name,
|-
|-
|'''Children'''
|'''Children'''
|width="530"|[[SMS:Dynamic Model Interface Schema#Element <text>|text]], [[SMS:Dynamic Model Interface Schema#Element <default>|default]], [[SMS:Dynamic Model Interface Schema#Element <unique_name>|unique_name]], [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <export_text>|export_text_checked]], [[SMS:Dynamic Model Interface Schema#Element <export_text>|export_text_unchecked]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]]
|width="530"| [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]]
|-
|-
|'''Used by'''
|'''Used by'''
Line 29: Line 37:


|}
|}
==Attributes==
=====Attribute @ ''<default>''=====
{|class="wikitable"
|-
|width="70"|'''Info'''
|width="530"|
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'''
|width="530"|
edit_box, check_box, option, any element that begins with “control” (“custom_control” in version 1), combo_box, export_optional
|}
=====Attribute @ ''<export_text_checked>''=====
{|class="wikitable"
|-
|width="70"|'''Info'''
|width="530"|
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>''=====
{|class="wikitable"
|-
|width="70"|'''Info'''
|width="530"|
Specified the text to be exported when the check box is set to false
|-
|'''Values'''
|string
|-
|'''Version'''
|1
|-
|'''Used by'''
|check_box
|}
=====Attribute @ ''<text>''=====
{|class="wikitable"
|-
|width="70"|'''Info'''
|width="530"|
Text that is displayed in the SMS user interface.
|-
|'''Values'''
|any text string
|-
|'''Version'''
|1
|-
|'''Used by'''
|width="530"|
group, item, text_box, check_box, option, x_column, y_column, column, row, display_options, menu_item declare_page executable
|}
=====Attribute @ ''<unique_name>''=====
{|class="wikitable"
|-
|width="70"|'''Info'''
|width="530"|
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'''
|width="530"|card, text_box, combo_box, edit_box, table, all elements starting with “custom_control”, check_box, text_box, control_curve
|}
[[Category:Jcreer|DMI]]

Latest revision as of 16:14, 4 March 2019


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
Retrieved from "https://www.xmswiki.com/index.php?title=User:Jcreer/SMS:DMI_Check_Box_Elements&oldid=138510"