Difference between revisions of "Component: Panel Console Viewer (Runtime Tools)"

From Flowcode Help
Jump to navigationJump to search
(XML import)
 
 
(32 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
 
+
{| style="width:50%"
−
{| width="50%"
 
 
|-
 
|-
−
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| Matrix Ltd
 
| Matrix Ltd
 
|-
 
|-
−
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
−
| 1.1 (Release)
+
| 1.1
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| Runtime Tools
 
| Runtime Tools
 
|}
 
|}
 +
 +
 +
==Panel Console Viewer component==
 +
An easy way to display the data from up to four console windows on the panel.
 +
 +
==Component Source Code==
 +
 +
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_DynamicTextField.fcfx FC_Comp_Source_DynamicTextField.fcfx]
 +
 +
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_DynamicTextField.fcfx FC_Comp_Source_DynamicTextField.fcfx]
 +
 +
==Detailed description==
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
  
  
  
−
==[[File:Component Icon 06db27a4_c20a_4371_b05e_7cdb55556859.png|Image]] Panel Console Viewer component==
+
''No detailed description exists yet for this component''
−
An easy way to display the data from a console on the panel.
 
−
Links to a component that generates console data.
 
  
 
==Examples==
 
==Examples==
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 +
 
''<span style="color:red;">No additional examples</span>''
 
''<span style="color:red;">No additional examples</span>''
  
  
−
==Downloadable macro reference==
 
  
−
''This component does not contain any downloadable macros''
 
  
−
==Simulation macro reference==
 
  
−
''This component does not contain any simulation macros''
 
  
  
−
==Property reference==
 
−
<span style="font-weight: normal;"><u>Connect To</u></span>
 
  
−
This property is of type ''Panel object'' and can be referenced with the variable name ''ConnectTo''.
 
  
−
''<span style="color:red;">No additional information</span>''
 
  
  
  
−
<span style="font-weight: normal;"><u>Width</u></span>
 
  
−
This property is of type ''Floating point'' and can be referenced with the variable name ''Width''.
 
  
−
Width of the console ripper component.
 
  
−
<span style="font-weight: normal;"><u>Number of lines</u></span>
 
  
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''NumLines''.
 
  
−
''<span style="color:red;">No additional information</span>''
 
  
  
  
−
<span style="font-weight: normal;"><u>Clear Old Data</u></span>
 
  
−
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.
+
==Macro reference==
 +
 
 +
===AppendText===
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''AppendText'''
 +
|-
 +
| colspan="2" | Allows the text to be appended to without overwriting any existing text.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Item
 +
|-
 +
| colspan="2" | 0=Title, 1=Col1, 2=Col2, 3=Col3, 4=Col4&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Text
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | AppendType
 +
|-
 +
| colspan="2" | 0=Start of Text, 1=End of Text&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 
 +
 
 +
===AssignConsoleHandle===
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''AssignConsoleHandle'''
 +
|-
 +
| colspan="2" | Assigns a specific console handle to one of the text fields.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Item
 +
|-
 +
| colspan="2" | 1=Col1, 2=Col2, 3=Col3, 4=Col4&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-h32-icon.png]] - HANDLE
 +
| width="90%" | ConsoleHandle
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 
 +
 
 +
===GetText===
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetText'''
 +
|-
 +
| colspan="2" | Allows the selected text to be read back.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Item
 +
|-
 +
| colspan="2" | 0=Title, 1=Col1, 2=Col2, 3=Col3, 4=Col4&nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 
 +
 
 +
===SetColor===
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetColor'''
 +
|-
 +
| colspan="2" | Sets the selected item's color.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Item
 +
|-
 +
| colspan="2" | 0=Title, 1=Col1, 2=Col2, 3=Col3, 4=Col4, 5=Border&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u32-icon.png]] - ULONG
 +
| width="90%" | Color
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 
 +
 
 +
===SetText===
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetText'''
 +
|-
 +
| colspan="2" | Allows the selected text to be specified.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Item
 +
|-
 +
| colspan="2" | 0=Title, 1=Col1, 2=Col2, 3=Col3, 4=Col4&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | Text
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
 +
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 +
|}
 +
 
 +
 
 +
==Property reference==
 +
 
 +
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 +
|-
 +
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 +
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 +
| width="90%" | Width
 +
|-
 +
| colspan="2" | Width of the console ripper component.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 +
| width="90%" | Height
 +
|-
 +
| colspan="2" | Heigth of the console ripper component.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 +
| width="90%" | Title Size
 +
|-
 +
| colspan="2" | Size applied to the title text font.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-15-icon.png]]
 +
| width="90%" | Text Size
 +
|-
 +
| colspan="2" | Size applied to the data text font.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Number Columns
 +
|-
 +
| colspan="2" | Sets the maximum number of consoles that can be displayed by the component.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Title Color
 +
|-
 +
| colspan="2" | Sets the colour of the title text.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Text1 Color
 +
|-
 +
| colspan="2" | Sets the colour of the data text 1.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Text2 Color
 +
|-
 +
| colspan="2" | Sets the colour of the data text 2.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-1-icon.png]]
 +
| width="90%" | Border Color
 +
|-
 +
| colspan="2" | Sets the colour of the border.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | Show Title
 +
|-
 +
| colspan="2" | Decides if the title text is displayed.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
 +
| width="90%" | Clear Old Data
 +
|-
 +
| colspan="2" | Removes old data from the console viewer when starting simulation if active.&nbsp;
 +
|}

Latest revision as of 13:09, 7 February 2023

Author Matrix Ltd
Version 1.1
Category Runtime Tools


Panel Console Viewer component

An easy way to display the data from up to four console windows on the panel.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_DynamicTextField.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_DynamicTextField.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples












Macro reference

AppendText

Fc9-comp-macro.png AppendText
Allows the text to be appended to without overwriting any existing text. 
Fc9-u8-icon.png - BYTE Item
0=Title, 1=Col1, 2=Col2, 3=Col3, 4=Col4 
Fc9-string-icon.png - STRING Text
 
Fc9-u8-icon.png - BYTE AppendType
0=Start of Text, 1=End of Text 
Fc9-void-icon.png - VOID Return


AssignConsoleHandle

Fc9-comp-macro.png AssignConsoleHandle
Assigns a specific console handle to one of the text fields. 
Fc9-u8-icon.png - BYTE Item
1=Col1, 2=Col2, 3=Col3, 4=Col4 
Fc9-h32-icon.png - HANDLE ConsoleHandle
 
Fc9-void-icon.png - VOID Return


GetText

Fc9-comp-macro.png GetText
Allows the selected text to be read back. 
Fc9-u8-icon.png - BYTE Item
0=Title, 1=Col1, 2=Col2, 3=Col3, 4=Col4 
Fc9-string-icon.png - STRING Return


SetColor

Fc9-comp-macro.png SetColor
Sets the selected item's color. 
Fc9-u8-icon.png - BYTE Item
0=Title, 1=Col1, 2=Col2, 3=Col3, 4=Col4, 5=Border 
Fc9-u32-icon.png - ULONG Color
 
Fc9-void-icon.png - VOID Return


SetText

Fc9-comp-macro.png SetText
Allows the selected text to be specified. 
Fc9-u8-icon.png - BYTE Item
0=Title, 1=Col1, 2=Col2, 3=Col3, 4=Col4 
Fc9-string-icon.png - STRING Text
 
Fc9-void-icon.png - VOID Return


Property reference

Fc9-prop-icon.png Properties
Fc9-type-15-icon.png Width
Width of the console ripper component. 
Fc9-type-15-icon.png Height
Heigth of the console ripper component. 
Fc9-type-15-icon.png Title Size
Size applied to the title text font. 
Fc9-type-15-icon.png Text Size
Size applied to the data text font. 
Fc9-type-16-icon.png Number Columns
Sets the maximum number of consoles that can be displayed by the component. 
Fc9-type-1-icon.png Title Color
Sets the colour of the title text. 
Fc9-type-1-icon.png Text1 Color
Sets the colour of the data text 1. 
Fc9-type-1-icon.png Text2 Color
Sets the colour of the data text 2. 
Fc9-type-1-icon.png Border Color
Sets the colour of the border. 
Fc9-type-7-icon.png Show Title
Decides if the title text is displayed. 
Fc9-type-7-icon.png Clear Old Data
Removes old data from the console viewer when starting simulation if active. 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Panel_Console_Viewer_(Runtime_Tools)&oldid=37923"