Inline.TextDecorations Property

 

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

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

public TextDecorationCollection TextDecorations { get; set; }

Property Value

Type: System.Windows.TextDecorationCollection

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

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

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.

Identifier field

TextDecorationsProperty

Metadata properties set to true

AffectsRender

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.

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

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;

.NET Framework
Available since 3.0
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Return to top
Show: