LabelFormat

Description

class Tinman.Core.Formatting.LabelFormat

Formats a Label.

See also

Label.Format

Public / Methods

Bool


public method Bool → (2)

idx in : int32

[0..LabelFormat.Count-1]
The placeholder index.

value in : bool

The replacement value.

returns → LabelFormat

this.

Replaces the next placeholder with the given value.

Char


public method Char → (3)

idx in : int32

[0..LabelFormat.Count-1]
The placeholder index.

value in : char

The replacement value.

repeat opt : int32 = 1

Number of times to repeat value in.

returns → LabelFormat

this.

Replaces a placeholder with the given value.

End


public virtual method End → ()

returns → string

The formatted label text.

Uses the given placeholders to finish formatting.

Int


public method Int → (3)

idx in : int32

[0..LabelFormat.Count-1]
The placeholder index.

value in : int64

The replacement value.

flags opt : FormatFlags = FormatFlags.Default

The number format flags to use.

returns → LabelFormat

this.

Replaces a placeholder with the given value.

Num


public method Num → (3)

idx in : int32

[0..LabelFormat.Count-1]
The placeholder index.

value in : float64

The replacement value.

flags opt : FormatFlags = FormatFlags.Default

The number format flags to use.

returns → LabelFormat

this.

Replaces a placeholder with the given value.

Obj


public method Obj → (2)

idx in : int32

[0..LabelFormat.Count-1]
The placeholder index.

value in : object

The replacement value.

returns → LabelFormat

this.

Replaces a placeholder with the given value.

Str

2 overloads


public method Str1 → (3)

idx in : int32

[0..LabelFormat.Count-1]
The placeholder index.

value in : string

The replacement value.

escape opt : StringEscape = null

Optional escaping rules to apply to value in.

returns → LabelFormat

this.

Replaces a placeholder with the given value.


public method Str2 → (2)

idx in : int32

[0..LabelFormat.Count-1]
The placeholder index.

value in : StringBuilder

The replacement value.

returns → LabelFormat

this.

Replaces a placeholder with the given value.

Public / Attributes

Count


public attribute Count → (get)

value : int32

[>=0]
The number of placeholders.

Returns the number of placeholders.

Label


public attribute Label → (get)

value : Label

[not-null]
The label.

The label that is being formatted.