TextDecorationLocation Enumeration
TOC
Collapse the table of content
Expand the table of content

TextDecorationLocation Enumeration

 

Specifies the vertical position of a TextDecoration object.

Namespace:   System.Windows
Assembly:  PresentationCore (in PresentationCore.dll)

public enum TextDecorationLocation

Member nameDescription
Baseline

The vertical position of a baseline.

OverLine

The vertical position of an overline.

Strikethrough

The vertical position of a strikethrough.

Underline

The vertical position of an underline. This is the default value.

Text decorations are available in four types: baseline, overline, strikethrough, and underline. The following example shows the locations of the text decorations relative to the text.

Diagram of text decoration locations

Text decoration types

The following example creates an underline text decoration and uses a solid color brush for the pen.

// Use a Red pen for the underline text decoration.
private void SetRedUnderline()
{
    // Create an underline text decoration. Default is underline.
    TextDecoration myUnderline = new TextDecoration();

    // Create a solid color brush pen for the text decoration.
    myUnderline.Pen = new Pen(Brushes.Red, 1);
    myUnderline.PenThicknessUnit = TextDecorationUnit.FontRecommended;

    // Set the underline decoration to a TextDecorationCollection and add it to the text block.
    TextDecorationCollection myCollection = new TextDecorationCollection();
    myCollection.Add(myUnderline);
    TextBlock2.TextDecorations = myCollection;
}
<!-- Use a Red pen for the underline text decoration -->
<TextBlock
  FontSize="36" >
  jumped over
  <TextBlock.TextDecorations>
    <TextDecorationCollection>
      <TextDecoration 
        PenThicknessUnit="FontRecommended">
        <TextDecoration.Pen>
          <Pen Brush="Red" Thickness="1" />
        </TextDecoration.Pen>
      </TextDecoration>
    </TextDecorationCollection>
  </TextBlock.TextDecorations>
</TextBlock>

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