AutomationPeer.GetName Méthode

  • Référence

Définition

Espace de noms:
Windows.UI.Xaml.Automation.Peers
Modifier

Obtient le texte qui décrit l'élément associé à cet homologue Automation. La valeur Nom de Microsoft UI Automation est l’identificateur principal utilisé par la plupart des technologies d’assistance lorsqu’elles représentent l’interface utilisateur de votre application en interagissant avec l’infrastructure Microsoft UI Automation.

public:
 virtual Platform::String ^ GetName() = GetName;
winrt::hstring GetName();
public string GetName();
function getName()
Public Function GetName () As String

Retours

String

Platform::String

winrt::hstring

Nom de l’élément qui est le propriétaire de l’homologue, tel qu’utilisé par la technologie d’assistance et d’autres clients Microsoft UI Automation.

Remarques

FrameworkElementAutomationPeer introduit le comportement de GetName en fournissant une implémentation GetNameCore intermédiaire. Si un élément a une valeur pour la propriété LabeledByMicrosoft UI Automation, la valeur Name de l’élément d’étiquetage est utilisée comme Nom.

FrameworkElementAutomationPeer introduit également un comportement par le biais d’une méthode GetPlainText interne que d’autres classes homologues par défaut peuvent remplacer afin d’accéder au modèle de contenu de ce contrôle et de retourner une valeur par défaut utile pour Name. Par exemple, toute classe dérivée de ContentControl utilise une représentation sous forme de chaîne de sa valeur Content comme nom par défaut. Cette option est activée, car ContentControlimplémente GetPlainText en interne et transmet ce comportement à toutes les classes dérivées de ContentControl . C’est ainsi que vous obtenez un nom utile par défaut à partir de la valeur de chaîne d’un Button, par exemple.

D’autres homologues spécifiques peuvent également avoir une implémentation GetNameCore intermédiaire qui fournit un moyen utile pour ce contrôle Windows Runtime particulier de fournir des valeurs intégrées pour Name. La source de ces valeurs provient d’autres propriétés d’interface utilisateur qui sont généralement définies en XAML ou en tant que code utilisateur d’application. Par exemple, TextBoxAutomationPeer implémente un comportement qui utilise la valeur de la propriété Text du propriétaire TextBox comme nom par défaut. Du point de vue du code utilisateur, le comportement par défaut peut être remplacé en appliquant une valeur de AutomationProperties.Name différente. Du point de vue de l’implémenteur/fournisseur d’homologues, le comportement par défaut de l’homologue peut être modifié en dérivant une nouvelle classe d’homologue à partir de l’homologue existant, en remplaçant GetNameCore et en lui donnant une nouvelle implémentation qui n’appellerait pas l’implémentation de base dans au moins certains cas.

Pour en savoir plus sur le comportement par défaut possible de classes d’homologues spécifiques pour les contrôles de Windows Runtime par défaut, consultez la rubrique de référence pour cette classe homologue particulière et recherchez les notes d’implémentation dans la section Remarques.

S’applique à

Voir aussi