Méthode ITextRangeProvider ::MoveEndpointByUnit (uiautomationcore.h)

Déplace un point de terminaison de la plage de texte le nombre spécifié d’unités TextUnit dans la plage de documents.

Syntaxe

HRESULT MoveEndpointByUnit(
                TextPatternRangeEndpoint endpoint,
                TextUnit                 unit,
  [in]          int                      count,
  [out, retval] int                      *pRetVal
);

Paramètres

endpoint

unit

[in] count

Type : int

Nombre d'unités à déplacer. Une valeur positive déplace le point de terminaison vers l'avant. Une valeur négative le déplace vers l'arrière. Une valeur de 0 n'a pas d'effet.

[out, retval] pRetVal

Type : int*

Reçoit le nombre d’unités réellement déplacées, qui peut être inférieur au nombre demandé si le déplacement du point de terminaison s’exécute au début ou à la fin du document.

Valeur retournée

Type : HRESULT

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

Remarques

Le point de terminaison est déplacé vers l’avant ou vers l’arrière, comme spécifié, vers la limite d’unité disponible suivante. Si le point de terminaison d’origine se trouvait à la limite de l’unité de texte spécifiée, le point de terminaison est déplacé vers la limite d’unité de texte disponible suivante, comme illustré dans l’illustration suivante.

Si le point de terminaison déplacé traverse l’autre point de terminaison de la même plage de texte, l’autre point de terminaison est également déplacé, ce qui entraîne une plage dégénérée et garantit l’ordre correct du point de terminaison (autrement dit, que le début est toujours inférieur ou égal à la fin).

ITextRangeProvider ::MoveEndpointByUnit est déconseillé à l’unité de texte prise en charge suivante si l’unité de texte donnée n’est pas prise en charge par le contrôle.

L’ordre, de la plus petite à la plus grande, est répertorié ici.

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

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é, comme une image ou un lien hypertexte. Pour plus d’informations, consultez UI Automation Unités de texte ou Modèles de contrôle Text et TextRange.

Configuration requise

Condition requise	Valeur
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