TextPattern.OverlineStyleAttribute Field


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Identifies the OverlineStyle (TextDecorationLineStyle) attribute of a text range.

Namespace:   System.Windows.Automation
Assembly:  UIAutomationClient (in UIAutomationClient.dll)

public static readonly AutomationTextAttribute OverlineStyleAttribute

This identifier is used by UI Automation client applications. UI Automation providers should use the equivalent field in TextPatternIdentifiers.

UI Automation clients get the value of the attribute by calling GetAttributeValue.

Values for this attribute are of type TextDecorationLineStyle. The default value is None.

The following example shows how to obtain an attribute value for a range of text in Microsoft Notepad.


Microsoft Notepad is used as the text provider for example purposes only. Microsoft Notepad is not guaranteed to support the attribute value being requested.

private void GetOverlineStyleAttribute()
    // Start application.
    Process p = Process.Start("Notepad.exe", "text.txt");

    // target --> The root AutomationElement.
    AutomationElement target = AutomationElement.FromHandle(p.MainWindowHandle);

    // Specify the control type we're looking for, in this case 'Document'
    PropertyCondition cond = new PropertyCondition(AutomationElement.ControlTypeProperty, ControlType.Document);

    AutomationElement textProvider = target.FindFirst(TreeScope.Descendants, cond);

    TextPattern textpatternPattern = textProvider.GetCurrentPattern(TextPattern.Pattern) as TextPattern;

    if (textpatternPattern == null)
        Console.WriteLine("Root element does not contain a descendant that supports TextPattern.");

    Object oAttribute = textpatternPattern.DocumentRange.GetAttributeValue(TextPattern.OverlineStyleAttribute);
    if (oAttribute == TextPattern.MixedAttributeValue)
        Console.WriteLine("Mixed overline style.");

.NET Framework
Available since 3.0
Return to top