Export (0) Print
Expand All

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)
XML Namespace:  http://schemas.microsoft.com/winfx/2006/xaml/presentation

public TextDecorationCollection TextDecorations { get; set; }
/** @property */
public TextDecorationCollection get_TextDecorations ()

/** @property */
public void set_TextDecorations (TextDecorationCollection value)

public function get TextDecorations () : TextDecorationCollection

public function set TextDecorations (value : TextDecorationCollection)

<object>
  <object.TextDecorations>
    <TextDecorationCollection .../>
  </object.TextDecorations>
</object>
<object TextDecorations="TextDecorationCollection" .../>

Property Value

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.

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 TextDecorator Screenshot: Default baseline effect on text Screenshot: 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;

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0

Community Additions

ADD
Show:
© 2014 Microsoft