Class AlignedFigletText
Aligned figlet text renderable
Inheritance
object
AlignedFigletText
Implements
Namespace: Terminaux.Writer.CyclicWriters
Assembly: Terminaux.dll
Syntax
public class AlignedFigletText : IStaticRenderable
Constructors
| Edit this page View SourceAlignedFigletText(FigletFont, Mark?, params object[])
Makes a new instance of the aligned figlet text renderer
Declaration
public AlignedFigletText(FigletFont figletFont, Mark? text = null, params object[] vars)
Parameters
Type | Name | Description |
---|---|---|
FigletFont | figletFont | Figlet font to render with |
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 |
Font
Figlet font to render the text with
Declaration
public FigletFont Font { get; set; }
Property Value
Type | Description |
---|---|
FigletFont |
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
Top position
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 |