TextDecorationLocation TextDecorationLocation TextDecorationLocation TextDecorationLocation Enum

Definition

Specifies the vertical position of a TextDecoration object.

public enum class TextDecorationLocation
public enum TextDecorationLocation
type TextDecorationLocation = 
Public Enum TextDecorationLocation
Inheritance
TextDecorationLocationTextDecorationLocationTextDecorationLocationTextDecorationLocation

Fields

Baseline Baseline Baseline Baseline 3

The vertical position of a baseline.

OverLine OverLine OverLine OverLine 1

The vertical position of an overline.

Strikethrough Strikethrough Strikethrough Strikethrough 2

The vertical position of a strikethrough.

Underline Underline Underline Underline 0

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

Examples

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.
Private Sub SetRedUnderline()
	' Create an underline text decoration. Default is underline.
	Dim myUnderline As 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.
	Dim myCollection As New TextDecorationCollection()
	myCollection.Add(myUnderline)
	TextBlock2.TextDecorations = myCollection
End Sub
<!-- Use a Red pen for the underline text decoration -->
<TextBlock
  FontSize="36" >
  jumps over
  <TextBlock.TextDecorations>
    <TextDecorationCollection>
      <TextDecoration 
        PenThicknessUnit="FontRecommended">
        <TextDecoration.Pen>
          <Pen Brush="Red" Thickness="1" />
        </TextDecoration.Pen>
      </TextDecoration>
    </TextDecorationCollection>
  </TextBlock.TextDecorations>
</TextBlock>

Remarks

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

Applies to