FormattedText.SetTextDecorations Method (TextDecorationCollection, Int32, Int32)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Sets the TextDecorationCollection for specified text within a FormattedText object.

Namespace:   System.Windows.Media
Assembly:  PresentationCore (in PresentationCore.dll)

public void SetTextDecorations(
	TextDecorationCollection textDecorations,
	int startIndex,
	int count


Type: System.Windows.TextDecorationCollection

The TextDecorationCollection to apply to the text.

Type: System.Int32

The start index of the initial character to apply the text decorations to.

Type: System.Int32

The number of characters to apply the text decorations to.

The TextDecorationCollection class specifies the types of text decorations to apply to the text. There are four types of text decorations: underline, baseline, strikethrough, and overline. These are described as TextDecorationLocation values that are set on each item in the TextDecorationCollection. It is common that the TextDecorationCollection collection contains only one decoration, but the property uses the collection to provide for more advanced decoration effects by applying multiple decorations to the same text.

The following illustration shows the locations of the text decorations relative to the text.

Diagram of text decoration locations

Example of text decoration types

To set the TextDecorationCollection for the entire text string, use the SetTextDecorations(TextDecorationCollection) method.

.NET Framework
Available since 3.0
Return to top