Class ControlsConsole

A basic console that can contain controls.

Inheritance
object
ScreenObject
ScreenSurface
Console
ControlsConsole
Implements
Inherited Members
Namespace: SadConsole.UI
Assembly: SadConsole.dll
Syntax
[DataContract]
public class ControlsConsole : Console, IDisposable, IScreenSurfaceEditable, IScreenSurface, IScreenObject, IPositionable, IComponentHost, ISurface, ISurfaceSettable

Constructors

ControlsConsole(ICellSurface, IFont?, Point?)

Creates a new console using the existing surface.

Declaration
public ControlsConsole(ICellSurface surface, IFont? font = null, Point? fontSize = null)
Parameters
Type Name Description
ICellSurface surface

The surface.
IFont font

The font to use with the surface.
Point? fontSize

The font size.

ControlsConsole(int, int)

Creates a new console.

Declaration
public ControlsConsole(int width, int height)
Parameters
Type Name Description
int width

The width in cells of the surface.
int height

The height in cells of the surface.

ControlsConsole(int, int, ColoredGlyphBase[])

Creates a new screen object that can render a surface. Uses the specified cells to generate the surface.

Declaration
public ControlsConsole(int width, int height, ColoredGlyphBase[] initialCells)
Parameters
Type Name Description
int width

The width in cells of the surface.
int height

The height in cells of the surface.
ColoredGlyphBase[] initialCells

The initial cells to seed the surface.

ControlsConsole(int, int, int, int)

Creates a new console with the specified width and height, with Transparent for the background and White for the foreground.

Declaration
public ControlsConsole(int width, int height, int bufferWidth, int bufferHeight)
Parameters
Type Name Description
int width

The visible width of the console in cells.
int height

The visible height of the console in cells.
int bufferWidth

The total width of the console in cells.
int bufferHeight

The total height of the console in cells.

ControlsConsole(int, int, int, int, ColoredGlyphBase[]?)

Creates a console with the specified width and height, with Transparent for the background and White for the foreground.

Declaration
public ControlsConsole(int width, int height, int bufferWidth, int bufferHeight, ColoredGlyphBase[]? initialCells)
Parameters
Type Name Description
int width

The width of the console in cells.
int height

The height of the console in cells.
int bufferWidth

The total width of the console in cells.
int bufferHeight

The total height of the console in cells.
ColoredGlyphBase[] initialCells

The cells to seed the console with. If null, creates the cells for you.

Properties

Controls

The controls host holding all the controls.

Declaration
public ControlHost Controls { get; }
Property Value
Type Description
ControlHost

Methods

ToString()

Returns the value "Console (Controls)".

Declaration
public override string ToString()
Returns
Type Description
string

The string "Console (Controls)".
Overrides

Implements

Extension Methods