IUIAutomationTextRange ::MoveEndpointByUnit, méthode (uiautomationclient.h)

Déplace un point de terminaison de la plage de texte du nombre spécifié d'unités de texte dans la plage de documents.

Syntaxe

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

Paramètres

[in] endpoint

Type : TextPatternRangeEndpoint

Valeur spécifiant le point de terminaison (début ou fin) à déplacer.

[in] unit

Type : TextUnit

Valeur spécifiant l’unité textuelle pour le déplacement, telle que ligne ou paragraphe.

[in] count

Type : int

Nombre d'unités à déplacer. Un nombre positif déplace le point de terminaison vers l'avant. Un nombre négatif le déplace vers l'arrière. 0 n'a aucun effet.

[out, retval] moved

Type : int*

Reçoit le nombre d’unités réellement déplacées. Cette valeur peut être inférieure 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é, jusqu’à 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.

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 (c’est-à-dire que le début est toujours inférieur ou égal à la fin).

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 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

IUIAutomationTextRange

UI Automation prise en charge du contenu textuel