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

Définition

Récupère la valeur actuelle de la propriété spécifiée à partir d'un AutomationElement.Retrieves the current value of the specified property from an AutomationElement.

Surcharges

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

Récupère la valeur de la propriété spécifiée sur ce AutomationElement.Retrieves the value of the specified property on this AutomationElement. Une valeur par défaut appropriée pour le type de propriété est retournée pour les propriétés qui ne sont pas explicitement prises en charge par l'élément d'interface utilisateur (UI)user interface (UI) cible.An appropriate default value for the property type is returned for properties not explicitly supported by the target interface utilisateur (UI)user interface (UI) element.

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

Récupère la valeur de la propriété spécifiée sur ce AutomationElement, en ignorant éventuellement toute propriété par défaut.Retrieves the value of the specified property on this AutomationElement, optionally ignoring any default property.

Remarques

La valeur retournée par GetCurrentPropertyValue la méthode est actuelle au moment où elle est appelée.The value returned by the GetCurrentPropertyValue method is current at the time it is called. La valeur peut être modifiée par la suite par d’autres applications interface utilisateur (UI)user interface (UI)qui interagissent avec.The value can subsequently change by other applications interacting with the interface utilisateur (UI)user interface (UI).

Pour certaines formes de Interface utilisateurUI, cette méthode entraîne une surcharge des performances inter-processus.For some forms of Interface utilisateurUI, this method will incur cross-process performance overhead. Les applications peuvent concentrer la surcharge en mettant en cache les propriétés, puis GetCachedPropertyValueen les récupérant à l’aide de.Applications can concentrate overhead by caching properties and then retrieving them by using GetCachedPropertyValue.

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

Récupère la valeur de la propriété spécifiée sur ce AutomationElement.Retrieves the value of the specified property on this AutomationElement. Une valeur par défaut appropriée pour le type de propriété est retournée pour les propriétés qui ne sont pas explicitement prises en charge par l'élément d'interface utilisateur (UI)user interface (UI) cible.An appropriate default value for the property type is returned for properties not explicitly supported by the target interface utilisateur (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

Paramètres

property
AutomationProperty AutomationProperty AutomationProperty AutomationProperty

Identificateur de propriété Automation de l'interface utilisateurUI Automation spécifiant la propriété à récupérer.The Automation de l'interface utilisateurUI Automation property identifier specifying which property to retrieve.

Retours

Objet contenant la valeur de la propriété spécifiée.An object containing the value of the specified property.

Exceptions

Exemples

L’exemple suivant récupère la valeur actuelle de la HelpText propriété.The following example retrieves the current value of the HelpText property. La valeur par défaut est retournée si l’élément n’en fournit pas un.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))

Remarques

La valeur retournée par GetCurrentPropertyValue la méthode est actuelle au moment où elle est appelée.The value returned by the GetCurrentPropertyValue method is current at the time it is called. La valeur peut être modifiée par la suite par d’autres applications Interface utilisateurUIqui interagissent avec.The value can subsequently change by other applications interacting with the Interface utilisateurUI.

Si le fournisseur UI Automation pour l’élément lui-même prend en charge la propriété, la valeur de la propriété est retournée.If the UI Automation provider for the element itself supports the property, the value of the property is returned. Dans le cas contraire, une propriété Automation de l'interface utilisateurUI Automation par défaut spécifiée par est retournée.Otherwise, a default property specified by Automation de l'interface utilisateurUI Automation is returned. Pour plus d’informations sur les propriétés par défaut, consultez les champs AutomationElementd’identificateur de AcceleratorKeyPropertypropriété de, tels que.For information on default properties, see the property identifier fields of AutomationElement, such as AcceleratorKeyProperty.

Pour certaines formes de Interface utilisateurUI, cette méthode entraîne une surcharge des performances inter-processus.For some forms of Interface utilisateurUI, this method will incur cross-process performance overhead. Concentrez la charge en mettant en cache les propriétés, GetCachedPropertyValuepuis en les récupérant à l’aide de.Concentrate overhead by caching properties and then retrieving them by using GetCachedPropertyValue.

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

Récupère la valeur de la propriété spécifiée sur ce AutomationElement, en ignorant éventuellement toute propriété par défaut.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

Paramètres

property
AutomationProperty AutomationProperty AutomationProperty AutomationProperty

Identificateur de propriété Automation de l'interface utilisateurUI Automation spécifiant la propriété à récupérer.The Automation de l'interface utilisateurUI Automation property identifier specifying which property to retrieve.

ignoreDefaultValue
Boolean Boolean Boolean Boolean

Valeur qui spécifie si une valeur par défaut doit être ignorée si la propriété spécifiée est prise en charge.A value that specifies whether a default value should be ignored if the specified property is supported.

Retours

Objet contenant la valeur de la propriété spécifiée, ou NotSupported si l'élément ne fournit pas de valeur et que ignoreDefaultValue a la valeur true.An object containing the value of the specified property, or NotSupported if the element does not supply a value and ignoreDefaultValue is true.

Exceptions

Exemples

L’exemple suivant récupère la valeur actuelle de la HelpText propriété, mais spécifie que si l’élément lui-même ne fournit pas de valeur pour la propriété, NotSupported doit être retourné à la place d’une valeur par défaut.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)

Remarques

En passant false dans ignoreDefaultValue équivaut à appeler AutomationElement.GetCurrentPropertyValue(AutomationProperty).Passing false in ignoreDefaultValue is equivalent to calling AutomationElement.GetCurrentPropertyValue(AutomationProperty).

Si le fournisseur UI Automation pour l’élément lui-même prend en charge la propriété, la valeur de la propriété est retournée.If the UI Automation provider for the element itself supports the property, the value of the property is returned. Sinon, si ignoreDefaultValue est false, une propriété par défaut spécifiée Automation de l'interface utilisateurUI Automation par est retournée.Otherwise, if ignoreDefaultValue is false, a default property specified by Automation de l'interface utilisateurUI Automation is returned. Pour plus d’informations sur les propriétés par défaut, consultez les champs AutomationElementd’identificateur de AcceleratorKeyPropertypropriété de, tels que.For information on default properties, see the property identifier fields of AutomationElement, such as AcceleratorKeyProperty.

La valeur retournée par GetCurrentPropertyValue la méthode est actuelle au moment où elle est appelée.The value returned by the GetCurrentPropertyValue method is current at the time it is called. La valeur peut être modifiée par la suite par d’autres applications interface utilisateur (UI)user interface (UI)qui interagissent avec.The value can subsequently change by other applications interacting with the interface utilisateur (UI)user interface (UI).

Pour certaines formes de Interface utilisateurUI, cette méthode entraîne une surcharge des performances inter-processus.For some forms of Interface utilisateurUI, this method will incur cross-process performance overhead. Les applications peuvent concentrer la surcharge en mettant en cache les propriétés, puis GetCachedPropertyValueen les récupérant à l’aide de.Applications can concentrate overhead by caching properties and then retrieving them by using GetCachedPropertyValue.

S’applique à