TextPattern.MarginLeadingAttribute Field

Definition

Namespace:

System.Windows.Automation

Assembly:

UIAutomationClient.dll

Identifies the MarginLeading (PageSettings) attribute of a text range.

public: static initonly System::Windows::Automation::AutomationTextAttribute ^ MarginLeadingAttribute;

public static readonly System.Windows.Automation.AutomationTextAttribute MarginLeadingAttribute;

 staticval mutable MarginLeadingAttribute : System.Windows.Automation.AutomationTextAttribute

Public Shared ReadOnly MarginLeadingAttribute As AutomationTextAttribute 

Field Value

AutomationTextAttribute

Examples

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

Note

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 GetMarginLeadingAttribute()
{
    // 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.");
        return;
    }

    Object oAttribute = textpatternPattern.DocumentRange.GetAttributeValue(TextPattern.MarginLeadingAttribute);
    if (oAttribute == TextPattern.MixedAttributeValue)
    {
        Console.WriteLine("Mixed leading margins.");
    }
    else
    {
        Console.WriteLine(oAttribute.ToString());
    }
}

Private Sub GetMarginLeadingAttribute()
    ' Start application.
    Dim p As Process = Process.Start("Notepad.exe", "text.txt")

    ' target --> The root AutomationElement.
    Dim target As AutomationElement = AutomationElement.FromHandle(p.MainWindowHandle)

    ' Specify the control type we're looking for, in this case 'Document'
    Dim cond As PropertyCondition = New PropertyCondition(AutomationElement.ControlTypeProperty, ControlType.Document)

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

    Dim textpatternPattern As TextPattern = CType(textProvider.GetCurrentPattern(TextPattern.Pattern), TextPattern)

    If (textpatternPattern Is Nothing) Then
        Console.WriteLine("Root element does not contain a descendant that supports TextPattern.")
        Return
    End If

    Dim oAttribute As Object = textpatternPattern.DocumentRange.GetAttributeValue(TextPattern.MarginLeadingAttribute)
    If (oAttribute = TextPattern.MixedAttributeValue) Then
        Console.WriteLine("Mixed leading margins.")
    Else
        Console.WriteLine(oAttribute.ToString())
    End If
End Sub

Remarks

This attribute represents the leading margin applied to the page(s) associated with the calling text range.

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 Double. The default value is zero.

See also

• TextPatternRange