Class TextMarquee

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

Inheritance
object
TextMarquee
Implements
Namespace: Terminaux.Writer.CyclicWriters
Assembly: Terminaux.dll
Syntax
public class TextMarquee : IStaticRenderable

Constructors

| Edit this page View Source

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

Makes a new instance of text marquee

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

Text to render. All VT sequences and control characters are trimmed away.
object[] args

Arguments to format the string with

Properties

| Edit this page View Source

BackgroundColor

Background color

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

Delay

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

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

ForegroundColor

Foreground color

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

LeftMargin

Left margin of the marquee

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

RightMargin

Right margin of the marquee

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

Text

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

Declaration
public string Text { get; }
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 scrolling text marquee

Declaration
public string Render()
Returns
Type Description
string

The result

Implements