This topic has not yet been rated - Rate this topic

AutomationElement.GetCurrentPropertyValue Method (AutomationProperty, Boolean)

.NET Framework 4.5

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

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

public Object GetCurrentPropertyValue(
	AutomationProperty property,
	bool ignoreDefaultValue
)

Parameters

property: Type: System.Windows.Automation.AutomationProperty
The UI Automation property identifier specifying which property to retrieve.

ignoreDefaultValue: 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.

Exceptions

Exception	Condition
ElementNotAvailableException	The UI for the AutomationElement no longer exists.

Remarks

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.

Examples

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.

// elementList is an AutomationElement. 
object help = elementList.GetCurrentPropertyValue(AutomationElement.HelpTextProperty, true);
if (help == AutomationElement.NotSupported)
{
    help = "No help available";
}
string helpText = (string)help;

Version Information

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Platforms

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Reference

AutomationElement Class

GetCurrentPropertyValue Overload

System.Windows.Automation Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)