TextWindow

The TextWindow provides text-related input and output functionalities. For example using this class, it is possible to write or read some text or number to and from the text-based text window.

Properties

ForegroundColor

TextWindow.ForegroundColor

Gets or sets the foreground color of the text to be output in the text window.

BackgroundColor

TextWindow.BackgroundColor

Gets or sets the background color of the text to be output in the text window.

CursorLeft

TextWindow.CursorLeft

Gets or sets the cursor's column position on the text window.

CursorTop

TextWindow.CursorTop

Gets or sets the cursor's row position on the text window.

Left

TextWindow.Left

Gets or sets the Left position of the Text Window.

Title

TextWindow.Title

Gets or sets the Title for the text window.

Top

TextWindow.Top

Gets or sets the Top position of the Text Window.

Operations

Show

TextWindow.Show()

Shows the Text window to enable interactions with it.

Returns

Nothing

Hide

TextWindow.Hide()

Hides the text window.

Returns

Nothing

Clear

TextWindow.Clear()

Clears the TextWindow.

Returns

Nothing

Pause

TextWindow.Pause()

Waits for user input before returning.

Returns

Nothing

PauseIfVisible

TextWindow.PauseIfVisible()

Waits for user input only when the TextWindow is already open.

Returns

Nothing

PauseWithoutMessage

TextWindow.PauseWithoutMessage()

Waits for user input before returning.

Returns

Nothing

Read

TextWindow.Read()

Reads a line of text from the text window. This function will not return until the user hits ENTER.

Returns

The text that was read from the text window

ReadKey

TextWindow.ReadKey()

Reads a single character from the text window.

Returns

The character that was read from the text window.

ReadNumber

TextWindow.ReadNumber()

Reads a number from the text window. This function will not return until the user hits ENTER.

Returns

The number that was read from the text window

WriteLine

TextWindow.WriteLine(data)

Writes text or number to the text window. A new line character will be appended to the output, so that the next time something is written to the text window, it will go in a new line.

data

The text or number to write to the text window.

Returns

Nothing

Write

TextWindow.Write(data)

Writes text or number to the text window. A new line character will be appended to the output, so that the next time something is written to the text window, it will go in a new line.

data

The text or number to write to the text window.

Returns

Nothing