Share via


Méthode IUIAutomationTextPattern2 ::GetCaretRange (uiautomationclient.h)

Récupère une plage de texte de longueur nulle à l’emplacement du caret qui appartient au contrôle textuel.

Syntaxe

HRESULT GetCaretRange(
  [out, retval] BOOL                   *isActive,
  [out, retval] IUIAutomationTextRange **range
);

Paramètres

[out, retval] isActive

Type : BOOL*

TRUE si le contrôle textuel qui contient le caret a le focus clavier, sinon FALSE.

[out, retval] range

Type : IUIAutomationTextRange**

Reçoit une plage de texte qui représente l’emplacement actuel du caret qui appartient au contrôle textuel.

Valeur retournée

Type : HRESULT

Si cette méthode réussit, elle retourne S_OK. Sinon, elle retourne un code d’erreur HRESULT.

Remarques

Si le paramètre isActive a la valeur FALSE, le caret qui appartient au contrôle textuel peut ne pas se trouver au même emplacement que le caret système.

Cette méthode récupère une plage de texte qu’un client peut utiliser pour rechercher le rectangle englobant du caret appartenant au contrôle textuel, ou pour trouver le texte près du caret.

Configuration requise

Condition requise Valeur
Client minimal pris en charge Windows 8 [applications de bureau uniquement]
Serveur minimal pris en charge Windows Server 2012 [applications de bureau uniquement]
Plateforme cible Windows
En-tête uiautomationclient.h (incluez UIAutomation.h)

Voir aussi

IUIAutomationTextPattern2

UI Automation prise en charge du contenu textuel

Utilisation de contrôles textuels