FormattedText::SetTextDecorations Method (TextDecorationCollection^)
Assembly: PresentationCore (in PresentationCore.dll)
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.
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.
Available since 3.0