Difference between revisions of "Component: Dashboard Text (Controls)"
(XML import) |
(XML import) |
||
| Line 1: | Line 1: | ||
| + | |||
| + | |||
{| width="50%" | {| width="50%" | ||
|- | |- | ||
| Line 5: | Line 7: | ||
|- | |- | ||
| width="20%" style="color: gray;" | Version | | width="20%" style="color: gray;" | Version | ||
| − | | 1.0 | + | | 1.0 (Release) |
|- | |- | ||
| width="20%" style="color: gray;" | Category | | width="20%" style="color: gray;" | Category | ||
| Line 14: | Line 16: | ||
==[[File:Component Icon 7ade85db_6ca2_48bf_b19c_8148ebda497b.png|Image]] Dashboard Text component== | ==[[File:Component Icon 7ade85db_6ca2_48bf_b19c_8148ebda497b.png|Image]] Dashboard Text component== | ||
| − | + | A simulation only text box that can be used to display text and numbers. | |
==Examples== | ==Examples== | ||
| Line 27: | Line 29: | ||
===<span style="font-weight: normal;"><u><tt>Clear</tt></u></span>=== | ===<span style="font-weight: normal;"><u><tt>Clear</tt></u></span>=== | ||
| − | + | Remove all text from the display. | |
| − | |||
| − | |||
'''Parameters''' | '''Parameters''' | ||
| Line 42: | Line 42: | ||
===<span style="font-weight: normal;"><u><tt>PrintString</tt></u></span>=== | ===<span style="font-weight: normal;"><u><tt>PrintString</tt></u></span>=== | ||
| − | + | Add the given text to the display immediately after the most recent character and | |
| − | |||
| + | without beginning a new line. | ||
'''Parameters''' | '''Parameters''' | ||
| − | :[[Variable Types|STRING]] '' | + | :[[Variable Types|STRING]] ''Text'' |
| + | ::The text to add to the display. | ||
| Line 57: | Line 58: | ||
===<span style="font-weight: normal;"><u><tt>PrintNumber</tt></u></span>=== | ===<span style="font-weight: normal;"><u><tt>PrintNumber</tt></u></span>=== | ||
| − | + | Write the given number to the display. It will be placed immediately after the last | |
| − | |||
| + | character on the display without beginning a new line. | ||
'''Parameters''' | '''Parameters''' | ||
| Line 74: | Line 75: | ||
===<span style="font-weight: normal;"><u><tt>PrintLine</tt></u></span>=== | ===<span style="font-weight: normal;"><u><tt>PrintLine</tt></u></span>=== | ||
| − | + | DIsplay the given string on a new line. If the display is full, it will scroll upwards to | |
| − | |||
| + | make space. | ||
'''Parameters''' | '''Parameters''' | ||
| − | :[[Variable Types|STRING]] '' | + | :[[Variable Types|STRING]] ''Text'' |
| + | ::The text to add to the display. | ||
| Line 95: | Line 97: | ||
This property is of type ''Multiple lines of text'' and can be referenced with the variable name ''text''. | This property is of type ''Multiple lines of text'' and can be referenced with the variable name ''text''. | ||
| − | + | Set the text that will appear when the component is initialised. | |
| + | <span style="font-weight: normal;"><u>Lines</u></span> | ||
| + | |||
| + | This property is of type ''Signed integer'' and can be referenced with the variable name ''lines''. | ||
| + | Set the number of lines of text that the display will show. | ||
| + | |||
| + | Lines will scroll off the top of the box once the display is full. | ||
<span style="font-weight: normal;"><u>Font</u></span> | <span style="font-weight: normal;"><u>Font</u></span> | ||
| Line 103: | Line 111: | ||
This property is of type ''Font picker'' and can be referenced with the variable name ''Font''. | This property is of type ''Font picker'' and can be referenced with the variable name ''Font''. | ||
| − | + | Choose the font for the text. Any font installed on your PC can be used. If your file is opened on another | |
| − | |||
| + | computer which does not have the specified font, an alternative will automatically be chosen. | ||
<span style="font-weight: normal;"><u>Horizontal Align</u></span> | <span style="font-weight: normal;"><u>Horizontal Align</u></span> | ||
| Line 111: | Line 119: | ||
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''AlignX''. | This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''AlignX''. | ||
| − | + | Choose whether text will be aligned to the left, right or centre of the box width. | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Vertical Align</u></span> | <span style="font-weight: normal;"><u>Vertical Align</u></span> | ||
| Line 119: | Line 125: | ||
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''AlignY''. | This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''AlignY''. | ||
| − | + | Choose whether text will be aligned wih the top, bottom or middle of the box height. | |
| − | |||
| − | |||
| − | <span style="font-weight: normal;"><u> | + | <span style="font-weight: normal;"><u>Text</u></span> |
This property is of type ''Color picker'' and can be referenced with the variable name ''Color''. | This property is of type ''Color picker'' and can be referenced with the variable name ''Color''. | ||
| − | + | Color for the text characters. | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Background</u></span> | <span style="font-weight: normal;"><u>Background</u></span> | ||
| Line 135: | Line 137: | ||
This property is of type ''Color picker'' and can be referenced with the variable name ''Background''. | This property is of type ''Color picker'' and can be referenced with the variable name ''Background''. | ||
| − | + | Color for the box background. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | <span style="font-weight: normal;"><u>Bezel</u></span> | |
| − | |||
| − | |||
| + | This property is of type ''Color picker'' and can be referenced with the variable name ''Bezel''. | ||
| + | Color for the bezel (3D border) | ||
<span style="font-weight: normal;"><u>Thickness</u></span> | <span style="font-weight: normal;"><u>Thickness</u></span> | ||
| Line 151: | Line 149: | ||
This property is of type ''Floating point'' and can be referenced with the variable name ''bezel_thick''. | This property is of type ''Floating point'' and can be referenced with the variable name ''bezel_thick''. | ||
| − | + | The thickness of the bezel (3D border). This thickness will be maintained even when the component is | |
| − | |||
| + | resized. | ||
<span style="font-weight: normal;"><u>Margin</u></span> | <span style="font-weight: normal;"><u>Margin</u></span> | ||
| Line 159: | Line 157: | ||
This property is of type ''Floating point'' and can be referenced with the variable name ''margin''. | This property is of type ''Floating point'' and can be referenced with the variable name ''margin''. | ||
| − | + | Set the margin size. This is used to insert a small blank space to the left and right of the text, so that | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | This | ||
| − | + | characters are not placed right up against the bezel. | |
Latest revision as of 11:25, 13 February 2015
| Author | Matrix Ltd |
| Version | 1.0 (Release) |
| Category | Controls |
Contents
Dashboard Text component
A simulation only text box that can be used to display text and numbers.
Examples
No additional examples
Downloadable macro reference
This component does not contain any downloadable macros
Simulation macro reference
Clear
Remove all text from the display.
Parameters
- This macro has no parameters
Return value
- This call does not return a value
PrintString
Add the given text to the display immediately after the most recent character and
without beginning a new line.
Parameters
- STRING Text
- The text to add to the display.
Return value
- This call does not return a value
PrintNumber
Write the given number to the display. It will be placed immediately after the last
character on the display without beginning a new line.
Parameters
- FLOAT Number
- BYTE Places
Return value
- This call does not return a value
PrintLine
DIsplay the given string on a new line. If the display is full, it will scroll upwards to
make space.
Parameters
- STRING Text
- The text to add to the display.
Return value
- This call does not return a value
Property reference
Start Text
This property is of type Multiple lines of text and can be referenced with the variable name text.
Set the text that will appear when the component is initialised.
Lines
This property is of type Signed integer and can be referenced with the variable name lines.
Set the number of lines of text that the display will show.
Lines will scroll off the top of the box once the display is full.
Font
This property is of type Font picker and can be referenced with the variable name Font.
Choose the font for the text. Any font installed on your PC can be used. If your file is opened on another
computer which does not have the specified font, an alternative will automatically be chosen.
Horizontal Align
This property is of type Fixed list of ints and can be referenced with the variable name AlignX.
Choose whether text will be aligned to the left, right or centre of the box width.
Vertical Align
This property is of type Fixed list of ints and can be referenced with the variable name AlignY.
Choose whether text will be aligned wih the top, bottom or middle of the box height.
Text
This property is of type Color picker and can be referenced with the variable name Color.
Color for the text characters.
Background
This property is of type Color picker and can be referenced with the variable name Background.
Color for the box background.
Bezel
This property is of type Color picker and can be referenced with the variable name Bezel.
Color for the bezel (3D border)
Thickness
This property is of type Floating point and can be referenced with the variable name bezel_thick.
The thickness of the bezel (3D border). This thickness will be maintained even when the component is
resized.
Margin
This property is of type Floating point and can be referenced with the variable name margin.
Set the margin size. This is used to insert a small blank space to the left and right of the text, so that
characters are not placed right up against the bezel.
