Class SyntaxText

Syntax text renderable

Inheritance

object

SyntaxText

Implements

IStaticRenderable

Namespace: Terminaux.Writer.CyclicWriters

Assembly: Terminaux.dll

Syntax

public class SyntaxText : IStaticRenderable

Constructors

SyntaxText(Mark?, params object[])

Makes a new instance of the syntax text renderer

Declaration

public SyntaxText(Mark? text = null, params object[] vars)

Parameters

Type	Name	Description
Mark	text	Text to use
object[]	vars	Variables to format the text with

Properties

BackgroundColor

Background color of the text

Declaration

public Color BackgroundColor { get; set; }

Property Value

Type	Description
Color

ForegroundColor

Foreground color of the text

Declaration

public Color ForegroundColor { get; set; }

Property Value

Type	Description
Color

LeftMargin

Left margin of the syntax figlet text

Declaration

public int LeftMargin { get; set; }

Property Value

Type	Description
int

PathToHighlight

Path to the Highlight executable (platform-dependent). You can download a copy from here.

Declaration

public string PathToHighlight { get; set; }

Property Value

Type	Description
string

RightMargin

Right margin of the syntax figlet text

Declaration

public int RightMargin { get; set; }

Property Value

Type	Description
int

Syntax

Language type

Declaration

public string Syntax { get; set; }

Property Value

Type	Description
string

Text

Text to render

Declaration

public string Text { get; set; }

Property Value

Type	Description
string

Top

Top position

Declaration

public int Top { get; set; }

Property Value

Type	Description
int

UseColors

Whether to use colors or not

Declaration

public bool UseColors { get; set; }

Property Value

Type	Description
bool

Methods

Render()

Renders an syntax figlet text

Declaration

public string Render()

Returns

Type	Description
string	Rendered text that will be used by the renderer

Implements

IStaticRenderable