ICharacterDisplay Interface Reference

Inheritance diagram for ICharacterDisplay:

Public Member Functions
Task	SetCursorPosition (int left, int top)
	Set left/right cursor position More...
Task	Write (dynamic value)
	Write text More...
Task	WriteLine (dynamic value)
	Write a line of text, advancing the cursor to the next line More...
Task	Clear ()
	Clear the display and reset the cursor to (0,0) More...

Properties
int	Columns [get]
	Number of columns of the display More...
int	Rows [get]
	Number of rows of the display More...
int	CursorLeft [get, set]
	Cursor left position More...
int	CursorTop [get, set]
	Cursor top position More...

Member Function Documentation

SetCursorPosition()

Task SetCursorPosition	(	int	left,
		int	top
	)

Set left/right cursor position

Parameters

left	The left position
top	The top position

Returns

An awaitable task that completes once the cursor is updated

Implemented in MonoGraphicDisplay, and CharacterDisplay.

Write()

Task Write

(

dynamic

value

)

Write text

Parameters

value

the text to write

Returns

An awaitable task that completes when finished

Implemented in MonoGraphicDisplay, and CharacterDisplay.

WriteLine()

Task WriteLine

(

dynamic

value

)

Write a line of text, advancing the cursor to the next line

Parameters

value

the text to write

Returns

An awaitable task that completes when finished

Implemented in MonoGraphicDisplay, and CharacterDisplay.

Clear()

Task Clear

(

)

Clear the display and reset the cursor to (0,0)

Returns

An awaitable task that completes when finished

Implemented in MonoGraphicDisplay, and CharacterDisplay.

Property Documentation

Columns

int Columns

get

Number of columns of the display

Rows

int Rows

get

Number of rows of the display

CursorLeft

int CursorLeft

getset

Cursor left position

CursorTop

int CursorTop

getset

Cursor top position

---

The documentation for this interface was generated from the following file:

• F:/Git/treehopper-sdk/NET/API/Treehopper.Libraries/Displays/ICharacterDisplay.cs