Difference between revisions of "Component: Panel Console Viewer (Controls)"
(XML import) |
(XML import) |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 7: | Line 7: | ||
|- | |- | ||
| width="20%" style="color: gray;" | Version | | width="20%" style="color: gray;" | Version | ||
| − | | 1. | + | | 1.1 (Release) |
|- | |- | ||
| width="20%" style="color: gray;" | Category | | width="20%" style="color: gray;" | Category | ||
| Line 130: | Line 130: | ||
This property is of type ''Floating point'' and can be referenced with the variable name ''TitleSize''. | This property is of type ''Floating point'' and can be referenced with the variable name ''TitleSize''. | ||
| − | + | Size applied to the title text font. | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Text Size</u></span> | <span style="font-weight: normal;"><u>Text Size</u></span> | ||
| Line 138: | Line 136: | ||
This property is of type ''Floating point'' and can be referenced with the variable name ''TextSize''. | This property is of type ''Floating point'' and can be referenced with the variable name ''TextSize''. | ||
| − | + | Size applied to the data text font. | |
<span style="font-weight: normal;"><u>Number Columns</u></span> | <span style="font-weight: normal;"><u>Number Columns</u></span> | ||
| Line 144: | Line 142: | ||
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''NumCols''. | This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''NumCols''. | ||
| − | + | Sets the maximum number of consoles that can be displayed by the component. | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Title Color</u></span> | <span style="font-weight: normal;"><u>Title Color</u></span> | ||
| Line 152: | Line 148: | ||
This property is of type ''Color picker'' and can be referenced with the variable name ''TitleColor''. | This property is of type ''Color picker'' and can be referenced with the variable name ''TitleColor''. | ||
| − | + | Sets the colour of the title text. | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Text1 Color</u></span> | <span style="font-weight: normal;"><u>Text1 Color</u></span> | ||
| Line 160: | Line 154: | ||
This property is of type ''Color picker'' and can be referenced with the variable name ''Text1Color''. | This property is of type ''Color picker'' and can be referenced with the variable name ''Text1Color''. | ||
| − | + | Sets the colour of the data text 1. | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Text2 Color</u></span> | <span style="font-weight: normal;"><u>Text2 Color</u></span> | ||
| Line 168: | Line 160: | ||
This property is of type ''Color picker'' and can be referenced with the variable name ''Text2Color''. | This property is of type ''Color picker'' and can be referenced with the variable name ''Text2Color''. | ||
| − | + | Sets the colour of the data text 2. | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Border Color</u></span> | <span style="font-weight: normal;"><u>Border Color</u></span> | ||
| Line 176: | Line 166: | ||
This property is of type ''Color picker'' and can be referenced with the variable name ''BorderColor''. | This property is of type ''Color picker'' and can be referenced with the variable name ''BorderColor''. | ||
| − | + | Sets the colour of the border. | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Show Title</u></span> | <span style="font-weight: normal;"><u>Show Title</u></span> | ||
| Line 184: | Line 172: | ||
This property is of type ''True or false'' and can be referenced with the variable name ''ShowTitle''. | This property is of type ''True or false'' and can be referenced with the variable name ''ShowTitle''. | ||
| − | + | Decides if the title text is displayed. | |
| − | |||
| − | |||
<span style="font-weight: normal;"><u>Clear Old Data</u></span> | <span style="font-weight: normal;"><u>Clear Old Data</u></span> | ||
| Line 192: | Line 178: | ||
This property is of type ''True or false'' and can be referenced with the variable name ''ClearOldData''. | This property is of type ''True or false'' and can be referenced with the variable name ''ClearOldData''. | ||
| − | + | Removes old data from the console viewer when starting simulation if active. | |
Latest revision as of 11:25, 13 February 2015
| Author | Matrix Ltd |
| Version | 1.1 (Release) |
| Category | Controls |
Contents
Panel Console Viewer component
An easy way to display the data from up to four console windows on the panel.
Examples
No additional examples
Downloadable macro reference
This component does not contain any downloadable macros
Simulation macro reference
SetText
Allows the selected text to be specified.
Parameters
- BYTE Item
- 0=Title, 1=Col1, 2=Col2, 3=Col3, 4=Col4
- <- STRING Text
- This parameter may be returned back to the caller
Return value
- This call does not return a value
GetText
Allows the selected text to be read back.
Parameters
- BYTE Item
- 0=Title, 1=Col1, 2=Col2, 3=Col3, 4=Col4
Return value
AssignConsoleHandle
Assigns a specific console handle to one of the text fields.
Parameters
- BYTE Item
- 1=Col1, 2=Col2, 3=Col3, 4=Col4
- HANDLE ConsoleHandle
Return value
- This call does not return a value
SetColor
Sets the selected item's color.
Parameters
- BYTE Item
- 0=Title, 1=Col1, 2=Col2, 3=Col3, 4=Col4, 5=Border
- ULONG Color
Return value
- This call does not return a value
AppendText
Allows the text to be appended to without overwriting any existing text.
Parameters
- BYTE Item
- 0=Title, 1=Col1, 2=Col2, 3=Col3, 4=Col4
- <- STRING Text
- This parameter may be returned back to the caller
- BYTE AppendType
- 0=Start of Text, 1=End of Text
Return value
- This call does not return a value
Property reference
Width
This property is of type Floating point and can be referenced with the variable name Width.
Width of the console ripper component.
Height
This property is of type Floating point and can be referenced with the variable name Height.
Heigth of the console ripper component.
Title Size
This property is of type Floating point and can be referenced with the variable name TitleSize.
Size applied to the title text font.
Text Size
This property is of type Floating point and can be referenced with the variable name TextSize.
Size applied to the data text font.
Number Columns
This property is of type Fixed list of ints and can be referenced with the variable name NumCols.
Sets the maximum number of consoles that can be displayed by the component.
Title Color
This property is of type Color picker and can be referenced with the variable name TitleColor.
Sets the colour of the title text.
Text1 Color
This property is of type Color picker and can be referenced with the variable name Text1Color.
Sets the colour of the data text 1.
Text2 Color
This property is of type Color picker and can be referenced with the variable name Text2Color.
Sets the colour of the data text 2.
Border Color
This property is of type Color picker and can be referenced with the variable name BorderColor.
Sets the colour of the border.
Show Title
This property is of type True or false and can be referenced with the variable name ShowTitle.
Decides if the title text is displayed.
Clear Old Data
This property is of type True or false and can be referenced with the variable name ClearOldData.
Removes old data from the console viewer when starting simulation if active.
