Class TextMarquee

Text marquee that scrolls for long text similar to how music players work

Inheritance

object

CyclicWriter

SimpleCyclicWriter

TextMarquee

Namespace

Terminaux.Writer.CyclicWriters.Simple @ Terminaux.dll

Syntax

public class TextMarquee : SimpleCyclicWriter

Constructors

TextMarquee(Mark?, params object?[]?)

Makes a new instance of text marquee

Declaration

public TextMarquee(Mark? text = null, params object?[]? args)

Parameters

Name	Type	Description
text	Mark	Text to render. All VT sequences and control characters are trimmed away.
args	object[]	Arguments to format the string with

Properties

BackgroundColor

Background color

Property Value

Color

Declaration

public Color BackgroundColor { get; set; }

Delay

Delay interval. The default is 30 ticks for 100 milliseconds, but you can adjust it, depending on the speed of the loop.

Property Value

int

Declaration

public int Delay { get; set; }

ForegroundColor

Foreground color

Property Value

Color

Declaration

public Color ForegroundColor { get; set; }

Text

Text to render. All VT sequences and control characters are trimmed away.

Property Value

string

Declaration

public string Text { get; }

UseColors

Whether to use colors or not

Property Value

bool

Declaration

public bool UseColors { get; set; }

Width

Width of the marquee

Property Value

int

Declaration

public int Width { get; set; }

Methods

Render()

Renders a scrolling text marquee

Returns

string

The result

Declaration

public override string Render()

Overrides

CyclicWriter.Render()