Platforms to show: All Mac Windows Linux Cross-Platform

Back to WindowsConsoleMBS class.

WindowsConsoleMBS.AutoScrollAtEOL as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Windows Console MBS Win Plugin ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Automatical scrolling at end of line?

When writing with WriteConsole or echoing with ReadFile, the cursor moves to the beginning of the next row when it reaches the end of the current row. This causes the rows displayed in the console window to scroll up automatically when the cursor advances beyond the last row in the window. It also causes the contents of the screen buffer to scroll up (discarding the top row of the screen buffer) when the cursor advances beyond the last row in the screen buffer. If this mode is disabled, the last character in the row is overwritten with any subsequent characters.
(Read and Write property)

WindowsConsoleMBS.BackColor as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Windows Console MBS Win Plugin ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
The text background color used.

(Read and Write property)

WindowsConsoleMBS.CursorSize as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Windows Console MBS Win Plugin ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
The size of the cursor in percent (from 0 to 100).

(Read and Write property)

WindowsConsoleMBS.CursorVisible as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Windows Console MBS Win Plugin ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Is the cursor visible?

(Read and Write property)

WindowsConsoleMBS.EchoInput as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Windows Console MBS Win Plugin ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Echo the input on the screen?

Characters read by the ReadFile function are written to the active screen buffer as they are read. This mode can be used only if the WaitForReturn mode is also enabled.
(Read and Write property)

WindowsConsoleMBS.GotConsole as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Windows Console MBS Win Plugin ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
whether the console was created inside the constructor.

(Read only property)

Some examples using this property:

WindowsConsoleMBS.InputCodepage as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Windows Console MBS Win Plugin ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Codepage of the input stream.

(Read and Write property)

WindowsConsoleMBS.OutputCodepage as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Windows Console MBS Win Plugin ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Codepage of the output stream.

(Read and Write property)

WindowsConsoleMBS.ProcessInput as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Windows Console MBS Win Plugin ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Process input before reading?

Ctrl+c is processed by the system and is not placed in the input buffer. If the input buffer is being read by ReadConsole, other control keys are processed by the system and are not returned in the ReadConsole buffer. If the WaitForReturn mode is also enabled, backspace, carriage return, and linefeed characters are handled by the system.
(Read and Write property)

WindowsConsoleMBS.ProcessOutput as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Windows Console MBS Win Plugin ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Process output before reading?

Characters written by the WriteConsole function or echoed by the ReadFile or ReadConsole function are parsed for ASCII control sequences, and the correct action is performed. Backspace, tab, bell, carriage return, and linefeed characters are processed.
(Read and Write property)

WindowsConsoleMBS.TextColor as Integer

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Windows Console MBS Win Plugin ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
The text color used.

(Read and Write property)

WindowsConsoleMBS.Title as string

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Windows Console MBS Win Plugin ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
The title bar of the console window.

(Read and Write property)

WindowsConsoleMBS.WaitForReturn as boolean

Type Topic Plugin Version macOS Windows Linux iOS Targets
property Windows Console MBS Win Plugin ❌ No ✅ Yes ❌ No ❌ No Desktop, Console & Web
Wait for return key on reading?

The ReadConsole function returns only when a carriage return character is read. If this mode is disabled, the functions return when one or more characters are available.
(Read and Write property)

The items on this page are in the following plugins: MBS Win Plugin.


The biggest plugin in space...