Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

AutomationElement.GetCurrentPropertyValue Method (AutomationProperty)

Retrieves the value of the specified property on this AutomationElement. An appropriate default value for the property type is returned for properties not explicitly supported by the target user interface (UI) element.

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

public Object GetCurrentPropertyValue(
	AutomationProperty property
)

Parameters

property
Type: System.Windows.Automation.AutomationProperty

The UI Automation property identifier specifying which property to retrieve.

Return Value

Type: System.Object
An object containing the value of the specified property.

ExceptionCondition
ElementNotAvailableException

The UI for the AutomationElement no longer exists.

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 UI.

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

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

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

// elementList is an AutomationElement. 
string helpString =
    elementList.GetCurrentPropertyValue(AutomationElement.HelpTextProperty) as string;

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Show:
© 2015 Microsoft