Class SyntaxText

Syntax text renderable

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

Constructors

| Edit this page View Source

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

| Edit this page View Source

BackgroundColor

Background color of the text

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

ForegroundColor

Foreground color of the text

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

LeftMargin

Left margin of the syntax figlet text

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

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
| Edit this page View Source

RightMargin

Right margin of the syntax figlet text

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

Syntax

Language type

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

Text

Text to render

Declaration
public string Text { get; set; }
Property Value
Type Description
string
| 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 a syntax text

Declaration
public override string Render()
Returns
Type Description
string

Rendered text that will be used by the renderer
Overrides