Class BoxFrame

Box frame renderable

Inheritance
object
BoxFrame
Implements
Namespace: Terminaux.Writer.CyclicWriters
Assembly: Terminaux.dll
Syntax
public class BoxFrame : IStaticRenderable

Constructors

| Edit this page View Source

BoxFrame(Mark?, params object[])

Makes a new instance of the box renderer

Declaration
public BoxFrame(Mark? text = null, params object[] vars)
Parameters
Type Name Description
Mark text

Text to use
object[] vars

Variables to format the text with

Properties

| Edit this page View Source

BackgroundColor

Background color

Declaration
public Color BackgroundColor { get; set; }
Property Value
Type Description
Color
| Edit this page View Source

FrameColor

Box frame color

Declaration
public Color FrameColor { get; set; }
Property Value
Type Description
Color
| Edit this page View Source

InteriorHeight

Interior height

Declaration
public int InteriorHeight { get; set; }
Property Value
Type Description
int
| Edit this page View Source

InteriorWidth

Interior width

Declaration
public int InteriorWidth { get; set; }
Property Value
Type Description
int
| Edit this page View Source

Left

Left position

Declaration
public int Left { get; set; }
Property Value
Type Description
int
| Edit this page View Source

Settings

Border settings to use

Declaration
public BorderSettings Settings { get; set; }
Property Value
Type Description
BorderSettings
| Edit this page View Source

Text

Top position

Declaration
public string Text { get; set; }
Property Value
Type Description
string
| Edit this page View Source

TitleColor

Box frame title color

Declaration
public Color TitleColor { get; set; }
Property Value
Type Description
Color
| Edit this page View Source

TitleSettings

Title settings to use

Declaration
public TextSettings TitleSettings { get; set; }
Property Value
Type Description
TextSettings
| Edit this page View Source

Top

Top position

Declaration
public int Top { get; set; }
Property Value
Type Description
int
| Edit this page View Source

UseColors

Whether to use colors or not

Declaration
public bool UseColors { get; set; }
Property Value
Type Description
bool

Methods

| Edit this page View Source

Render()

Renders an aligned figlet text

Declaration
public string Render()
Returns
Type Description
string

Rendered text that will be used by the renderer

Implements