Paragraph.TextDecorations Property
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.
Gets or sets a TextDecorationCollection that contains text decorations to apply to this element.
public:
property System::Windows::TextDecorationCollection ^ TextDecorations { System::Windows::TextDecorationCollection ^ get(); void set(System::Windows::TextDecorationCollection ^ value); };
public System.Windows.TextDecorationCollection TextDecorations { get; set; }
member this.TextDecorations : System.Windows.TextDecorationCollection with get, set
Public Property TextDecorations As TextDecorationCollection
Property Value
A TextDecorationCollection collection that contains text decorations to apply to this element. A value of null
means no text decorations will be applied. The default value is null
.
Examples
The following example shows how to set the TextDecorations property of a Paragraph.
<FlowDocument ColumnWidth="200">
<Paragraph TextDecorations="Strikethrough">
This text will render with the strikethrough effect.
</Paragraph>
</FlowDocument>
Paragraph parx = new Paragraph(new Run("This text will render with the strikethrough effect."));
parx.TextDecorations = TextDecorations.Strikethrough;
Dim parx As New Paragraph(New Run("This text will render with the strikethrough effect."))
parx.TextDecorations = TextDecorations.Strikethrough
The following figure shows how this example renders.
The following figures show how the Overline, Baseline, and Underline decorations render, respectively.
Remarks
A TextDecoration object is a visual ornamentation you can add to text. There are four types of text decorations: underline, baseline, strikethrough, and overline. For more information about text decorations, see How to: Create a Text Decoration.
Dependency Property Information
Item | Value |
---|---|
Identifier field | TextDecorationsProperty |
Metadata properties set to true |
AffectsRender |