Paragraph.TextDecorations Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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

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

Public Property TextDecorations As TextDecorationCollection

Property Value

Type: System.Windows.TextDecorationCollection

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.

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 property of a Paragraph.

<FlowDocument ColumnWidth="200">
  <Paragraph TextDecorations="Strikethrough">
    This text will render with the strikethrough effect.
  </Paragraph>
</FlowDocument>
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.

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

.NET Framework
Available since 3.0
Return to top
Show: