BenR: XML import

2018-05-09T10:26:58Z

XML import

New page

{| width="50%"
|-
| width="20%" style="color: gray;" | Author
| Matrix Ltd
|-
| width="20%" style="color: gray;" | Version
| 1.1 (Release)
|-
| width="20%" style="color: gray;" | Category
| Advanced Shapes
|}

==[[File:Component Icon 8e91085e_f978_404f_9de9_56424c4b56dd.png|Image]] 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==

===<tt>SetText</tt>===
Allows the selected text to be specified.

'''Parameters'''

:[[Variable Types|BYTE]] ''Item''
::0=Title, 1=Col1, 2=Col2, 3=Col3, 4=Col4

:[[Variable Types|<- STRING]] ''Text''
::''This parameter may be returned back to the caller''

'''Return value'''

:''This call does not return a value''

===<tt>GetText</tt>===
Allows the selected text to be read back.

'''Parameters'''

:[[Variable Types|BYTE]] ''Item''
::0=Title, 1=Col1, 2=Col2, 3=Col3, 4=Col4

'''Return value'''

:[[Variable Types|STRING]]

===<tt>AssignConsoleHandle</tt>===
Assigns a specific console handle to one of the text fields.

'''Parameters'''

:[[Variable Types|BYTE]] ''Item''
::1=Col1, 2=Col2, 3=Col3, 4=Col4

:[[Variable Types|HANDLE]] ''ConsoleHandle''

'''Return value'''

:''This call does not return a value''

===<tt>SetColor</tt>===
Sets the selected item's color.

'''Parameters'''

:[[Variable Types|BYTE]] ''Item''
::0=Title, 1=Col1, 2=Col2, 3=Col3, 4=Col4, 5=Border

:[[Variable Types|ULONG]] ''Color''

'''Return value'''

:''This call does not return a value''

===<tt>AppendText</tt>===
Allows the text to be appended to without overwriting any existing text.

'''Parameters'''

:[[Variable Types|BYTE]] ''Item''
::0=Title, 1=Col1, 2=Col2, 3=Col3, 4=Col4

:[[Variable Types|<- STRING]] ''Text''
::''This parameter may be returned back to the caller''

:[[Variable Types|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.

Component: Panel Console Viewer (Advanced Shapes) - Revision history

BenR: XML import