Méthode IUIAutomationTextRange ::ExpandToEnclosingUnit (uiautomationclient.h)

Normalise la plage de texte par l’unité de texte spécifiée. La plage est étendue si elle est plus petite que l’unité spécifiée, ou raccourcie si elle est plus longue que l’unité spécifiée.

Syntaxe

HRESULT ExpandToEnclosingUnit(
  [in] TextUnit textUnit
);

Paramètres

[in] textUnit

Type : TextUnit

Unité de texte, telle que ligne ou paragraphe.

Valeur retournée

Type : HRESULT

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

Notes

Les applications clientes telles que les lecteurs d’écran utilisent cette méthode pour récupérer le mot, la phrase ou le paragraphe qui existe au niveau du point d’insertion ou de la position d’insertion.

Malgré son nom, la méthode ExpandToEnclosingUnit n’étend pas nécessairement une plage de texte. Au lieu de cela, il « normalise » une plage de texte en déplaçant les points de terminaison afin que la plage englobe l’unité de texte spécifiée. La plage est étendue si elle est plus petite que l’unité spécifiée, ou raccourcie si elle est plus longue que l’unité spécifiée. Si la plage est déjà une quantité exacte des unités spécifiées, elle reste inchangée. Le diagramme suivant montre comment ExpandToEnclosingUnit normalise une plage de texte en déplaçant les points de terminaison de la plage.

Diagramme montrant les points de terminaison avant et après ExpandToEnclosingUnit

ExpandToEnclosingUnit utilise par défaut l’unité de texte la plus grande suivante prise en charge si l’unité de texte spécifiée n’est pas prise en charge par le contrôle.

L’ordre, de la plus petite unité à la plus grande, est le suivant :

• Caractère
• Format
• Word
• Ligne
• Paragraph
• Page
• Document

ExpandToEnclosingUnit respecte à la fois le texte visible et le texte masqué.

Comportement de plage lorsque l’unité est TextUnit::Format

TextUnit::Format, en tant que valeur unitaire , positionne la limite d’une plage de texte pour développer ou déplacer la plage en fonction des attributs de texte partagés (ou du format) du texte dans la plage. Toutefois, l’unité de Format texte ne déplace pas ou ne développe pas une plage de texte au-delà de la limite d’un objet incorporé, tel qu’une image ou un lien hypertexte. Pour plus d’informations, consultez UI Automation unités de texte ou UI Automation prise en charge du contenu textuel.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows 7, Windows Vista avec SP2 et Mise à jour de plateforme pour Windows Vista, Windows XP avec SP3 et Mise à jour de plateforme pour Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2008 R2, Windows Server 2008 avec SP2 et Platform Update pour Windows Server 2008, Windows Server 2003 avec SP2 et Platform Update pour Windows Server 2008 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	uiautomationclient.h (incluez UIAutomation.h)

Voir aussi

Interface IUIAutomationTextRange, UI Automation prise en charge du contenu textuel