Class BoxFrame

Box frame renderable

Inheritance
object
CyclicWriter
GraphicalCyclicWriter
BoxFrame
Inherited Members
Namespace
Terminaux.Writer.CyclicWriters.Graphical @ Terminaux.dll
Syntax
public class BoxFrame : GraphicalCyclicWriter


Constructors

BoxFrame(Mark?, params object[])

Makes a new instance of the box frame renderer

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

Text to use
vars object[]

Variables to format the text with


Properties

BackgroundColor

Background color

Property Value
Color
Declaration
public Color BackgroundColor { get; set; }

DropShadow

Whether to enable drop shadow or not

Property Value
bool
Declaration
public bool DropShadow { get; set; }

FrameColor

Box frame color

Property Value
Color
Declaration
public Color FrameColor { get; set; }

Rulers

Rulers that divide the box frame

Property Value
RulerInfo[]
Declaration
public RulerInfo[] Rulers { get; set; }

Settings

Border settings to use

Property Value
BorderSettings
Declaration
public BorderSettings Settings { get; set; }

ShadowColor

Drop shadow color

Property Value
Color
Declaration
public Color ShadowColor { get; set; }

Text

Top position

Property Value
string
Declaration
public string Text { get; set; }

TitleColor

Box frame title color

Property Value
Color
Declaration
public Color TitleColor { get; set; }

TitleSettings

Title settings to use

Property Value
TextSettings
Declaration
public TextSettings TitleSettings { get; set; }

UseColors

Whether to use colors or not

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


Methods

Render()

Renders a box frame

Returns
string

Rendered box frame that will be used by the renderer

Declaration
public override string Render()
Overrides
CyclicWriter.Render()

Table of contents



    About

    Copyright © 2014-2026 Aptivi

    Find us

  •  
  •  
  •  
  •  
  •  
  •  

    • Social media

  •  
  •  
  •  
  •