TextDecoration.Location Property

Reference

Definition

Namespace:: System.Windows

Assembly:: PresentationCore.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets the vertical location at which the text decoration is drawn.

public:
 property System::Windows::TextDecorationLocation Location { System::Windows::TextDecorationLocation get(); void set(System::Windows::TextDecorationLocation value); };

public System.Windows.TextDecorationLocation Location { get; set; }

member this.Location : System.Windows.TextDecorationLocation with get, set

Public Property Location As TextDecorationLocation

Property Value

TextDecorationLocation

The vertical location at which the text decoration is drawn.

Examples

In the following code example, a strikethrough text decoration is created with a solid color brush for the pen. The Location property is set to Strikethrough.

// Use the default font values for the strikethrough text decoration.
private void SetDefaultStrikethrough()
{
    // Set the underline decoration directly to the text block.
    TextBlock1.TextDecorations = TextDecorations.Strikethrough;
}

' Use the default font values for the strikethrough text decoration.
Private Sub SetDefaultStrikethrough()
    ' Set the underline decoration directly to the text block.
    TextBlock1.TextDecorations = TextDecorations.Strikethrough
End Sub

<!-- Use the default font values for the strikethrough text decoration. -->
<TextBlock
  TextDecorations="Strikethrough"
  FontSize="36" >
  The quick red fox
</TextBlock>

Remarks

The following example shows the locations of the text decorations relative to the text.

Diagram of text decoration locations
Example of text decoration types

The PenOffset property enables you to offset the text decoration from the specified Location.

Dependency Property Information


Identifier field	LocationProperty
Metadata properties set to `true`	None

Applies to

Jaa