Paragraph.TextDecorations Property

Gets or sets a TextDecorationCollection that contains text decorations to apply to this element. This is a dependency property.

Namespace: System.Windows.Documents
Assembly: PresentationFramework (in presentationframework.dll)
XML Namespace:

Public Property TextDecorations As TextDecorationCollection
Dim instance As Paragraph
Dim value As TextDecorationCollection

value = instance.TextDecorations

instance.TextDecorations = value
/** @property */
public TextDecorationCollection get_TextDecorations ()

/** @property */
public void set_TextDecorations (TextDecorationCollection value)

public function get TextDecorations () : TextDecorationCollection

public function set TextDecorations (value : TextDecorationCollection)

    <TextDecorationCollection .../>
<object TextDecorations="TextDecorationCollection" .../>

Property Value

A TextDecorationCollection collection that contains text decorations to apply to this element. A value of a null reference (Nothing in Visual Basic) means no text decorations will be applied. The default value is a null reference (Nothing in Visual Basic).

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.

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 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

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0

Community Additions