TextPattern.IsSubscriptAttribute Field
Definition
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.
Identifies the IsSubscript
(FontVariants) attribute of a text range.
public: static initonly System::Windows::Automation::AutomationTextAttribute ^ IsSubscriptAttribute;
public static readonly System.Windows.Automation.AutomationTextAttribute IsSubscriptAttribute;
staticval mutable IsSubscriptAttribute : System.Windows.Automation.AutomationTextAttribute
Public Shared ReadOnly IsSubscriptAttribute As AutomationTextAttribute
Field Value
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 GetIsSubscriptAttribute()
{
// 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.IsSubscriptAttribute);
if (oAttribute == TextPattern.MixedAttributeValue)
{
Console.WriteLine("Mixture of subscript and non-subscript.");
}
else
{
Console.WriteLine(oAttribute.ToString());
}
}
Private Sub GetIsSubscriptAttribute()
' 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.IsSubscriptAttribute)
If (oAttribute = TextPattern.MixedAttributeValue) Then
Console.WriteLine("Mixture of subscript and non-subscript.")
Else
Console.WriteLine(oAttribute.ToString())
End If
End Sub
Remarks
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 Boolean. The default value is false
.