Class Ruler

Ruler renderable

Inheritance

object

CyclicWriter

SimpleCyclicWriter

Ruler

Namespace

Terminaux.Writer.CyclicWriters.Simple @ Terminaux.dll

Syntax

public class Ruler : SimpleCyclicWriter

Constructors

Ruler()

Makes a new instance of the ruler renderer

Declaration

public Ruler()

Properties

Alignment

Alignment of text

Property Value

TextAlignment

Declaration

public TextAlignment Alignment { get; set; }

BackgroundColor

Background color

Property Value

Color

Declaration

public Color BackgroundColor { get; set; }

ForegroundColor

Foreground color

Property Value

Color

Declaration

public Color ForegroundColor { get; set; }

Height

Height of the ruler

Property Value

int

Declaration

public int Height { get; set; }

IntersectionIndicator

Whether this ruler has intersection indicators

Property Value

bool

Declaration

public bool IntersectionIndicator { get; set; }

Settings

Ruler style settings

Property Value

BorderSettings

Declaration

public BorderSettings Settings { get; set; }

Text

Text to render (only for horizontal rulers)

Property Value

string

Declaration

public string Text { get; set; }

UseColors

Whether to use colors or not

Property Value

bool

Declaration

public bool UseColors { get; set; }

Vertical

Whether this ruler is a vertical ruler or not

Property Value

bool

Declaration

public bool Vertical { get; set; }

Width

Width of the ruler

Property Value

int

Declaration

public int Width { get; set; }

Methods

Render()

Renders a ruler

Returns

string

Rendered ruler text that will be used by the renderer

Declaration

public override string Render()

Overrides

CyclicWriter.Render()