en-tête uiautomationcoreapi.h

Cet en-tête est utilisé par les fonctionnalités d’accessibilité Windows. Pour plus d'informations, consultez les pages suivantes :

• Fonctionnalités d’accessibilité Windows

uiautomationcoreapi.h contient les interfaces de programmation suivantes :

Fonctions

DockPattern_SetDockPosition Ancre l’élément UI Automation à l’emplacement d’accueil demandé dans un conteneur d’ancrage.
ExpandCollapsePattern_Collapse Masque tous les nœuds descendants, contrôles ou contenu de l’élément UI Automation.
ExpandCollapsePattern_Expand Développe un contrôle à l’écran afin qu’il affiche plus d’informations.
GridPattern_GetItem Obtient le nœud d’un élément d’une grille.
InvokePattern_Invoke Envoie une requête pour activer un contrôle et initier son action unique et non équivoque. (InvokePattern_Invoke)
ItemContainerPattern_FindItemByProperty Récupère un nœud dans un nœud contenant, en fonction d’une valeur de propriété spécifiée.
LegacyIAccessiblePattern_DoDefaultAction Exécute l’action par défaut d’accessibilité active Microsoft pour l’élément. (LegacyIAccessiblePattern_DoDefaultAction)
LegacyIAccessiblePattern_GetIAccessible Récupère un objet IAccessible qui correspond à l’élément UI Automation.
LegacyIAccessiblePattern_Select Effectue une sélection Microsoft Active Accessibility. (LegacyIAccessiblePattern_Select)
LegacyIAccessiblePattern_SetValue Définit la propriété Microsoft Active Accessibility pour le nœud.
MultipleViewPattern_GetViewName Récupère le nom d'un affichage spécifique au contrôle. (MultipleViewPattern_GetViewName)
MultipleViewPattern_SetCurrentView Définit un contrôle sur une disposition différente.
RangeValuePattern_SetValue Définit la valeur d’un contrôle qui a une plage numérique.
ScrollItemPattern_ScrollIntoView Fait défiler la zone de contenu d’un objet conteneur afin d’afficher l’élément UI Automation dans la région visible (fenêtre d’affichage) du conteneur.
ScrollPattern_Scroll Fait défiler la région actuellement visible de la zone de contenu du ScrollAmount spécifié, horizontalement, verticalement ou les deux.
ScrollPattern_SetScrollPercent Fait défiler un conteneur jusqu’à une position spécifique horizontalement, verticalement ou les deux.
SelectionItemPattern_AddToSelection Ajoute un élément non sélectionné à une sélection dans un contrôle.
SelectionItemPattern_RemoveFromSelection Supprime un élément de la sélection dans un conteneur de sélection.
SelectionItemPattern_Select Sélectionne un élément dans un conteneur de sélection.
SynchronizedInputPattern_Cancel Entraîne l’arrêt de l’écoute du fournisseur UI Automation pour l’entrée de la souris ou du clavier.
SynchronizedInputPattern_StartListening Provoque le fournisseur UI Automation à commencer à écouter l’entrée de la souris ou du clavier.
TextPattern_get_DocumentRange Obtient la plage de texte pour l’ensemble du document.
TextPattern_get_SupportedTextSelection Vérifie si le contenu du conteneur de texte peut être sélectionné et désélectionné.
TextPattern_GetSelection Obtient la plage actuelle du texte sélectionné à partir d’un conteneur de texte prenant en charge le modèle de texte.
TextPattern_GetVisibleRanges Récupère un tableau de plages de texte disjointes à partir d'un conteneur de texte où chaque plage de texte commence à la première ligne partiellement visible et se termine à la dernière ligne partiellement visible.
TextPattern_RangeFromChild Obtient la plage de texte qu’un nœud donné couvre.
TextPattern_RangeFromPoint Récupère la plage de texte dégénérée (vide) la plus proche des coordonnées d’écran spécifiées. (TextPattern_RangeFromPoint)
TextRange_AddToSelection Ajoute à la collection existante de texte mis en surbrillance dans un conteneur de texte qui prend en charge plusieurs sélections disjointes en mettant en surbrillance du texte supplémentaire correspondant aux points de terminaison Début et Fin de la plage de texte appelante.
TextRange_Clone Copie une plage de texte.
TextRange_Compare Compare deux plages de texte.
TextRange_CompareEndpoints Retourne une valeur indiquant si deux plages de texte ont des points de terminaison identiques.
TextRange_ExpandToEnclosingUnit Étend la plage de texte à une unité plus ou plus petite, telle que Caractère, Word, Ligne ou Page.
TextRange_FindAttribute Recherche dans une direction spécifiée le premier morceau de texte prenant en charge un attribut de texte spécifié.
TextRange_FindText Retourne la première plage de texte dans la direction spécifiée qui contient le texte recherché par le client.
TextRange_GetAttributeValue Obtient la valeur d’un attribut de texte pour une plage de texte.
TextRange_GetBoundingRectangles Récupère le nombre minimal de rectangles englobants qui peuvent entourer la plage, un rectangle par ligne.
TextRange_GetChildren Retourne tous les éléments UI Automation contenus dans la plage de texte spécifiée.
TextRange_GetEnclosingElement Retourne le nœud du plus petit fournisseur suivant qui couvre la plage.
TextRange_GetText Retourne le texte d’une plage de texte, jusqu’à un nombre spécifié de caractères.
TextRange_Move Déplace la plage de texte le nombre spécifié d’unités demandées par le client.
TextRange_MoveEndpointByRange Déplace un point de terminaison d’une plage vers le point de terminaison d’une autre plage.
TextRange_MoveEndpointByUnit Déplace un point de terminaison de la plage le nombre d’unités spécifié.
TextRange_RemoveFromSelection Supprime le texte sélectionné, correspondant à la plage de texte appelant TextPatternRangeEndpoint_Start et aux points de terminaison TextPatternRangeEndpoint_End, d’une collection existante de texte sélectionné dans un conteneur de texte qui prend en charge plusieurs sélections disjointes.
TextRange_ScrollIntoView Fait défiler le texte pour que la plage spécifiée soit visible dans la fenêtre d’affichage.
TextRange_Select Sélectionne une plage de texte.
TogglePattern_Toggle Bascule un contrôle vers son état suivant pris en charge.
TransformPattern_Move Déplace un élément vers un emplacement spécifié à l’écran.
TransformPattern_Resize Redimensionne un élément à l’écran.
TransformPattern_Rotate Fait pivoter un élément à l’écran.
UiaAddEvent Ajoute un écouteur pour les événements sur un nœud dans l’arborescence UI Automation.
UiaClientsAreListening Obtient une valeur qui indique si une application cliente est abonnée aux événements Microsoft UI Automation.
UiaDisconnectAllProviders Libère toutes les ressources Microsoft UI Automation détenues par tous les fournisseurs associés au processus d’appel.
UiaDisconnectProvider Libère toutes les références qu’un fournisseur particulier détient aux objets Microsoft UI Automation.
UiaEventAddWindow Ajoute une fenêtre à l’écouteur d’événements.
UiaEventRemoveWindow Supprime une fenêtre de l’écouteur d’événements.
UiaFind Récupère un ou plusieurs nœuds UI Automation qui correspondent aux critères de recherche.
UiaGetErrorDescription Obtient une chaîne d’erreur afin qu’elle puisse être transmise au client. Cette méthode n’est pas utilisée directement par les clients.
UiaGetPatternProvider Récupère un modèle de contrôle.
UiaGetPropertyValue Récupère la valeur d’une propriété UI Automation.
UiaGetReservedMixedAttributeValue Récupère une valeur réservée indiquant que la valeur d’un attribut de texte Microsoft UI Automation varie au sein d’une plage de texte.
UiaGetReservedNotSupportedValue Récupère une valeur réservée indiquant qu’une propriété Microsoft UI Automation ou un attribut de texte n’est pas pris en charge.
UiaGetRootNode Récupère le nœud UI Automation racine.
UiaGetRuntimeId Récupère l’identificateur d’exécution d’un nœud UI Automation.
UiaGetUpdatedCache Mises à jour le cache des valeurs de propriété et des modèles de contrôle.
UiaHasServerSideProvider Vérifie si une fenêtre a une implémentation de fournisseur Microsoft UI Automation.
UiaHostProviderFromHwnd Obtient le fournisseur d’hôte pour une fenêtre.
UiaHPatternObjectFromVariant Obtient un objet de modèle de contrôle à partir d’un type VARIANT.
UiaHTextRangeFromVariant Obtient une plage de texte d’un type VARIANT.
UiaHUiaNodeFromVariant Obtient un HUIANODE à partir d’un type VARIANT.
UiaIAccessibleFromProvider Récupère une implémentation IAccessible qui fournit des données Microsoft Active Accessibility pour le compte d’un fournisseur Microsoft UI Automation.
UiaLookupId Obtient l’identificateur entier qui peut être utilisé dans les méthodes qui nécessitent un PROPERTYID, PATTERNID, CONTROLTYPEID, TEXTATTRIBUTEID ou EVENTID.
UiaNavigate Navigue dans l’arborescence UI Automation, récupérant éventuellement les informations mises en cache.
UiaNodeFromFocus Récupère le nœud UI Automation pour l’élément d’interface utilisateur qui a actuellement le focus d’entrée.
UiaNodeFromHandle Récupère le nœud UI Automation associé à une fenêtre.
UiaNodeFromPoint Récupère le nœud UI Automation pour l’élément au point spécifié.
UiaNodeFromProvider Récupère le nœud UI Automation pour un fournisseur d’éléments bruts.
UiaNodeRelease Supprime un nœud de la mémoire.
UiaPatternRelease Supprime un objet de modèle alloué de la mémoire.
UiaProviderForNonClient Obtient le fournisseur pour l’ensemble de la zone non cliente d’une fenêtre, ou pour un contrôle dans la zone non cliente d’une fenêtre.
UiaProviderFromIAccessible Crée un fournisseur Microsoft UI Automation basé sur l’objet Microsoft Active Accessibility spécifié.
UiaRaiseActiveTextPositionChangedEvent Appelé par un fournisseur pour informer le noyau Microsoft UI Automation qu’un contrôle de texte a modifié le texte par programmation. (UiaRaiseActiveTextPositionChangedEvent)
UiaRaiseAsyncContentLoadedEvent Appelé par un fournisseur pour informer le noyau Microsoft UI Automation que le contenu est chargé de manière asynchrone.
UiaRaiseAutomationEvent Avertit les écouteurs d’un événement.
UiaRaiseAutomationPropertyChangedEvent Appelé par les fournisseurs pour informer le noyau Microsoft UI Automation qu’une propriété d’élément a changé.
UiaRaiseChangesEvent Appelé par les fournisseurs pour informer le noyau Microsoft UI Automation qu’une modification s’est produite.
UiaRaiseNotificationEvent Appelé par les fournisseurs pour lancer un événement de notification.
UiaRaiseStructureChangedEvent Appelé par un fournisseur pour informer le noyau Microsoft UI Automation que l’arborescence a changé.
UiaRaiseTextEditTextChangedEvent Appelé par un fournisseur pour informer le noyau Microsoft UI Automation qu’un contrôle de texte a modifié le texte par programmation. (UiaRaiseTextEditTextChangedEvent)
UiaRectIsEmpty Obtient une valeur booléenne qui spécifie si toutes ses coordonnées sont définies sur 0 dans un rectangle.
UiaRectSetEmpty Définit les éléments d’une structure UiaRect sur 0.
UiaRegisterProviderCallback Inscrit la méthode définie par l’application appelée par UI Automation pour obtenir un fournisseur pour un élément.
UiaRemoveEvent Supprime un écouteur pour les événements sur un nœud dans l’arborescence UI Automation.
UiaReturnRawElementProvider Obtient une interface vers le fournisseur UI Automation pour une fenêtre.
UiaSetFocus Définit le focus d’entrée sur l’élément spécifié dans l’interface utilisateur.
UiaTextRangeRelease Supprime un objet de plage de texte alloué de la mémoire.
ValuePattern_SetValue Définit la valeur de texte d’un élément.
VirtualizedItemPattern_Realize Rend l'élément virtuel totalement accessible en tant qu'élément UI Automation. (VirtualizedItemPattern_Realize)
WindowPattern_Close Ferme une fenêtre ouverte.
WindowPattern_SetWindowVisualState Définit l’état visuel d’une fenêtre ; par exemple, pour agrandir une fenêtre.
WindowPattern_WaitForInputIdle Provoque le blocage du code appelant pendant la durée spécifiée ou jusqu’à ce que le processus associé bascule dans un état d’inactivité (en fonction de l’échéance la plus proche). (WindowPattern_WaitForInputIdle)

Fonctions de rappel

UiaEventCallback Fonction implémentée par le client appelée par UI Automation lorsqu’un événement auquel le client s’est abonné est déclenché.
UiaProviderCallback Fonction définie par l’application appelée par UI Automation pour obtenir un fournisseur côté client pour un élément.

Structures

UiaAndOrCondition Remarque Cette structure est déconseillée.  Contient des informations sur une condition complexe.
UiaAsyncContentLoadedEventArgs Remarque Cette structure est déconseillée.  Contient des informations sur un événement déclenché lorsque le contenu est chargé de manière asynchrone par un élément d’interface utilisateur.
UiaCacheRequest Remarque Cette structure est déconseillée.  Contient des informations sur une demande de mise en cache de données sur les éléments UI Automation.
UiaCondition Remarque Cette structure est déconseillée.  Contient des informations sur une condition.
UiaEventArgs Remarque Cette structure est déconseillée.  Contient des informations sur un événement Microsoft UI Automation.
UiaFindParams Remarque Cette structure est déconseillée.  Contient les paramètres utilisés dans la fonction UiaFind.
UiaNotCondition Remarque Cette structure est déconseillée.  Contient des informations sur une condition négative.
UiaPropertyChangedEventArgs Remarque Cette structure est déconseillée.  Contient des informations sur un événement déclenché lorsqu’une modification de propriété d’élément Microsoft UI Automation se produit.
UiaPropertyCondition Remarque Cette structure est déconseillée.  Contient des informations sur une condition utilisée pour rechercher les éléments UI Automation qui ont une propriété correspondante.
UiaStructureChangedEventArgs Remarque Cette structure est déconseillée.  Contient des informations sur un événement déclenché lorsque la structure de l’arborescence Microsoft UI Automation change.
UiaWindowClosedEventArgs Remarque Cette structure est déconseillée.  Contient des informations sur un événement déclenché lorsqu’une ou plusieurs fenêtres se ferment.

Énumérations

AsyncContentLoadedState Contient des valeurs qui décrivent la progression du chargement asynchrone du contenu.
AutomationElementMode L’énumération AutomationElementMode (uiautomationcoreapi.h) contient des valeurs qui spécifient le type de référence à utiliser lors du retour d’éléments UI Automation.
AutomationIdentifierType Contient les valeurs utilisées dans la fonction UiaLookupId.
ConditionType Contient des valeurs qui spécifient un type de UiaCondition.
EventArgsType Contient des valeurs qui spécifient le type d’événement décrit par une structure UiaEventArgs.
NormalizeState Contient des valeurs qui spécifient le comportement de UiaGetUpdatedCache.
PropertyConditionFlags L’énumération PropertyConditionFlags (uiautomationcoreapi.h) contient les valeurs utilisées pour créer des conditions de propriété.
ProviderType Contient des valeurs qui spécifient le type d’un fournisseur UI Automation côté client (proxy).
TreeScope L’énumération TreeScope (uiautomationcoreapi.h) contient des valeurs qui spécifient l’étendue des différentes opérations dans l’arborescence Microsoft UI Automation.
TreeTraversalOptions L’énumération TreeTraversalOptions (uiautomationcoreapi.h) définit des valeurs qui peuvent être utilisées pour personnaliser l’ordre de navigation dans l’arborescence.