TextBlock.TextDecorations Property

Definition

Namespace:

System.Windows.Controls

Assembly:

PresentationFramework.dll

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

C#

public System.Windows.TextDecorationCollection TextDecorations { get; set; }

Property Value

TextDecorationCollection

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

Examples

The following example shows how to set the TextDecorations attribute.

XAML

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

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.

C#

TextBlock textBlock = new TextBlock(new Run("This text will render with the strikethrough effect."));
textBlock.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.

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.

Dependency Property Information

Item	Value
Identifier field	TextDecorationsProperty
Metadata properties set to true	AffectsRender

Applies to