AutomationElement.GetCurrentPropertyValue AutomationElement.GetCurrentPropertyValue AutomationElement.GetCurrentPropertyValue AutomationElement.GetCurrentPropertyValue Method

Definition

Ruft den aktuellen Wert der angegebenen Eigenschaft aus einem AutomationElement ab.Retrieves the current value of the specified property from an AutomationElement.

Überlädt

GetCurrentPropertyValue(AutomationProperty) GetCurrentPropertyValue(AutomationProperty) GetCurrentPropertyValue(AutomationProperty) GetCurrentPropertyValue(AutomationProperty)

Ruft den Wert der angegebenen Eigenschaft für dieses AutomationElement ab.Retrieves the value of the specified property on this AutomationElement. Ein geeigneter Standardwert für den Eigenschaftentyp wird für Eigenschaften zurückgegeben, die nicht explizit vom Benutzeroberfläche (User Interface, UI)user interface (UI)-Zielelement unterstützt werden.An appropriate default value for the property type is returned for properties not explicitly supported by the target Benutzeroberfläche (User Interface, UI)user interface (UI) element.

GetCurrentPropertyValue(AutomationProperty, Boolean) GetCurrentPropertyValue(AutomationProperty, Boolean) GetCurrentPropertyValue(AutomationProperty, Boolean) GetCurrentPropertyValue(AutomationProperty, Boolean)

Ruft den Wert der angegebenen Eigenschaft von diesem AutomationElement ab. Dabei werden optional alle Standardeigenschaften ignoriert.Retrieves the value of the specified property on this AutomationElement, optionally ignoring any default property.

Hinweise

Der von der GetCurrentPropertyValue -Methode zurückgegebene Wert ist aktuell, wenn er aufgerufen wird.The value returned by the GetCurrentPropertyValue method is current at the time it is called. Der Wert kann dann von anderen Anwendungen, die Benutzeroberfläche (User Interface, UI)user interface (UI)mit interagieren, geändert werden.The value can subsequently change by other applications interacting with the Benutzeroberfläche (User Interface, UI)user interface (UI).

Bei einigen Formen von UIUIverursacht diese Methode prozessübergreifenden Leistungs Aufwand.For some forms of UIUI, this method will incur cross-process performance overhead. Anwendungen können den Aufwand erhöhen, indem Sie Eigenschaften Zwischenspeichern und dann mithilfe GetCachedPropertyValuevon abrufen.Applications can concentrate overhead by caching properties and then retrieving them by using GetCachedPropertyValue.

GetCurrentPropertyValue(AutomationProperty) GetCurrentPropertyValue(AutomationProperty) GetCurrentPropertyValue(AutomationProperty) GetCurrentPropertyValue(AutomationProperty)

Ruft den Wert der angegebenen Eigenschaft für dieses AutomationElement ab.Retrieves the value of the specified property on this AutomationElement. Ein geeigneter Standardwert für den Eigenschaftentyp wird für Eigenschaften zurückgegeben, die nicht explizit vom Benutzeroberfläche (User Interface, UI)user interface (UI)-Zielelement unterstützt werden.An appropriate default value for the property type is returned for properties not explicitly supported by the target Benutzeroberfläche (User Interface, UI)user interface (UI) element.

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

Parameter

property
AutomationProperty AutomationProperty AutomationProperty AutomationProperty

Der BenutzeroberflächenautomatisierungUI Automation-Eigenschaftenbezeichner, der die abzurufende Eigenschaft angibt.The BenutzeroberflächenautomatisierungUI Automation property identifier specifying which property to retrieve.

Gibt zurück

Ein Objekt, das den Wert der angegebenen Eigenschaft enthältAn object containing the value of the specified property.

Ausnahmen

Die Benutzeroberfläche für das AutomationElement ist nicht mehr vorhanden.The UI for the AutomationElement no longer exists.

Beispiele

Im folgenden Beispiel wird der aktuelle Wert HelpText der-Eigenschaft abgerufen.The following example retrieves the current value of the HelpText property. Der Standardwert wird zurückgegeben, wenn das Element keinen Wert bereitstellt.The default value is returned if the element does not provide one.

// 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))

Hinweise

Der von der GetCurrentPropertyValue -Methode zurückgegebene Wert ist aktuell, wenn er aufgerufen wird.The value returned by the GetCurrentPropertyValue method is current at the time it is called. Der Wert kann dann von anderen Anwendungen, die UIUImit interagieren, geändert werden.The value can subsequently change by other applications interacting with the UIUI.

Wenn der Benutzeroberflächenautomatisierungs-Anbieter für das Element selbst die-Eigenschaft unterstützt, wird der Wert der-Eigenschaft zurückgegeben.If the UI Automation provider for the element itself supports the property, the value of the property is returned. Andernfalls wird eine von BenutzeroberflächenautomatisierungUI Automation angegebene Standard Eigenschaft zurückgegeben.Otherwise, a default property specified by BenutzeroberflächenautomatisierungUI Automation is returned. Informationen zu Standardeigenschaften finden Sie unter den Eigenschaftenbezeichnerfeldern AutomationElementvon AcceleratorKeyProperty, z. b..For information on default properties, see the property identifier fields of AutomationElement, such as AcceleratorKeyProperty.

Bei einigen Formen von UIUIverursacht diese Methode prozessübergreifenden Leistungs Aufwand.For some forms of UIUI, this method will incur cross-process performance overhead. Konzentrieren Sie sich auf den Aufwand, indem Sie Eigenschaften Zwischenspeichern GetCachedPropertyValueund dann mithilfe von abrufen.Concentrate overhead by caching properties and then retrieving them by using GetCachedPropertyValue.

GetCurrentPropertyValue(AutomationProperty, Boolean) GetCurrentPropertyValue(AutomationProperty, Boolean) GetCurrentPropertyValue(AutomationProperty, Boolean) GetCurrentPropertyValue(AutomationProperty, Boolean)

Ruft den Wert der angegebenen Eigenschaft von diesem AutomationElement ab. Dabei werden optional alle Standardeigenschaften ignoriert.Retrieves the value of the specified property on this AutomationElement, optionally ignoring any default property.

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

Parameter

property
AutomationProperty AutomationProperty AutomationProperty AutomationProperty

Der BenutzeroberflächenautomatisierungUI Automation-Eigenschaftenbezeichner, der die abzurufende Eigenschaft angibt.The BenutzeroberflächenautomatisierungUI Automation property identifier specifying which property to retrieve.

ignoreDefaultValue
Boolean Boolean Boolean Boolean

Ein Wert, der angibt, ob ein Standardwert ignoriert werden soll, wenn die angegebene Eigenschaft unterstützt wird.A value that specifies whether a default value should be ignored if the specified property is supported.

Gibt zurück

Ein Objekt, das den Wert der angegebenen Eigenschaft enthält, oder NotSupported, wenn das Element keinen Wert bereitstellt und ignoreDefaultValue den Wert true aufweist.An object containing the value of the specified property, or NotSupported if the element does not supply a value and ignoreDefaultValue is true.

Ausnahmen

Die Benutzeroberfläche für das AutomationElement ist nicht mehr vorhanden.The UI for the AutomationElement no longer exists.

Beispiele

Im folgenden Beispiel wird der aktuelle Wert HelpText der-Eigenschaft abgerufen, aber es wird angegeben, dass, wenn das Element selbst keinen Wert für die-Eigenschaft bereitstellt, NotSupported anstelle eines Standardwerts zurückgegeben werden soll.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;
' 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)

Hinweise

Das übergeben false von entspricht dem Aufrufen AutomationElement.GetCurrentPropertyValue(AutomationProperty)von. ignoreDefaultValuePassing false in ignoreDefaultValue is equivalent to calling AutomationElement.GetCurrentPropertyValue(AutomationProperty).

Wenn der Benutzeroberflächenautomatisierungs-Anbieter für das Element selbst die-Eigenschaft unterstützt, wird der Wert der-Eigenschaft zurückgegeben.If the UI Automation provider for the element itself supports the property, the value of the property is returned. Andernfalls wird eine ignoreDefaultValue von falseangegebene Standard Eigenschaft zurückgegeben, BenutzeroberflächenautomatisierungUI Automation wenn den Wert hat.Otherwise, if ignoreDefaultValue is false, a default property specified by BenutzeroberflächenautomatisierungUI Automation is returned. Informationen zu Standardeigenschaften finden Sie unter den Eigenschaftenbezeichnerfeldern AutomationElementvon AcceleratorKeyProperty, z. b..For information on default properties, see the property identifier fields of AutomationElement, such as AcceleratorKeyProperty.

Der von der GetCurrentPropertyValue -Methode zurückgegebene Wert ist aktuell, wenn er aufgerufen wird.The value returned by the GetCurrentPropertyValue method is current at the time it is called. Der Wert kann dann von anderen Anwendungen, die Benutzeroberfläche (User Interface, UI)user interface (UI)mit interagieren, geändert werden.The value can subsequently change by other applications interacting with the Benutzeroberfläche (User Interface, UI)user interface (UI).

Bei einigen Formen von UIUIverursacht diese Methode prozessübergreifenden Leistungs Aufwand.For some forms of UIUI, this method will incur cross-process performance overhead. Anwendungen können den Aufwand erhöhen, indem Sie Eigenschaften Zwischenspeichern und dann mithilfe GetCachedPropertyValuevon abrufen.Applications can concentrate overhead by caching properties and then retrieving them by using GetCachedPropertyValue.

Gilt für: