AutomationElement.ItemStatusProperty 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 ItemStatus property, which specifies the status of the visual representation of a complex item.

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

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

 staticval mutable ItemStatusProperty : System.Windows.Automation.AutomationProperty

Public Shared ReadOnly ItemStatusProperty 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.

string itemStatus =
    autoElement.GetCurrentPropertyValue(AutomationElement.ItemStatusProperty) as string;

Dim itemStatus As String = _
    CStr(autoElement.GetCurrentPropertyValue(AutomationElement.ItemStatusProperty))

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.

string itemStatus1;
object itemStatusNoDefault =
    autoElement.GetCurrentPropertyValue(AutomationElement.ItemStatusProperty, true);
if (itemStatusNoDefault == AutomationElement.NotSupported)
{
    // TODO Handle the case where you do not wish to proceed using the default value.
}
else
{
    itemStatus1 = itemStatusNoDefault as string;
}

Dim itemStatus1 As String
Dim itemStatusNoDefault As Object = _
    autoElement.GetCurrentPropertyValue(AutomationElement.ItemStatusProperty, True)
If itemStatusNoDefault Is AutomationElement.NotSupported Then
    ' TODO Handle the case where you do not wish to proceed using the default value.
Else
    itemStatus1 = CStr(itemStatusNoDefault)
End If

Remarks

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

The return value is a control-defined String. The default value is an empty string.

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