Méthode ITextSelection ::HomeKey (tom.h)

Article
08/26/2023

Généralise les fonctionnalités de la clé d’accueil.

Syntaxe

HRESULT HomeKey(
  long Unit,
  long Extend,
  long *pDelta
);

Paramètres

Unit

Type : long

Unité à utiliser dans l’opération clé d’accueil. Il peut prendre l’une des valeurs suivantes.

Valeur	Signification
tomLine	En fonction de l’option Étendre, elle déplace le point d’insertion ou la fin active au début de la première ligne de la sélection. Il s’agit de la valeur par défaut.
tomStory	Selon Extend, il déplace le point d’insertion ou la fin active vers le début de la première ligne de l’article.
tomColumn	En fonction de l’option Étendre, elle déplace le point d’insertion ou la fin active au début de la première colonne de la sélection. Cette option est disponible uniquement si le moteur TOM prend en charge les tables.
tomRow	En fonction de l’option Étendre, elle déplace le point d’insertion ou la fin active au début de la première ligne de la sélection. Cette option est disponible uniquement si le moteur TOM prend en charge les tables.

Extend

Type : long

Indicateur qui indique comment modifier la sélection. Si Extend a la valeur zéro (ou tomMove), la méthode réduit la sélection à un point d’insertion. Si Extend a la valeur 1 (ou tomExtend), la méthode déplace l’extrémité active et laisse l’autre extrémité seule. La valeur par défaut est zéro.

pDelta

Type : long*

Pointeur vers une variable qui reçoit le nombre de caractères que le point d’insertion ou la fin active est déplacé. Ce paramètre peut avoir la valeur Null.

Valeur retournée

Type : HRESULT

La méthode retourne une valeur HRESULT . Si la méthode réussit, elle retourne S_OK. Si la méthode échoue, elle retourne l’un des codes d’erreur suivants. Pour plus d’informations sur les codes d’erreur COM, consultez Gestion des erreurs dans COM.

Code de retour	Description
E_INVALIDARG	Unit n’est ni tomLine ni tomStory.
S_FALSE	Échec pour une autre raison.

Remarques

Les méthodes ITextSelection ::HomeKey et ITextSelection ::EndKey sont utilisées pour reproduire le comportement standard de clé d’accueil/de fin.

tomLine imite le comportement de la touche Accueil ou Fin sans appuyer sur la touche Ctrl, tandis que tomStory imite le comportement avec la touche Ctrl enfoncée. De même, tomMove imite le comportement de la touche Accueil ou Fin sans que la touche Maj soit enfoncée, tandis que tomExtend imite le comportement avec la touche Maj enfoncée. Convertit donc HomeKey(tomStory) la sélection en point d’insertion au début de l’article associé, tandis que HomeKey(tomStory, tomExtend) déplace la fin active de la sélection au début de l’histoire et laisse l’autre extrémité là où elle était.

Les méthodes HomeKey et EndKey sont des méthodes logiques comme les méthodes Move , plutôt que des méthodes directionnelles. Ainsi, ils dépendent de la langue en cause. Par exemple, dans le texte arabe, HomeKey se déplace à l’extrémité droite d’une ligne, tandis que dans le texte anglais, elle se déplace vers la gauche. Ainsi, les méthodes HomeKey et EndKey sont différentes des méthodes ITextSelection ::MoveLeft et ITextSelection ::MoveRight . Notez également que la méthode HomeKey est très différente de la propriété Start , qui est le cp au début de la sélection. HomeKey et EndKey diffèrent également des méthodes StartOf et EndOf en ce qu’elles s’étendent à partir de la fin active, tandis que StartOf s’étend à partir de Start et EndOf s’étend de End.

Configuration requise

Condition requise	Valeur
Client minimal pris en charge	Windows Vista [applications de bureau uniquement]
Serveur minimal pris en charge	Windows Server 2003 [applications de bureau uniquement]
Plateforme cible	Windows
En-tête	tom.h
DLL	Msftedit.dll