Méthode ITextRangeProvider::ExpandToEnclosingUnit (uiautomationcore.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 unit
);

Paramètres

[in] unit

Type : TextUnit

Type d’unités de texte, comme le caractère, le mot, le paragraphe, etc.

Valeur retournée

Type : HRESULT

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

Remarques

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 ITextRangeProvider::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. Il est essentiel que la méthode ExpandToEnclosingUnit normalise toujours les plages de texte de manière cohérente ; sinon, d’autres aspects de la manipulation de plage de texte par unité de texte seraient imprévisibles. Le diagramme suivant montre comment ExpandToEnclosingUnit normalise une plage de texte en déplaçant les points de terminaison de la plage.

ExpandToEnclosingUnit par défaut vers 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 d’unité positionne la limite d’une plage de texte pour développer ou déplacer la plage en fonction des attributs de texte partagés (format) du texte dans la plage. Toutefois, l’utilisation de l’unité de texte de format ne doit pas déplacer ou développer 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 Text Units ou Text and TextRange Control Patterns.

Configuration requise

Client minimal pris en charge	Windows XP [applications de bureau | applications UWP]
Serveur minimal pris en charge	Windows Server 2003 [applications de bureau | applications UWP]
Plateforme cible	Windows
En-tête	uiautomationcore.h (incluez UIAutomation.h)

Voir aussi

Conceptuel

ITextProvider

ITextRangeProvider

Référence

Modèles de contrôle Text et TextRange

Vue d'ensemble des fournisseurs UI Automation