User:Jcreer/SMS:DMI Text Elements: Difference between revisions

From XMS Wiki
Jump to navigationJump to search
No edit summary
 
(28 intermediate revisions by the same user not shown)
Line 1: Line 1:
__NOINDEX__
{{TOCright}}
{{TOCright}}
The Dynamic Model Interface offeres a number of ways to format and adjust text.
==Elements==
==Elements==
=====Element ''<bold>''=====
{|class="wikitable"
|-
|width="70"|'''Info'''
|width="530"|Sets the text to be bolded. Added in SMS 11.2.
|-
|'''Versions'''
|1, 2
|-
|'''Attributes'''
|none
|-
|'''Children'''
|none
|-
|'''Used by'''
|[[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]]
|-
|'''Example'''
|
This would bold the text when the value in the edit_box is less than 0.0.
<edit_box>
  <unique_name>edtA</unique_name>
  <default>1.0</default>
  <text_style>
      <bold></bold>
      <condition>edtA LESS_THAN 0.0</condition>
  <text_style>
</edit_box>
|}
=====Element ''<color>''=====
=====Element ''<color>''=====
{|class="wikitable"
{|class="wikitable"
Line 44: Line 13:
|-
|-
|'''Attributes'''
|'''Attributes'''
|none
|[[SMS:Dynamic Model Interface Schema#Element <red>|red]], [[SMS:Dynamic Model Interface Schema#Element <green>|green]], [[SMS:Dynamic Model Interface Schema#Element <blue>|blue]]
|-
|-
|'''Children'''
|'''Children'''
|[[SMS:Dynamic Model Interface Schema#Element <red>|red]], [[SMS:Dynamic Model Interface Schema#Element <green>|green]], [[SMS:Dynamic Model Interface Schema#Element <blue>|blue]]
|none
|-
|-
|'''Used by'''
|'''Used by'''
Line 95: Line 64:
|}
|}


=====Element ''<green>''=====
=====Element ''<text_box>''=====
{|class="wikitable"
{|class="wikitable"
|-
|-
|width="70"|'''Info'''
|width="70"|'''Info'''
|width="530"| The green element of a color. Ranges from 0 to 255. Added in SMS 11.2.   
|width="530"| Widget that displays text that is not editable.   
|-
|-
|'''Versions'''
|'''Versions'''
Line 108: Line 77:
|-
|-
|'''Children'''
|'''Children'''
|width="530"| none
|width="530"| [[SMS:Dynamic Model Interface Schema#Element <text>|text]], [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <unique_name>|unique_name]], [[SMS:Dynamic Model Interface Schema#Element <alignH>|alignH]], [[SMS:Dynamic Model Interface Schema#Element <alignV>|alignV]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]]
|-
|-
|'''Used by'''
|'''Used by'''
| width="530"| [[SMS:Dynamic Model Interface Schema#Element <color>|color]]
| width="530"| [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]], [[SMS:Dynamic Model Interface Schema#Element <column>|column]]
|-
|-
|'''Example'''
|'''Example'''
|width="530"| This would change the text to a bright red color.
|width="530"|
  <text_style>                     
  <text_box>                     
     <color>
     <text>Time Step:</text>
      <red>255</red>
    <unique_name>Transport_TS</unique_name>
      <green>0</green>
    <alignH>LEFT</alignH>
      <blue>0</blue>
     <dependency>…</dependency>…
     </color>
  </text_box>
  <text_style>
|}
|}


=====Element ''<red>''=====
=====Element ''<text_style>''=====
{|class="wikitable"
{|class="wikitable"
|-
|-
|width="70"|'''Info'''
|width="70"|'''Info'''
|width="530"| The red element of a color. Ranges from 0 to 255. Added in SMS 11.2.   
|width="530"| Holds the style options for the text. Added in SMS 11.2.   
|-
|-
|'''Versions'''
|'''Versions'''
Line 140: Line 108:
|-
|-
|'''Used by'''
|'''Used by'''
| width="530"| [[SMS:Dynamic Model Interface Schema#Element <color>|color]]
| width="530"| [[SMS:Dynamic Model Interface Schema#Element <group>|group]], [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <text_box>|text_box]], [[SMS:Dynamic Model Interface Schema#Element <combo_box>|combo_box]], [[SMS:Dynamic Model Interface Schema#Element <edit_box>|edit_box]], all elements starting with “custom_control”, [[SMS:Dynamic Model Interface Schema#Element <check_box>|check_box]], [[SMS:Dynamic Model Interface Schema#Element <options>|options]]
|-
|-
|'''Example '''
|'''Example'''
|width="530"|This would change the text to a bright red color.
|width="530"|This would bold the text when the value in the edit_box is less than 0.0.
  <text_style>                      
  <edit_box>
    <color>
  <unique_name>edtA</unique_name>
      <red>255</red>
  <default>1.0</default>
       <green>0</green>
  <text_style>
       <blue>0</blue>
       <bold></bold>
    </color>
       <condition>edtA LESS_THAN 0.0</condition>
  <text_style>
  <text_style>
  </edit_box>
|}
|}


=====Element ''<strike_through>''=====
==Attributes==
=====Attribute @ ''<alignH>''=====
{|class="wikitable"
{|class="wikitable"
|-
|-
|width="70"|'''Info'''
|width="70"|'''Info'''
|width="530"| Sets the text to have a line through the middle. Added in SMS 11.2.
|width="530"|Align text horizontally in a text box.  
|-
|'''Values'''
|
*“BOTTOM”
*“TOP”
*“CENTER’
|-
|'''Version'''
|1
|-
|'''Used by'''
|text_box
|}
 
=====Attribute @ ''<alignV>''=====
{|class="wikitable"
|-
|-
|'''Versions'''
|width="70"|'''Info'''
| 1, 2
|width="530"|Align text vertically in a text box.
|-
|-
|'''Attributes'''
|'''Values'''
|none
|
*“BOTTOM”
*“TOP”
*“CENTER’
|-
|-
|'''Children'''
|'''Version'''
|width="530"| none
|1
|-
|-
|'''Used by'''
|'''Used by'''
| width="530"| [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]]
|text_box
|}
 
=====Attribute @ ''<blue>'', Attribute @ ''<green>'', Attribute @ ''<red>''=====
{|class="wikitable"
|-
|width="70"|'''Info'''
|width="530"|A color. Ranges from 0 to 255. Added in SMS 11.2.
|-
|'''Values'''
|integer (0 to 255)
|-
|-
|'''Example '''
|'''Version'''
|width="530"|This would put a line through the text when the value in the edit_box is less than 0.0.
|1
<edit_box>
|-
  <unique_name>edtA</unique_name>
|'''Used by'''
  <default>1.0</default>
|color
  <text_style>
      <strike_through></strike_through>
      <condition>edtA LESS_THAN 0.0</condition>
  <text_style>
</edit_box>
|}
|}


=====Element ''<text>''=====
=====Attribute @ ''<bold>''=====
{|class="wikitable"
{|class="wikitable"
|-
|-
|width="70"|'''Info'''
|width="70"|'''Info'''
|width="530"| Text that is displayed in the SMS user interface.
|width="530"|Sets the text to be bolded when this attribute is used. Added in SMS 11.2.
|-
|'''Versions'''
| 1, 2
|-
|-
|'''Attributes'''
|'''Values'''
|none
|none
|-
|-
|'''Children'''
|'''Version'''
|width="530"| none
|1
|-
|-
|'''Used by'''
|'''Used by'''
| width="530"| [[SMS:Dynamic Model Interface Schema#Element <group>|group]], [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <text_box>|text_box]], [[SMS:Dynamic Model Interface Schema#Element <check_box>|check_box]], [[SMS:Dynamic Model Interface Schema#Element <options>|options]], [[SMS:Dynamic Model Interface Schema#Element <x_column>|x_column]], [[SMS:Dynamic Model Interface Schema#Element <y_column>|y_column]]
|text_style
|-
|'''Example'''
|width="530"|
|}
|}


=====Element ''<text_box>''=====
=====Attribute @ ''<italic>''=====
{|class="wikitable"
{|class="wikitable"
|-
|-
|width="70"|'''Info'''
|width="70"|'''Info'''
|width="530"| Widget that displays text that is not editable.
|width="530"|Sets the text to be italicized when the element is specified. Added in SMS 11.2.
|-
|-
|'''Versions'''
|'''Values'''
| 1, 2
|-
|'''Attributes'''
|none
|none
|-
|-
|'''Children'''
|'''Version'''
|width="530"| [[SMS:Dynamic Model Interface Schema#Element <text>|text]], [[SMS:Dynamic Model Interface Schema#Element <dependency>|dependency]], [[SMS:Dynamic Model Interface Schema#Element <unique_name>|unique_name]], [[SMS:Dynamic Model Interface Schema#Element <alignH>|alignH]], [[SMS:Dynamic Model Interface Schema#Element <alignV>|alignV]], [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]]
|1
|-
|-
|'''Used by'''
|'''Used by'''
| width="530"| [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <row>|row]], [[SMS:Dynamic Model Interface Schema#Element <column>|column]]
|text_style
|-
|'''Example'''
|width="530"|
<text_box>                     
    <text>Time Step:</text>
    <unique_name>Transport_TS</unique_name>
    <alignH>LEFT</alignH>
    <dependency>…</dependency>…
</text_box>
|}
|}


=====Element ''<text_size>''=====
=====Attribute @ ''<strike_through>''=====
{|class="wikitable"
{|class="wikitable"
|-
|-
|width="70"|'''Info'''
|width="70"|'''Info'''
|width="530"| Sets the point size of the text. Ranges from 8 to 20. Added in SMS 11.2.
|width="530"|
|-
Sets the text to have a line through the middle when the element is specified. Added in SMS 11.2.
|'''Versions'''
 
| 1, 2
|-
|-
|'''Attributes'''
|'''Values'''
|none
|none
|-
|-
|'''Children'''
|'''Version'''
|width="530"| none
|1
|-
|-
|'''Used by'''
|'''Used by'''
| width="530"| [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]]
|text_style
|-
|'''Example'''
|width="530"|This would set the size of the text to 20pt. when the value in the [[SMS:Dynamic Model Interface Schema#Element <edit_box>|edit_box]] is less than 0.0.
<edit_box>
  <unique_name>edtA</unique_name>
  <default>1.0</default>
  <text_style>
      <text_size>20</text_size>
      <condition>edtA LESS_THAN 0.0</condition>
  <text_style>
</edit_box>
|}
|}


=====Element ''<text_style>''=====
=====Attribute @ ''<text>''=====
{|class="wikitable"
{|class="wikitable"
|-
|-
|width="70"|'''Info'''
|width="70"|'''Info'''
|width="530"| Holds the style options for the text. Added in SMS 11.2.
|width="530"|
|-
Text that is displayed in the SMS user interface.
|'''Versions'''
 
| 1, 2
|-
|-
|'''Attributes'''
|'''Values'''
|none
|any text string
|-
|-
|'''Children'''
|'''Version'''
|width="530"| none
|1
|-
|-
|'''Used by'''
|'''Used by'''
| width="530"| [[SMS:Dynamic Model Interface Schema#Element <group>|group]], [[SMS:Dynamic Model Interface Schema#Element <item>|item]], [[SMS:Dynamic Model Interface Schema#Element <text_box>|text_box]], [[SMS:Dynamic Model Interface Schema#Element <combo_box>|combo_box]], [[SMS:Dynamic Model Interface Schema#Element <edit_box>|edit_box]], all elements starting with “custom_control”, [[SMS:Dynamic Model Interface Schema#Element <check_box>|check_box]], [[SMS:Dynamic Model Interface Schema#Element <options>|options]]
|width="530"|group, item, text_box, check_box, option, x_column, y_column, column, row, display_options, menu_item declare_page executable
|-
|'''Example'''
|width="530"|This would bold the text when the value in the edit_box is less than 0.0.
<edit_box>
  <unique_name>edtA</unique_name>
  <default>1.0</default>
  <text_style>
      <bold></bold>
      <condition>edtA LESS_THAN 0.0</condition>
  <text_style>
</edit_box>
|}
|}


=====Element ''<type>''=====
=====Attribute @ ''<text_size>''=====
{|class="wikitable"
{|class="wikitable"
|-
|-
|width="70"|'''Info'''
|width="70"|'''Info'''
|width="530"| Determines if the [[SMS:Dynamic Model Interface Schema#Element <edit_box>|edit_box]] is displaying text, an integer or a double.
|width="530"|
|-
Sets the point size of the text. Ranges from 8 to 20. Added in SMS 11.2.
|'''Versions'''
 
| 1, 2
|-
|-
|'''Attributes'''
|'''Values'''
|none
|integer (8 to 20)
|-
|-
|'''Children'''
|'''Version'''
|width="530"| none
|1
|-
|-
|'''Used by'''
|'''Used by'''
| width="530"| [[SMS:Dynamic Model Interface Schema#Element <edit_box>|edit_box]]
|text_style
|}
 
=====Attribute @ ''<type>''=====
{|class="wikitable"
|-
|-
|'''Example 1'''
|width="70"|'''Info'''
|width="530"|
|width="530"|
<edit_box>                          
For <display_options> defines point, or arc
    <type>double</type>
 
…
</ edit_box >
|-
|-
|'''Example 2'''
|'''Values'''
|
|
<type>integer</type>
display_options
*“arc”
*“point”
edit_box
*“text”
*“integer”
*“double”
|-
|'''Version'''
|1
|-
|-
|'''Example 3'''
|'''Used by'''
|
|coverage, display_options, edit_box
<type>text</type>
|}
|}


=====Element ''<underline>''=====
=====Attribute @ ''<underline>''=====
{|class="wikitable"
{|class="wikitable"
|-
|-
|width="70"|'''Info'''
|width="70"|'''Info'''
|width="530"| Sets the text to be underlined. Added in SMS 11.2.
|width="530"|
Sets the text to be underlined when this attribute is specified. Added in SMS 11.2.
 
|-
|-
|'''Versions'''
|'''Values'''
| 1, 2
|-
|'''Attributes'''
|none
|none
|-
|-
|'''Children'''
|'''Version'''
|width="530"| none
|1
|-
|-
|'''Used by'''
|'''Used by'''
| width="530"| [[SMS:Dynamic Model Interface Schema#Element <text_style>|text_style]]
|text_style
|-
|'''Example'''
|width="530"|This would underline the text when the value in the edit_box is less than 0.0.
<edit_box>
  <unique_name>edtA</unique_name>
  <default>1.0</default>
  <text_style>
      <underline></underline>
      <condition>edtA LESS_THAN 0.0</condition>
  <text_style>
</edit_box>
|}
|}


==Attributes==
 
{{Navbox SMS}}
 
 
[[Category:Jcreer|DMI]]

Latest revision as of 16:14, 4 March 2019


The Dynamic Model Interface offeres a number of ways to format and adjust text.

Elements

Element <color>
Info The color of an item, expressed in red, green and blue values ranging from 0 to 255. All 0 values for red, green and blue is black. Added in SMS 11.2.
Versions 1, 2
Attributes red, green, blue
Children none
Used by text_style
Example

This would change the text to a bright red color. 

<text_style>                       	
   <color>
     <red>255</red>
     <green>0</green>
     <blue>0</blue>
   </color>
<text_style>
Element <edit_box>
Info Widget that displays text or numbers. If <type> not specified, default to double.
Versions 1, 2
Attributes none
Children type, default, unique_name, range, optional, dependency, text_style
Used by item, row, column
Example 
<edit_box>                       	
   <type>double</type>
   <range>0, 2.2</range>
   <default>1.0 </default>
   <unique_name>edtBox5</unique_name>
   <optional></optional>
   <dependency>…</dependency>…
</ edit_box
Element <text_box>
Info Widget that displays text that is not editable.
Versions 1, 2
Attributes none
Children text, dependency, unique_name, alignH, alignV, text_style
Used by item, row, column
Example 
<text_box>                       	
    <text>Time Step:</text>
    <unique_name>Transport_TS</unique_name>
    <alignH>LEFT</alignH>
    <dependency>…</dependency>…
</text_box>
Element <text_style>
Info Holds the style options for the text. Added in SMS 11.2.
Versions 1, 2
Attributes none
Children none
Used by group, item, text_box, combo_box, edit_box, all elements starting with “custom_control”, check_box, options
Example This would bold the text when the value in the edit_box is less than 0.0. 
<edit_box>
  <unique_name>edtA</unique_name>
  <default>1.0</default>
  <text_style>
      <bold></bold>
      <condition>edtA LESS_THAN 0.0</condition>
  <text_style>
</edit_box>

Attributes

Attribute @ <alignH>
Info Align text horizontally in a text box.
Values
  • “BOTTOM”
  • “TOP”
  • “CENTER’
Version 1
Used by text_box
Attribute @ <alignV>
Info Align text vertically in a text box.
Values
  • “BOTTOM”
  • “TOP”
  • “CENTER’
Version 1
Used by text_box
Attribute @ <blue>, Attribute @ <green>, Attribute @ <red>
Info A color. Ranges from 0 to 255. Added in SMS 11.2.
Values integer (0 to 255)
Version 1
Used by color
Attribute @ <bold>
Info Sets the text to be bolded when this attribute is used. Added in SMS 11.2.
Values none
Version 1
Used by text_style
Attribute @ <italic>
Info Sets the text to be italicized when the element is specified. Added in SMS 11.2.
Values none
Version 1
Used by text_style
Attribute @ <strike_through>
Info

Sets the text to have a line through the middle when the element is specified. Added in SMS 11.2.

Values none
Version 1
Used by text_style
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 @ <text_size>
Info

Sets the point size of the text. Ranges from 8 to 20. Added in SMS 11.2.

Values integer (8 to 20)
Version 1
Used by text_style
Attribute @ <type>
Info

For <display_options> defines point, or arc

Values

display_options

  • “arc”
  • “point”

edit_box

  • “text”
  • “integer”
  • “double”
Version 1
Used by coverage, display_options, edit_box
Attribute @ <underline>
Info

Sets the text to be underlined when this attribute is specified. Added in SMS 11.2.

Values none
Version 1
Used by text_style


v • e
SMS – Surface-water Modeling System
Modules:1D Grid  •   Cartesian Grid  •   Curvilinear Grid  •   GIS  •   Map  •   Mesh  •  Particle  •   Quadtree  •  Raster  •   Scatter   •   UGridSMS.png
General Models:3D Structure  •   FVCOM  •   Generic  •   PTM
Coastal Models:ADCIRC   •   BOUSS-2D  •   CGWAVE  •   CMS-Flow   •   CMS-Wave  •   GenCade  •   STWAVE  •   WAM
Riverine/Estuarine Models:AdH   •   HEC-RAS   •   HYDRO AS-2D   •   RMA2   •   RMA4   •   SRH-2D   •   TUFLOW   •   TUFLOW FV
Aquaveo   •   SMS Tutorials   •   SMS Workflows
Retrieved from "https://www.xmswiki.com/index.php?title=User:Jcreer/SMS:DMI_Text_Elements&oldid=138508"