TextBox.TextDecorations Property

Gets the text decorations to apply to the text box.

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 the text box. 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.

The following example shows how to set the TextDecorations attribute, using Run as the example element.

<FlowDocument ColumnWidth="200">
  <Paragraph>
    <Run TextDecorations="Strikethrough">
      This text will render with the strikethrough effect.
    </Run>
  </Paragraph>
</FlowDocument>

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.

Run run1 = new Run("This text will render with the strikethrough effect.");
run1.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
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft