This documentation is archived and is not being maintained.

FormattedText.SetTextDecorations Method (TextDecorationCollection)

Sets the TextDecorationCollection for the entire set of characters in the FormattedText object.

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

public void SetTextDecorations(
	TextDecorationCollection textDecorations
)

Parameters

textDecorations
Type: System.Windows.TextDecorationCollection
The TextDecorationCollection to apply to the text.

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

This method sets the TextDecorationCollection for the entire text string. To set the TextDecorationCollection for a subset of the text string, use the SetTextDecorations(TextDecorationCollection, Int32, Int32) method.

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: