Class BoundedText

Bounded text renderable

Inheritance
object
CyclicWriter
GraphicalCyclicWriter
BoundedText
Inherited Members
Namespace
Terminaux.Writer.CyclicWriters.Graphical @ Terminaux.dll
Syntax
public class BoundedText : GraphicalCyclicWriter


Constructors

BoundedText(Mark?, params object[])

Makes a new instance of the bounded text renderer

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

Text to use
vars object[]

Variables to format the text with


Properties

BackgroundColor

Background color of the text

Property Value
Color
Declaration
public Color BackgroundColor { get; set; }

Column

[Position-wise] Specifies a zero-based column index

Property Value
int
Declaration
public int Column { get; set; }

ForegroundColor

Foreground color of the text

Property Value
Color
Declaration
public Color ForegroundColor { get; set; }

Height

Right margin of the aligned figlet text

Property Value
int
Declaration
public override int Height { get; set; }
Overrides
GraphicalCyclicWriter.Height

IncrementRate

[Line-wise] Specifies an incrementation rate

Property Value
int
Declaration
public int IncrementRate { get; }

Line

[Line-wise] Specifies a zero-based line index

Property Value
int
Declaration
public int Line { get; set; }

PositionWise

Whether to form a bounded text position-wise or line-wise

Property Value
bool
Declaration
public bool PositionWise { get; set; }

Row

[Position-wise] Specifies a zero-based row index

Property Value
int
Declaration
public int Row { get; set; }

Settings

Text settings to use

Property Value
TextSettings
Declaration
public TextSettings Settings { get; set; }

Text

A text to render

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; }

Width

Left margin of the aligned figlet text

Property Value
int
Declaration
public override int Width { get; set; }
Overrides
GraphicalCyclicWriter.Width


Methods

Render()

Renders a bounded text

Returns
string

Rendered text that will be used by the renderer

Declaration
public override string Render()
Overrides
CyclicWriter.Render()

Table of contents



    About

    Copyright © 2014-2026 Aptivi

    Find us

  •  
  •  
  •  
  •  
  •  
  •  

    • Social media

  •  
  •  
  •  
  •