TextBlock.TextDecorations Property

Definition

Namespace:

Windows.UI.Xaml.Controls

Gets or sets a value that indicates what decorations are applied to the text.

public:
 property TextDecorations TextDecorations { TextDecorations get(); void set(TextDecorations value); };

TextDecorations TextDecorations();

void TextDecorations(TextDecorations value);

public TextDecorations TextDecorations { get; set; }

var textDecorations = textBlock.textDecorations;
textBlock.textDecorations = textDecorations;

Public Property TextDecorations As TextDecorations

<TextBlock TextDecorations="textDecorationsMemberName"/>

Property Value

TextDecorations

A value of the enumeration. The default is None.

Windows requirements

Device family	Windows 10 Creators Update (introduced in 10.0.15063.0)
API contract	Windows.Foundation.UniversalApiContract (introduced in v4.0)

Examples

This example shows how to apply decorations to text.

<!-- Apply underline. -->
<TextBlock Text="Sample text" TextDecorations="Underline"/>

<!-- Apply underline and strikethrough. -->
<TextBlock Text="Sample text" TextDecorations="Underline, Strikethrough"/>

<!-- Apply decorations in code. -->
<TextBlock x:Name="TextBlock3" Text="Sample Text"
           Loaded="TextBlock_Loaded" />

private void TextBlock_Loaded(object sender, RoutedEventArgs e)
{
    // Apply both strikethough and underline to TextBlock3.
    TextBlock3.TextDecorations =
        TextDecorations.Strikethrough | TextDecorations.Underline;
}

Remarks

Starting with the Windows 10 Creators Update (SDK version 15063), this property is the preferred way to strikethrough or underline text.

For earlier versions of Windows, you can underline text with the Underline class.