Class AlignedText
Aligned text renderable
Inheritance
object
AlignedText
Implements
Namespace: Terminaux.Writer.CyclicWriters
Assembly: Terminaux.dll
Syntax
public class AlignedText : IStaticRenderable
Constructors
| Edit this page View SourceAlignedText(Mark?, params object[])
Makes a new instance of the aligned text renderer
Declaration
public AlignedText(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 SourceBackgroundColor
Background color of the text
Declaration
public Color BackgroundColor { get; set; }
Property Value
Type | Description |
---|---|
Color |
Decoration
Decorations to add an appetizing prefix and suffix to the text
Declaration
public Decoration? Decoration { get; set; }
Property Value
Type | Description |
---|---|
Decoration |
ForegroundColor
Foreground color of the text
Declaration
public Color ForegroundColor { get; set; }
Property Value
Type | Description |
---|---|
Color |
LeftMargin
Left margin of the aligned figlet text
Declaration
public int LeftMargin { get; set; }
Property Value
Type | Description |
---|---|
int |
OneLine
Whether to print all lines or only one line
Declaration
public bool OneLine { get; set; }
Property Value
Type | Description |
---|---|
bool |
Rainbow
Whether to write text with rainbow effects or not
Declaration
public bool Rainbow { get; set; }
Property Value
Type | Description |
---|---|
bool |
RainbowBg
Whether to write text with rainbow effects in the background or in the foreground
Declaration
public bool RainbowBg { get; set; }
Property Value
Type | Description |
---|---|
bool |
RightMargin
Right margin of the aligned figlet text
Declaration
public int RightMargin { get; set; }
Property Value
Type | Description |
---|---|
int |
Settings
Text settings to use
Declaration
public TextSettings Settings { get; set; }
Property Value
Type | Description |
---|---|
TextSettings |
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
| Edit this page View SourceRender()
Renders an aligned figlet text
Declaration
public string Render()
Returns
Type | Description |
---|---|
string | Rendered text that will be used by the renderer |