class Text in Tinman.Core.Formatting

Represents a chunk of text and provides access to the text lines.

sealed class

Text

Public / Attributes

Length

public property	Length { get }
type	int32
value

LineCount

public property	LineCount { get }
type	int32
value

MaxLineLength

public property	MaxLineLength { get }
type	int32
value

Value

public property	Value { get }
type	string
value

Public / Methods

For

Creates a new instance of Text.

public static method	For (string text)
type	Text
params	text	[not-null]	The text string value.
returns		[not-null]	The created Text object.

Line

Returns the index-th line of text.

[Pure]
public method	Line (int32 index)
type	string
params	index	[0..LineCount-1]	The zero-based line index.
returns		[not-null]	The line of text.

LineAt

Returns the index of the text line that contains the given offset.

[Pure]
public method	LineAt (int32 offset)
type	int32
params	offset	[0..Length]	The text offset.
returns		[0..LineCount-1]	The zero-based line index.

LineEnd

Returns the end offset of the index-th line.

[Pure]
public method	LineEnd (int32 index)
type	int32
params	index	[0..LineCount-1]	The zero-based line index.
returns		[>=0]	The line end offset (exclusive).

LineLength

Returns the length of the index-th line.

[Pure]
public method	LineLength (int32 index)
type	int32
params	index	[0..LineCount-1]	The zero-based line index.
returns		[>=0]	The line length.

LineStart

Returns the start offset of the index-th line.

[Pure]
public method	LineStart (int32 index)
type	int32
params	index	[0..LineCount-1]	The zero-based line index.
returns		[>=0]	The line start offset (inclusive).

OffsetAt

Returns the offset of the given text location.

[Pure]
public method	OffsetAt (int32 row, int32 column)
type	int32
params	row	[0..LineCount-1]	The zero-based line index.
	column	[>=0]	The zero-based column index.
returns		[0..Length]	Offset of text location.

ToString

public override method	ToString ()
type	string