class LabelFormat in Tinman.Core.Formatting

class

LabelFormat

Public / Attributes

Count

Returns the number of placeholders.

public property	Count { get }
type	int32
value	[>=0]	The number of placeholders.

Label

The label that is being formatted.

public property	Label { get }
type	Label
value	[not-null]	The label.

Public / Methods

Bool

Replaces the next placeholder with the given value.

public method	Bool (int32 idx, bool value)
type	LabelFormat
params	idx	[0..Count-1]	The placeholder index.
	value		The replacement value.
returns		[not-null]	this.

Char

Replaces a placeholder with the given value.

public method	Char (int32 idx, char value, int32 repeat = 1)
type	LabelFormat
params	idx	[0..Count-1]	The placeholder index.
	value		The replacement value.
	repeat		Number of times to repeat value.
returns		[not-null]	this.

End

Uses the given placeholders to finish formatting.

public virtual method	End ()
type	string
returns			The formatted label text.

Int

Replaces a placeholder with the given value.

public method	Int (int32 idx, int64 value, FormatFlags flags = FormatFlags.Default)
type	LabelFormat
params	idx	[0..Count-1]	The placeholder index.
	value		The replacement value.
	flags		The number format flags to use.
returns		[not-null]	this.

Num

Replaces a placeholder with the given value.

public method	Num (int32 idx, float64 value, FormatFlags flags = FormatFlags.Default)
type	LabelFormat
params	idx	[0..Count-1]	The placeholder index.
	value		The replacement value.
	flags		The number format flags to use.
returns		[not-null]	this.

Obj

Replaces a placeholder with the given value.

public method	Obj (int32 idx, object value)
type	LabelFormat
params	idx	[0..Count-1]	The placeholder index.
	value		The replacement value.
returns		[not-null]	this.

Str

Replaces a placeholder with the given value.

public method	Str (int32 idx, StringBuilder value)
type	LabelFormat
params	idx	[0..Count-1]	The placeholder index.
	value		The replacement value.
returns		[not-null]	this.

---

Replaces a placeholder with the given value.

public method	Str (int32 idx, string value, StringEscape escape = null)
type	LabelFormat
params	idx	[0..Count-1]	The placeholder index.
	value		The replacement value.
	escape		Optional escaping rules to apply to value. Defaults to null.
returns		[not-null]	this.

ToString

public override sealed method	ToString ()
type	string