Component: Dashboard Text (Runtime Tools)

Author	Matrix Ltd
Version	1.1
Category	Runtime Tools

Dashboard Text component

A simulation only text box that can be used to display text and numbers.

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Downloadable macro reference

	Clear
Remove all text from the display.
- VOID	Return

	PrintString
Add the given text to the display immediately after the most recent character and without beginning a new line.
- STRING	Text
The text to add to the display.
- VOID	Return

	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.
[[File:]] -	Number
- BYTE	Places
- VOID	Return

	PrintLine
DIsplay the given string on a new line. If the display is full, it will scroll upwards to make space.
- STRING	Text
The text to add to the display.
- VOID	Return

	ReceiveString
Gets a string from the receive buffer
- UINT	MaxChars
- UINT	Timeout
Time in milliseconds to wait for data
- STRING	Return

	Initialise
Initialises the UART component pins ready to send and receive data
- VOID	Return

	ReceiveString
Receives a string of bytes and returns the number of bytes received.
- STRING	StringData
- UINT	NumBytes
Maximum number of bytes to try and receive
- UINT	Timeout
Max amount of time in ms to wait between bytes
- BYTE	Return

	Start
Startup routine required by the hardware device. Automatically clears the display after initialising.
- VOID	Return

	SetLEDState
Sets the state of a single LED
- BYTE	Port
0 = PortA, 1 = PortB
- BYTE	LED
0 = LED0, 7 = LED7
- BYTE	State
- VOID	Return

	GetRxIdent
Gets the Rx ID as a Integer Standard and Extended IDs.
- BYTE	Buffer
- ULONG	Return

	Initialise
Must be called before any other CAN component macros to enable and initialise the CAN peripheral.
- VOID	Return

Property reference

	Properties
	Start Text
Set the text that will appear when the component is initialised.
	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
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
Choose whether text will be aligned to the left, right or centre of the box width.
	Vertical Align
Choose whether text will be aligned wih the top, bottom or middle of the box height.
	Text
Color for the text characters.
	Background
Color for the box background.
	Bezel
Color for the bezel (3D border)
	Thickness
The thickness of the bezel (3D border). This thickness will be maintained even when the component is resized.
	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.
	Connections
	Simulations