TextDecorations Property

TextBox::TextDecorations Property

 

Gets the text decorations to apply to the text box.

Namespace:   System.Windows.Controls
Assembly:  PresentationFramework (in PresentationFramework.dll)

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

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).

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.

Identifier field

TextDecorationsProperty

Metadata properties set to true

AffectsRender

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 TextDecorator
Screenshot: Default baseline effect on text
Screenshot: Text with default underline effect

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

No code example is currently available or this language may not be supported.

.NET Framework
Available since 3.0
Return to top
Show:
© 2016 Microsoft