ITextLayout Interface

public interface ITextLayout : IDisposable

IList<ITextLayoutLine> Lines { get; }

Property Value

IList<ITextLayoutLine>:

The collection of visual lines in the layout.

double SpaceWidth { get; }

Property Value

double:

The width of a space.

IList<ITextSpacer> Spacers { get; }

Property Value

IList<ITextSpacer>:

The read-only collection of spacers in the text layout.

int TabSize { get; set; }

Property Value

int:

The number of space characters in a tab. The default value is 4.

TextFormattingMode TextFormattingMode { get; set; }

Property Value

TextFormattingMode:

The TextFormattingMode that indicates the formatting mode to use.

ITextProvider TextProvider { get; }

Property Value

ITextProvider:

The ITextProvider for retrieving text.

TextLayoutWrapping TextWrapping { get; set; }

Property Value

TextLayoutWrapping:

The TextLayoutWrapping that indicates the wrap mode to use when text doesn't fit within the layout width.

int WrappedLineIndentAmount { get; set; }

Property Value

int:

The number of characters to indent any wrapped lines beyond the original indent level of the primary line. The default value is 2.

Remarks

A value of 2 will indent wrapped lines to the original indent level of the primary line, plus 2 additional character widths. A value of 0 will indent wrapped lines to the original indent level of the primary line. A value of -1 will not indent wrapped lines at all, and will simply align them to the left edge of the view. The indent amount may be limited or altogether disabled if there is not enough available width in the view to support proper indentation.

void RunTextFormatter(IDisposable batch)

Parameter	Type	Description
batch	IDisposable	A reference to the result of a previous call to CreateTextBatch().

void SetFontFamily(int characterIndex, int characterCount, string fontFamilyName)

Parameter	Type	Description
characterIndex	int	The start character index.
characterCount	int	The number of characters in the range.
fontFamilyName	string	The font family name to apply over the range.

void SetFontSize(int characterIndex, int characterCount, float fontSize)

Parameter	Type	Description
characterIndex	int	The start character index.
characterCount	int	The number of characters in the range.
fontSize	float	The font size to apply over the range.

void SetFontStyle(int characterIndex, int characterCount, FontStyle fontStyle)

Parameter	Type	Description
characterIndex	int	The start character index.
characterCount	int	The number of characters in the range.
fontStyle	FontStyle	The font style to apply over the range.

void SetFontWeight(int characterIndex, int characterCount, FontWeight fontWeight)

Parameter	Type	Description
characterIndex	int	The start character index.
characterCount	int	The number of characters in the range.
fontWeight	FontWeight	The font weight to apply over the range.

void SetForeground(int characterIndex, int characterCount, Brush brush)

Parameter	Type	Description
characterIndex	int	The start character index.
characterCount	int	The number of characters in the range.
brush	Brush	The foreground to apply over the range.

void SetForeground(int characterIndex, int characterCount, Color color)

Parameter	Type	Description
characterIndex	int	The start character index.
characterCount	int	The number of characters in the range.
color	Color	The foreground to apply over the range.

void SetStrikethrough(int characterIndex, int characterCount, LineKind lineKind, Color? color, TextLineWeight lineWeight)

Parameter	Type	Description
characterIndex	int	The start character index.
characterCount	int	The number of characters in the range.
lineKind	LineKind	The kind of strike-through line.
color	Color?	The optional strike-through line foreground.
lineWeight	TextLineWeight	The line weight. A common value is Single.

void SetStrikethrough(int characterIndex, int characterCount, LineKind lineKind, Brush brush, TextLineWeight lineWeight)

Parameter	Type	Description
characterIndex	int	The start character index.
characterCount	int	The number of characters in the range.
lineKind	LineKind	The kind of strike-through line.
brush	Brush	The optional strike-through line foreground.
lineWeight	TextLineWeight	The line weight. A common value is Single.

void SetStrikethrough(int characterIndex, int characterCount, bool hasStrikethrough)

Parameter	Type	Description
characterIndex	int	The start character index.
characterCount	int	The number of characters in the range.
hasStrikethrough	bool	Whether the range has a strike-through decoration.

void SetUnderline(int characterIndex, int characterCount, LineKind lineKind, Color? color, TextLineWeight lineWeight)

Parameter	Type	Description
characterIndex	int	The start character index.
characterCount	int	The number of characters in the range.
lineKind	LineKind	The kind of underline line.
color	Color?	The optional underline line foreground.
lineWeight	TextLineWeight	The line weight. A common value is Single.

void SetUnderline(int characterIndex, int characterCount, LineKind lineKind, Brush brush, TextLineWeight lineWeight)

Parameter	Type	Description
characterIndex	int	The start character index.
characterCount	int	The number of characters in the range.
lineKind	LineKind	The kind of underline line.
brush	Brush	The optional underline line foreground.
lineWeight	TextLineWeight	The line weight. A common value is Single.

void SetUnderline(int characterIndex, int characterCount, bool hasUnderline)

Parameter	Type	Description
characterIndex	int	The start character index.
characterCount	int	The number of characters in the range.
hasUnderline	bool	Whether the range has an underline decoration.