AutomationElement.GetCurrentPropertyValue 方法

定义

命名空间:

System.Windows.Automation

程序集:

UIAutomationClient.dll

从 AutomationElement 检索指定属性的当前值。

重载

GetCurrentPropertyValue(AutomationProperty)	检索此 AutomationElement 上指定属性的值。 对于目标用户界面 (UI) 元素未显式支持的属性，将返回属性类型的相应默认值。
GetCurrentPropertyValue(AutomationProperty, Boolean)	检索此 AutomationElement 上指定属性的值，还可以选择忽略任何默认属性。

注解

方法返回 GetCurrentPropertyValue 的值在调用时是最新的。 随后，与用户界面 (UI) 交互的其他应用程序可能会更改该值。

对于某些形式的 UI，此方法会产生跨进程性能开销。 应用程序可以通过缓存属性，然后使用 检索它们 GetCachedPropertyValue来集中开销。

GetCurrentPropertyValue(AutomationProperty)

检索此 AutomationElement 上指定属性的值。 对于目标用户界面 (UI) 元素未显式支持的属性，将返回属性类型的相应默认值。

public:
 System::Object ^ GetCurrentPropertyValue(System::Windows::Automation::AutomationProperty ^ property);

public object GetCurrentPropertyValue (System.Windows.Automation.AutomationProperty property);

member this.GetCurrentPropertyValue : System.Windows.Automation.AutomationProperty -> obj

Public Function GetCurrentPropertyValue (property As AutomationProperty) As Object

参数

property

AutomationProperty

指定要检索的属性的 UI 自动化属性标识符。

返回

Object

一个包含指定属性的值的对象。

例外

ElementNotAvailableException

AutomationElement 的 UI 不再存在。

示例

以下示例检索 属性的 HelpText 当前值。 如果元素未提供默认值，则返回默认值。

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

' elementList is an AutomationElement.
Dim helpString As String = _
    CStr(elementList.GetCurrentPropertyValue(AutomationElement.HelpTextProperty))

注解

方法返回 GetCurrentPropertyValue 的值在调用时是最新的。 随后，与 UI 交互的其他应用程序可能会更改该值。

如果元素本身的 UI 自动化提供程序支持 属性，则返回 属性的值。 否则，将返回由 UI 自动化指定的默认属性。 有关默认属性的信息，请参阅 的属性 AutomationElement标识符字段，例如 AcceleratorKeyProperty。

对于某些形式的 UI，此方法会产生跨进程性能开销。 通过缓存属性，然后使用 检索它们 GetCachedPropertyValue来集中开销。

GetCurrentPropertyValue(AutomationProperty, Boolean)

检索此 AutomationElement 上指定属性的值，还可以选择忽略任何默认属性。

public:
 System::Object ^ GetCurrentPropertyValue(System::Windows::Automation::AutomationProperty ^ property, bool ignoreDefaultValue);

public object GetCurrentPropertyValue (System.Windows.Automation.AutomationProperty property, bool ignoreDefaultValue);

member this.GetCurrentPropertyValue : System.Windows.Automation.AutomationProperty * bool -> obj

Public Function GetCurrentPropertyValue (property As AutomationProperty, ignoreDefaultValue As Boolean) As Object

参数

property

AutomationProperty

指定要检索的属性的 UI 自动化属性标识符。

ignoreDefaultValue

Boolean

一个值，该值指定在支持指定的属性的情况下是否应忽略默认值。

返回

Object

一个包含指定属性的值的对象，如果该元素未提供值并且 NotSupported 为 ignoreDefaultValue，则为 true。

例外

ElementNotAvailableException

AutomationElement 的 UI 不再存在。

示例

以下示例检索属性的 HelpText 当前值，但指定如果元素本身未为属性提供值， NotSupported 则返回 而不是默认值。

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

' elementList is an AutomationElement.
Dim help As Object = elementList.GetCurrentPropertyValue(AutomationElement.HelpTextProperty, True)
If help Is AutomationElement.NotSupported Then
    help = "No help available"
End If
Dim helpText As String = CStr(help)

注解

传入 falseignoreDefaultValue 等效于调用 AutomationElement.GetCurrentPropertyValue(AutomationProperty)。

如果元素本身的 UI 自动化提供程序支持 属性，则返回 属性的值。 否则，如果 ignoreDefaultValue 为 false，则返回由 UI 自动化指定的默认属性。 有关默认属性的信息，请参阅 的属性 AutomationElement标识符字段，例如 AcceleratorKeyProperty。

方法返回 GetCurrentPropertyValue 的值在调用时是最新的。 随后，与用户界面 (UI) 交互的其他应用程序可能会更改该值。

对于某些形式的 UI，此方法会产生跨进程性能开销。 应用程序可以通过缓存属性，然后使用 检索它们 GetCachedPropertyValue来集中开销。