Class BoxColor

Box writer with color support

Inheritance

object

BoxColor

Namespace: Terminaux.Writer.FancyWriters

Assembly: Terminaux.dll

Syntax

[Obsolete("This is considered a legacy method of writing this fancy text and will be removed in a future version of Terminaux. Please use its cyclic writer equivalent.")]
public static class BoxColor

Methods

RenderBox(int, int, int, int)

Renders the box

Declaration

public static string RenderBox(int Left, int Top, int InteriorWidth, int InteriorHeight)

Parameters

Type	Name	Description
int	Left	Where to place the box horizontally? Please note that this value comes from the upper left corner, which is an exterior position.
int	Top	Where to place the box vertically? Please note that this value comes from the upper left corner, which is an exterior position.
int	InteriorWidth	The width of the interior window, excluding the two console columns for left and right frames
int	InteriorHeight	The height of the interior window, excluding the two console columns for upper and lower frames

Returns

Type	Description
string	The rendered box

RenderBox(int, int, int, int, Color)

Renders the box

Declaration

public static string RenderBox(int Left, int Top, int InteriorWidth, int InteriorHeight, Color BoxColor)

Parameters

Type	Name	Description
int	Left	Where to place the box horizontally? Please note that this value comes from the upper left corner, which is an exterior position.
int	Top	Where to place the box vertically? Please note that this value comes from the upper left corner, which is an exterior position.
int	InteriorWidth	The width of the interior window, excluding the two console columns for left and right frames
int	InteriorHeight	The height of the interior window, excluding the two console columns for upper and lower frames
Color	BoxColor	Box color

Returns

Type	Description
string	The rendered box

WriteBox(int, int, int, int)

Writes the box plainly

Declaration

public static void WriteBox(int Left, int Top, int InteriorWidth, int InteriorHeight)

Parameters

Type	Name	Description
int	Left	Where to place the box horizontally? Please note that this value comes from the upper left corner, which is an exterior position.
int	Top	Where to place the box vertically? Please note that this value comes from the upper left corner, which is an exterior position.
int	InteriorWidth	The width of the interior window, excluding the two console columns for left and right frames
int	InteriorHeight	The height of the interior window, excluding the two console columns for upper and lower frames

WriteBox(int, int, int, int, Color)

Writes the box plainly

Declaration

public static void WriteBox(int Left, int Top, int InteriorWidth, int InteriorHeight, Color BoxColor)

Parameters

Type	Name	Description
int	Left	Where to place the box horizontally? Please note that this value comes from the upper left corner, which is an exterior position.
int	Top	Where to place the box vertically? Please note that this value comes from the upper left corner, which is an exterior position.
int	InteriorWidth	The width of the interior window, excluding the two console columns for left and right frames
int	InteriorHeight	The height of the interior window, excluding the two console columns for upper and lower frames
Color	BoxColor	Box color

WriteBoxPlain(int, int, int, int)

Writes the box plainly

Declaration

public static void WriteBoxPlain(int Left, int Top, int InteriorWidth, int InteriorHeight)

Parameters

Type	Name	Description
int	Left	Where to place the box horizontally? Please note that this value comes from the upper left corner, which is an exterior position.
int	Top	Where to place the box vertically? Please note that this value comes from the upper left corner, which is an exterior position.
int	InteriorWidth	The width of the interior window, excluding the two console columns for left and right frames
int	InteriorHeight	The height of the interior window, excluding the two console columns for upper and lower frames