Inline.TextDecorations Property

Definition

Namespace:

System.Windows.Documents

Assembly:

PresentationFramework.dll

Gets 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

TextDecorationCollection

A TextDecorationCollection collection that contains text decorations to apply to this element.

The default value is null (no text decorations applied).

Examples

The following example shows how to set the TextDecorations attribute of a Inline element (Run).

<FlowDocument ColumnWidth="200">
  <Paragraph>
    <Run TextDecorations="Strikethrough">
      This text will render with the strikethrough effect.
    </Run>
  </Paragraph>
</FlowDocument>

The following figure shows how this example renders.

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

The following example shows how to set the TextDecorations property programmatically.

Run run1 = new Run("This text will render with the strikethrough effect.");
run1.TextDecorations = TextDecorations.Strikethrough;

Dim run1 As New Run("This text will render with the strikethrough effect.")
run1.TextDecorations = TextDecorations.Strikethrough

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

Identifier field	TextDecorationsProperty
Metadata properties set to true	AffectsRender