FormattedText.SetTextDecorations Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Sets the TextDecorationCollection for the FormattedText object.
Overloads
| SetTextDecorations(TextDecorationCollection) |
Sets the TextDecorationCollection for the entire set of characters in the FormattedText object. |
| SetTextDecorations(TextDecorationCollection, Int32, Int32) |
Sets the TextDecorationCollection for specified text within a FormattedText object. |
SetTextDecorations(TextDecorationCollection)
Sets the TextDecorationCollection for the entire set of characters in the FormattedText object.
public:
void SetTextDecorations(System::Windows::TextDecorationCollection ^ textDecorations);public void SetTextDecorations (System.Windows.TextDecorationCollection textDecorations);member this.SetTextDecorations : System.Windows.TextDecorationCollection -> unitPublic Sub SetTextDecorations (textDecorations As TextDecorationCollection)Parameters
- textDecorations
- TextDecorationCollection
The TextDecorationCollection to apply to the text.
Remarks
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
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.
Applies to
SetTextDecorations(TextDecorationCollection, Int32, Int32)
Sets the TextDecorationCollection for specified text within a FormattedText object.
public:
void SetTextDecorations(System::Windows::TextDecorationCollection ^ textDecorations, int startIndex, int count);public void SetTextDecorations (System.Windows.TextDecorationCollection textDecorations, int startIndex, int count);member this.SetTextDecorations : System.Windows.TextDecorationCollection * int * int -> unitPublic Sub SetTextDecorations (textDecorations As TextDecorationCollection, startIndex As Integer, count As Integer)Parameters
- textDecorations
- TextDecorationCollection
The TextDecorationCollection to apply to the text.
- startIndex
- Int32
The start index of the initial character to apply the text decorations to.
- count
- Int32
The number of characters to apply the text decorations to.
Remarks
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
To set the TextDecorationCollection for the entire text string, use the SetTextDecorations(TextDecorationCollection) method.
