AutomationElement.GetCurrentPropertyValue Methode

  • Referenz

Definition

Namespace:
System.Windows.Automation
Assembly:
UIAutomationClient.dll

Ruft den aktuellen Wert der angegebenen Eigenschaft aus einem AutomationElement ab.

Überlädt

GetCurrentPropertyValue(AutomationProperty)

Ruft den Wert der angegebenen Eigenschaft für dieses AutomationElement ab. Ein geeigneter Standardwert für den Eigenschaftentyp wird für Eigenschaften zurückgegeben, die vom Zielbenutzeroberflächenelement nicht explizit unterstützt werden.
GetCurrentPropertyValue(AutomationProperty, Boolean)

Ruft den Wert der angegebenen Eigenschaft von diesem AutomationElement ab. Dabei werden optional alle Standardeigenschaften ignoriert.

Hinweise

Der von der GetCurrentPropertyValue -Methode zurückgegebene Wert ist zum Zeitpunkt des Aufrufs aktuell. Der Wert kann sich anschließend von anderen Anwendungen ändern, die mit der Benutzeroberfläche (UI) interagieren.

Bei einigen Formen der Benutzeroberfläche verursacht diese Methode prozessübergreifenden Leistungsmehraufwand. Anwendungen können den Mehraufwand konzentrieren, indem Sie Eigenschaften zwischenspeichern und dann mithilfe GetCachedPropertyValuevon abrufen.

GetCurrentPropertyValue(AutomationProperty)

Ruft den Wert der angegebenen Eigenschaft für dieses AutomationElement ab. Ein geeigneter Standardwert für den Eigenschaftentyp wird für Eigenschaften zurückgegeben, die vom Zielbenutzeroberflächenelement nicht explizit unterstützt werden.

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

Der Bezeichner der UI-Automatisierungseigenschaft, der angibt, welche Eigenschaft abgerufen werden soll.

Gibt zurück

Object

Ein Objekt, das den Wert der angegebenen Eigenschaft enthält.

Ausnahmen

ElementNotAvailableException

Die Benutzeroberfläche für das AutomationElement ist nicht mehr vorhanden.

Beispiele

Im folgenden Beispiel wird der aktuelle Wert der HelpText -Eigenschaft abgerufen. Der Standardwert wird zurückgegeben, wenn das Element keinen bereitstellt.

// 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 zum Zeitpunkt des Aufrufs aktuell. Der Wert kann sich anschließend durch andere Anwendungen ändern, die mit der Benutzeroberfläche interagieren.

Wenn der Benutzeroberflächenautomatisierungsanbieter für das Element selbst die -Eigenschaft unterstützt, wird der Wert der -Eigenschaft zurückgegeben. Andernfalls wird eine von der Benutzeroberflächenautomatisierung angegebene Standardeigenschaft zurückgegeben. Informationen zu Standardeigenschaften finden Sie in den Eigenschaftenbezeichnerfeldern von AutomationElement, z AcceleratorKeyProperty. B. .

Bei einigen Formen der Benutzeroberfläche verursacht diese Methode prozessübergreifenden Leistungsmehraufwand. Konzentrieren Sie den Mehraufwand, indem Sie Eigenschaften zwischenspeichern und dann mithilfe GetCachedPropertyValuevon abrufen.

Gilt für:

GetCurrentPropertyValue(AutomationProperty, Boolean)

Ruft den Wert der angegebenen Eigenschaft von diesem AutomationElement ab. Dabei werden optional alle Standardeigenschaften ignoriert.

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

Der Bezeichner der UI-Automatisierungseigenschaft, der angibt, welche Eigenschaft abgerufen werden soll.

ignoreDefaultValue
Boolean

Ein Wert, der angibt, ob ein Standardwert ignoriert werden soll, wenn die angegebene Eigenschaft unterstützt wird.

Gibt zurück

Object

Ein Objekt, das den Wert der angegebenen Eigenschaft enthält, oder NotSupported, wenn das Element keinen Wert bereitstellt und ignoreDefaultValue den Wert true aufweist.

Ausnahmen

ElementNotAvailableException

Die Benutzeroberfläche für das AutomationElement ist nicht mehr vorhanden.

Beispiele

Das folgende Beispiel ruft den aktuellen Wert der HelpText Eigenschaft ab, gibt aber an, dass, wenn das Element selbst keinen Wert für die Eigenschaft bereitstellt, NotSupported anstelle eines Standardwerts zurückgegeben werden soll.

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

ignoreDefaultValue Die Übergabe false entspricht dem Aufrufen AutomationElement.GetCurrentPropertyValue(AutomationProperty)von .

Wenn der Benutzeroberflächenautomatisierungsanbieter für das Element selbst die -Eigenschaft unterstützt, wird der Wert der -Eigenschaft zurückgegeben. Andernfalls, wenn ignoreDefaultValue ist false, wird eine von der Benutzeroberflächenautomatisierung angegebene Standardeigenschaft zurückgegeben. Informationen zu Standardeigenschaften finden Sie in den Eigenschaftenbezeichnerfeldern von AutomationElement, z AcceleratorKeyProperty. B. .

Der von der GetCurrentPropertyValue -Methode zurückgegebene Wert ist zum Zeitpunkt des Aufrufs aktuell. Der Wert kann sich anschließend von anderen Anwendungen ändern, die mit der Benutzeroberfläche (UI) interagieren.

Bei einigen Formen der Benutzeroberfläche verursacht diese Methode prozessübergreifenden Leistungsmehraufwand. Anwendungen können den Mehraufwand konzentrieren, indem Sie Eigenschaften zwischenspeichern und dann mithilfe GetCachedPropertyValuevon abrufen.

Gilt für: