Windows Dev Center

Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

TextBlock.TextDecorations Property

Gets or sets a TextDecorationCollection that contains the effects to apply to the text of a TextBlock.

Namespace:  System.Windows.Controls
Assembly:  PresentationFramework (in PresentationFramework.dll)
XMLNS for XAML: http://schemas.microsoft.com/winfx/2006/xaml/presentation, http://schemas.microsoft.com/netfx/2007/xaml/presentation

public TextDecorationCollection TextDecorations { get; set; }
<object>
  <object.TextDecorations>
    <TextDecorationCollection .../>
  </object.TextDecorations>
</object>
<object TextDecorations="TextDecorationCollection" .../>

Property Value

Type: System.Windows.TextDecorationCollection
A TextDecorationCollection collection that contains text decorations to apply to this element. The default is null (no text decorations applied).

Identifier field

TextDecorationsProperty

Metadata properties set to true

AffectsRender

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.

By default, this property is set to null and has no TextDecorationCollection associated with it. Before adding any text effects, create a new TextDecorationCollection and assign it to this property.

The following example shows how to set the TextDecorations attribute.

<TextBlock TextDecorations="Strikethrough">
  This text will render with the strikethrough effect.
</TextBlock>

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 TextDecoratorScreenshot: Default baseline effect on textScreenshot: Text with default underline effect

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

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

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Show:
© 2015 Microsoft