Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

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.6, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Show:
© 2015 Microsoft