AutomationElement.IsControlElementProperty Field

Reference

Definition

Namespace:: System.Windows.Automation

Assembly:: UIAutomationClient.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.

Identifies the IsControlElement property.

public: static initonly System::Windows::Automation::AutomationProperty ^ IsControlElementProperty;

public static readonly System.Windows.Automation.AutomationProperty IsControlElementProperty;

 staticval mutable IsControlElementProperty : System.Windows.Automation.AutomationProperty

Public Shared ReadOnly IsControlElementProperty As AutomationProperty

Field Value

AutomationProperty

Examples

The following example retrieves the current value of the property. The default value is returned if the element does not provide one.

bool isControl = (bool)
   autoElement.GetCurrentPropertyValue(AutomationElement.IsControlElementProperty);

Dim isControl As Boolean = CBool(autoElement.GetCurrentPropertyValue(AutomationElement.IsControlElementProperty))

The following example retrieves the current value of the property, but specifies that if the element itself does not provide a value for the property, NotSupported is to be returned instead of a default value.

bool isControl1;
object isControlNoDefault =
    autoElement.GetCurrentPropertyValue(AutomationElement.IsControlElementProperty, true);
if (isControlNoDefault == AutomationElement.NotSupported)
{
    // TODO Handle the case where you do not wish to proceed using the default value.
}
else
{
    isControl1 = (bool)isControlNoDefault;
}

Dim isControl1 As Boolean
Dim isControlNoDefault As Object = autoElement.GetCurrentPropertyValue(AutomationElement.IsControlElementProperty, True)
If isControlNoDefault Is AutomationElement.NotSupported Then
    ' TODO Handle the case where you do not wish to proceed using the default value.
Else
    isControl1 = CBool(isControlNoDefault)
End If

Remarks

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

This property can also be retrieved from the Current or Cached properties.

Controls are elements that a user perceives as interactive or containing information in the UI.

Return values of the property are of type Boolean. The default value for the property is true.

Applies to

Product	Versions
.NET Framework	3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
Windows Desktop	3.0, 3.1, 5, 6, 7, 8, 9, 10

Share via