Metodo ITextSelection::HomeKey (tom.h)

Articolo
03/03/2024

Generalizza la funzionalità della chiave Home.

Sintassi

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

Parametri

Unit

Tipo: long

Unità da usare nell'operazione Chiave home. Può accettare uno dei valori seguenti.

Valore	Significato
tomLine	A seconda di Estendi, sposta il punto di inserimento o la fine attiva all'inizio della prima riga della selezione. Questo è il valore predefinito.
tomStory	A seconda dell'estensione, sposta il punto di inserimento o la fine attiva all'inizio della prima riga della storia.
tomColumn	A seconda di Extend, sposta il punto di inserimento o la fine attiva all'inizio della prima colonna nella selezione. Questa opzione è disponibile solo se il motore TOM supporta le tabelle.
tomRow	A seconda di Estendi, sposta il punto di inserimento o la fine attiva all'inizio della prima riga nella selezione. Questa opzione è disponibile solo se il motore TOM supporta le tabelle.

Extend

Tipo: long

Flag che indica come modificare la selezione. Se Extend è zero (o tomMove), il metodo comprime la selezione in un punto di inserimento. Se Extend è 1 (o tomExtend), il metodo sposta la fine attiva e lascia l'altra fine sola. Il valore predefinito è zero.

pDelta

Tipo: long*

Puntatore a una variabile che riceve il conteggio dei caratteri che il punto di inserimento o la fine attiva viene spostato. Questo parametro può essere null.

Valore restituito

Tipo: HRESULT

Il metodo restituisce un valore HRESULT . Se il metodo ha esito positivo, restituisce S_OK. Se il metodo ha esito negativo, restituisce uno dei codici di errore seguenti. Per altre informazioni sui codici di errore COM, vedere Gestione degli errori in COM.

Codice restituito	Descrizione
E_INVALIDARG	Unità non è tomLine né tomStory.
S_FALSE	Errore per qualche altro motivo.

Commenti

I metodi ITextSelection::HomeKey e ITextSelection::EndKey vengono usati per simulare il comportamento della chiave Home/End standard.

tomLine simula il comportamento del tasto Home o End senza il tasto CTRL premuto, mentre tomStory simula il comportamento con il tasto CTRL premuto. Analogamente, tomMove simula il comportamento del tasto Home o End senza il tasto MAIUSC premuto, mentre tomExtend simula il comportamento con il tasto Maiusc premuto. Quindi HomeKey(tomStory) converte la selezione in un punto di inserimento all'inizio della storia associata, mentre HomeKey(tomStory, tomExtend) sposta la fine attiva della selezione all'inizio della storia e lascia l'altra fine in cui era.

I metodi HomeKey e EndKey sono metodi logici come i metodi Move , anziché metodi direzionali. Di conseguenza, dipendono dalla lingua che è coinvolto. Ad esempio, nel testo arabo HomeKey passa alla fine destra di una riga, mentre in testo inglese viene spostato a sinistra. Pertanto, i metodi HomeKey e EndKey sono diversi dai metodi ITextSelection::MoveLeft e ITextSelection::MoveRight. Si noti anche che il metodo HomeKey è piuttosto diverso dalla proprietà Start , ovvero il cp all'inizio della selezione. HomeKey e EndKey differiscono anche dai metodi StartOf e EndOf in cui si estendono dalla fine attiva, mentre StartOf si estende da Start e EndOf si estende da EndOf.

Requisiti

Requisito	Valore
Client minimo supportato	Windows Vista [solo app desktop]
Server minimo supportato	Windows Server 2003 [solo app desktop]
Piattaforma di destinazione	Windows
Intestazione	tom.h
DLL	Msftedit.dll