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

Artículo
08/26/2023

Generaliza la funcionalidad de la clave Inicio.

Sintaxis

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

Parámetros

Unit

Tipo: long

Unidad que se va a usar en la operación de clave principal. Puede asumir uno de los siguientes valores.

Valor	Significado
tomLine	Dependiendo de Extender, mueve el punto de inserción o el extremo activo al principio de la primera línea de la selección. Este es el valor predeterminado.
tomStory	Dependiendo de Extend, mueve el punto de inserción o el extremo activo al principio de la primera línea del artículo.
tomColumn	Dependiendo de Extender, mueve el punto de inserción o el extremo activo al principio de la primera columna de la selección. Esto solo está disponible si el motor de TOM admite tablas.
tomRow	Dependiendo de Extender, mueve el punto de inserción o el extremo activo al principio de la primera fila de la selección. Esto solo está disponible si el motor de TOM admite tablas.

Extend

Tipo: long

Marca que indica cómo cambiar la selección. Si Extend es cero (o tomMove), el método contrae la selección en un punto de inserción. Si Extend es 1 (o tomExtend), el método mueve el extremo activo y deja solo el otro extremo. El valor predeterminado es cero.

pDelta

Tipo: long*

Puntero a una variable que recibe el recuento de caracteres que se mueve el punto de inserción o el extremo activo. Este parámetro puede ser NULL.

Valor devuelto

Tipo: HRESULT

El método devuelve un valor HRESULT . Si el método se realiza correctamente, devuelve S_OK. Si se produce un error en el método, devuelve uno de los siguientes códigos de error. Para obtener más información sobre los códigos de error COM, vea Control de errores en COM.

Código devuelto	Descripción
E_INVALIDARG	Unit no es tomLine ni tomStory.
S_FALSE	Error por algún otro motivo.

Comentarios

Los métodos ITextSelection::HomeKey e ITextSelection::EndKey se usan para imitar el comportamiento estándar de la clave Inicio/Fin.

tomLine imita el comportamiento de la tecla Inicio o Fin sin presionar la tecla Ctrl, mientras que tomStory imita el comportamiento con la tecla Ctrl presionada. De forma similar, tomMove imita el comportamiento de la tecla Inicio o Fin sin presionar la tecla Mayús, mientras que tomExtend imita el comportamiento con la tecla Mayús presionada. Así que HomeKey(tomStory) convierte la selección en un punto de inserción al principio de la historia asociada, mientras que HomeKey(tomStory, tomExtend) mueve el final activo de la selección al principio de la historia y deja el otro extremo donde estaba.

Los métodos HomeKey y EndKey son métodos lógicos como los métodos Move , en lugar de métodos direccionales. Por lo tanto, dependen del idioma implicado. Por ejemplo, en texto árabe, HomeKey se mueve al final derecho de una línea, mientras que en texto en inglés, se mueve a la izquierda. Por lo tanto, los métodos HomeKey y EndKey son diferentes de los métodos ITextSelection::MoveLeft e ITextSelection::MoveRight . Además, tenga en cuenta que el método HomeKey es bastante diferente de la propiedad Start , que es el cp al principio de la selección. HomeKey y EndKey también difieren de los métodos StartOf y EndOf en que se extienden desde el final activo, mientras que StartOf se extiende desde Start y EndOf se extiende desde End.

Requisitos

Requisito	Value
Cliente mínimo compatible	Windows Vista [solo aplicaciones de escritorio]
Servidor mínimo compatible	Windows Server 2003 [solo aplicaciones de escritorio]
Plataforma de destino	Windows
Encabezado	tom.h
Archivo DLL	Msftedit.dll