Component: Panel Console Viewer (Controls)

From Flowcode Help
Revision as of 14:20, 9 August 2013 by JonnyW (talk | contribs) (XML import of component documentation)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search


Author Matrix Ltd
Version 1.0
Category Controls


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

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

STRING


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.

No additional information


Text Size

This property is of type Floating point and can be referenced with the variable name TextSize.

Text size within the console ripper component.

Number Columns

This property is of type Fixed list of ints and can be referenced with the variable name NumCols.

No additional information


Title Color

This property is of type Color picker and can be referenced with the variable name TitleColor.

No additional information


Text1 Color

This property is of type Color picker and can be referenced with the variable name Text1Color.

No additional information


Text2 Color

This property is of type Color picker and can be referenced with the variable name Text2Color.

No additional information


Border Color

This property is of type Color picker and can be referenced with the variable name BorderColor.

No additional information


Show Title

This property is of type True or false and can be referenced with the variable name ShowTitle.

No additional information


Clear Old Data

This property is of type True or false and can be referenced with the variable name ClearOldData.

No additional information