AutomationElement.GetCurrentPropertyValue Méthode

Définition

Espace de noms:

System.Windows.Automation

Assembly:

UIAutomationClient.dll

Récupère la valeur actuelle de la propriété spécifiée à partir d'un AutomationElement.

Surcharges

GetCurrentPropertyValue(AutomationProperty)	Récupère la valeur de la propriété spécifiée sur ce 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 cible.
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.

Remarques

La valeur retournée par la GetCurrentPropertyValue méthode est actuelle au moment de son appel. La valeur peut ensuite être modifiée par d’autres applications qui interagissent avec l’interface utilisateur.

Pour certaines formes d’interface utilisateur, cette méthode entraîne une surcharge des performances inter-processus. Les applications peuvent concentrer la surcharge en mettant en cache les propriétés, puis en les récupérant à l’aide GetCachedPropertyValuede .

GetCurrentPropertyValue(AutomationProperty)

Récupère la valeur de la propriété spécifiée sur ce 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 cible.

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

Identificateur de propriété UI Automation spécifiant la propriété à récupérer.

Retours

Object

Objet contenant la valeur de la propriété spécifiée.

Exceptions

ElementNotAvailableException

L’interface utilisateur pour AutomationElement n’existe plus.

Exemples

L’exemple suivant récupère la valeur actuelle de la HelpText propriété . La valeur par défaut est retournée si l’élément n’en fournit pas.

// 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 la GetCurrentPropertyValue méthode est actuelle au moment de son appel. La valeur peut ensuite être modifiée par d’autres applications qui interagissent avec l’interface utilisateur.

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. Sinon, une propriété par défaut spécifiée par UI Automation est retournée. Pour plus d’informations sur les propriétés par défaut, consultez les champs d’identificateur de propriété de AutomationElement, tels que AcceleratorKeyProperty.

Pour certaines formes d’interface utilisateur, cette méthode entraîne une surcharge des performances inter-processus. Concentrez la surcharge en mettant en cache les propriétés, puis en les récupérant à l’aide GetCachedPropertyValuede .

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.

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

Identificateur de propriété UI Automation spécifiant la propriété à récupérer.

ignoreDefaultValue

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.

Retours

Object

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.

Exceptions

ElementNotAvailableException

L’interface utilisateur pour AutomationElement n’existe plus.

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é au lieu d’une valeur par défaut.

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

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. Sinon, si ignoreDefaultValue a falsela valeur , une propriété par défaut spécifiée par UI Automation est retournée. Pour plus d’informations sur les propriétés par défaut, consultez les champs d’identificateur de propriété de AutomationElement, tels que AcceleratorKeyProperty.

La valeur retournée par la GetCurrentPropertyValue méthode est actuelle au moment de son appel. La valeur peut ensuite être modifiée par d’autres applications qui interagissent avec l’interface utilisateur.

Pour certaines formes d’interface utilisateur, cette méthode entraîne une surcharge des performances inter-processus. Les applications peuvent concentrer la surcharge en mettant en cache les propriétés, puis en les récupérant à l’aide GetCachedPropertyValuede .