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

Artigo
08/08/2024

Generaliza a funcionalidade da chave inicial.

Sintaxe

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

Parâmetros

Unit

Tipo: long

Unidade a ser usada na operação chave inicial. Ele pode assumir um dos valores a seguir.

Valor	Significado
tomLine	Dependendo de Estender, ele move o ponto de inserção ou a extremidade ativa para o início da primeira linha na seleção. Esse é o padrão.
tomStory	Dependendo de Estender, ele move o ponto de inserção ou a extremidade ativa para o início da primeira linha da história.
tomColumn	Dependendo de Estender, ele move o ponto de inserção ou a extremidade ativa para o início da primeira coluna na seleção. Isso só estará disponível se o mecanismo TOM der suporte a tabelas.
tomRow	Dependendo de Estender, ele move o ponto de inserção ou a extremidade ativa para o início da primeira linha na seleção. Isso só estará disponível se o mecanismo TOM der suporte a tabelas.

Extend

Tipo: long

Sinalizador que indica como alterar a seleção. Se Extend for zero (ou tomMove), o método recolherá a seleção para um ponto de inserção. Se Extend for 1 (ou tomExtend), o método moverá a extremidade ativa e deixará a outra extremidade sozinha. O valor padrão é zero.

pDelta

Tipo: long*

Ponteiro para uma variável que recebe a contagem de caracteres que o ponto de inserção ou o final ativo é movido. Este parâmetro pode ser nulo.

Retornar valor

Tipo: HRESULT

O método retorna um valor HRESULT . Se o método for bem-sucedido, ele retornará S_OK. Se o método falhar, ele retornará um dos seguintes códigos de erro. Para obter mais informações sobre códigos de erro COM, consulte Tratamento de erros em COM.

Código de retorno	Descrição
E_INVALIDARG	A unidade não é tomLine nem tomStory.
S_FALSE	Falha por algum outro motivo.

Comentários

Os métodos ITextSelection::HomeKey e ITextSelection::EndKey são usados para imitar o comportamento padrão da chave Home/End.

tomLine imita o comportamento da tecla Home ou End sem a tecla Ctrl pressionada, enquanto tomStory imita o comportamento com a tecla Ctrl pressionada. Da mesma forma, tomMove imita o comportamento da tecla Home ou End sem a tecla Shift pressionada, enquanto tomExtend imita o comportamento com a tecla Shift pressionada. Assim HomeKey(tomStory) , converte a seleção em um ponto de inserção no início da história associada, enquanto HomeKey(tomStory, tomExtend) move o final ativo da seleção para o início da história e deixa a outra extremidade onde ela estava.

Os métodos HomeKey e EndKey são métodos lógicos como os métodos Move , em vez de métodos direcionais. Assim, eles dependem do idioma envolvido. Por exemplo, em texto árabe, HomeKey move-se para a extremidade direita de uma linha, enquanto no texto em inglês, ela se move para a esquerda. Assim, os métodos HomeKey e EndKey são diferentes dos métodos ITextSelection::MoveLeft e ITextSelection::MoveRight . Além disso, observe que o método HomeKey é bem diferente da propriedade Start , que é o cp no início da seleção. HomeKey e EndKey também diferem dos métodos StartOf e EndOf , pois eles se estendem do final ativo, enquanto StartOf se estende de Start e EndOf estende-se de End.

Requisitos

Requisito	Valor
Cliente mínimo com suporte	Windows Vista [somente aplicativos da área de trabalho]
Servidor mínimo com suporte	Windows Server 2003 [somente aplicativos da área de trabalho]
Plataforma de Destino	Windows
Cabeçalho	tom.h
DLL	Msftedit.dll