This documentation is archived and is not being maintained.

FormattedText.SetTextDecorations Method (TextDecorationCollection, Int32, Int32)

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
)
You cannot use methods in XAML.

Parameters

textDecorations
Type: System.Windows.TextDecorationCollection

The TextDecorationCollection to apply to the text.

startIndex
Type: System.Int32

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

count
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.

Example of text decoration types

Diagram of text decoration locations

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

Windows 7, Windows Vista, Windows XP SP2, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0
Show: