AutomationElement::GetCurrentPropertyValue Method (AutomationProperty^, Boolean)


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

Retrieves the value of the specified property on this AutomationElement, optionally ignoring any default property.

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

Object^ GetCurrentPropertyValue(
	AutomationProperty^ property,
	bool ignoreDefaultValue


Type: System.Windows.Automation::AutomationProperty^

The UI Automation property identifier specifying which property to retrieve.

Type: System::Boolean

A value that specifies whether a default value should be ignored if the specified property is supported.

Return Value

Type: System::Object^

An object containing the value of the specified property, or NotSupported if the element does not supply a value and ignoreDefaultValue is true.

Exception Condition

The UI for the AutomationElement no longer exists.

Passing false in ignoreDefaultValue is equivalent to calling AutomationElement::GetCurrentPropertyValue(AutomationProperty^).

If the UI Automation provider for the element itself supports the property, the value of the property is returned. Otherwise, if ignoreDefaultValue is false, a default property specified by UI Automation is returned. For information on default properties, see the property identifier fields of AutomationElement, such as AcceleratorKeyProperty.

The value returned by the GetCurrentPropertyValue method is current at the time it is called. The value can subsequently change by other applications interacting with the user interface (UI).

For some forms of UI, this method will incur cross-process performance overhead. Applications can concentrate overhead by caching properties and then retrieving them by using GetCachedPropertyValue.

The following example retrieves the current value of the HelpText 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.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 3.0
Return to top