ITextRangeProvider ::MoveEndpointByUnit, méthode (uiautomationcore.h)

Article
08/08/2024

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(
  [in]          TextPatternRangeEndpoint endpoint,
  [in]          TextUnit                 unit,
  [in]          int                      count,
  [out, retval] int                      *pRetVal
);

Paramètres

[in] endpoint

Type : TextPatternRangeEndpoint

Point de terminaison à déplacer.

[in] unit

Type : TextUnit

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

[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 se déplace vers l’arrière. La valeur 0 n’a aucun effet.

[out, retval] pRetVal

Type : int*

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

Valeur de retour

Type : HRESULT

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

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 était à 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.

Illustration montrant les points de terminaison d’une plage de texte déplaçant 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 déprécie jusqu’à 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 unité au plus grand, est répertorié ici.

caractère
format
Word
ligne
paragraphe
page
document

comportement de plage de lorsque d’unité est

TextUnit::Format en tant qu’unité de place 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 sur la limite d’un objet incorporé, telle qu’une image ou un lien hypertexte. Pour plus d’informations, consultez ui Automation Text Units ou Text and TextRange Control Patterns.

Exigences

Exigence	Valeur
client minimum pris en charge	Windows XP [applications de bureau \| Applications UWP]
serveur minimum pris en charge	Windows Server 2003 [applications de bureau \| Applications UWP]
plateforme cible	Windows
d’en-tête	uiautomationcore.h (include UIAutomation.h)

Voir aussi

conceptuelle

ITextProvider

ITextRangeProvider

de référence

modèles de contrôle Text et TextRange

Vue d’ensemble des fournisseurs UI Automation

Partager via