Paragraph.TextDecorations Property

Definition

Gets or sets a TextDecorationCollection that contains text decorations to apply to this element.

C#
public System.Windows.TextDecorationCollection TextDecorations { get; set; }

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.

XAML
<FlowDocument ColumnWidth="200">
  <Paragraph TextDecorations="Strikethrough">
    This text will render with the strikethrough effect.
  </Paragraph>
</FlowDocument>
C#
Paragraph parx = new Paragraph(new Run("This text will render with the strikethrough effect."));
parx.TextDecorations = TextDecorations.Strikethrough;

The following figure shows how this example renders.

Screenshot: Text with default strikethrough effect

The following figures show how the Overline, Baseline, and Underline decorations render, respectively.

Screenshot: Overline TextDecorator

Screenshot: Default baseline effect on text

Screenshot: Text with default underline effect

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

Applies to

Produk Versi
.NET Framework 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop 3.0, 3.1, 5, 6, 7, 8, 9, 10