ITextSelection::HomeKey-Methode (tom.h)

Artikel
08/26/2023

Generalisiert die Funktionalität des Startschlüssels.

Syntax

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

Parameter

Unit

Typ: long

Einheit, die im Schlüsselvorgang Start verwendet werden soll. Es kann einen der folgenden Werte annehmen.

Wert	Bedeutung
tomLine	Je nach Erweitern wird entweder die Einfügemarke oder das aktive Ende an den Anfang der ersten Zeile in der Auswahl verschoben. Dies ist die Standardoption.
tomStory	Je nach Erweitern wird entweder die Einfügemarke oder das aktive Ende an den Anfang der ersten Zeile im Textabschnitt verschoben.
tomColumn	Je nach Erweitern wird entweder die Einfügemarke oder das aktive Ende an den Anfang der ersten Spalte in der Auswahl verschoben. Dies ist nur verfügbar, wenn die TOM-Engine Tabellen unterstützt.
tomRow	Je nach Erweitern wird entweder die Einfügemarke oder das aktive Ende an den Anfang der ersten Zeile in der Auswahl verschoben. Dies ist nur verfügbar, wenn die TOM-Engine Tabellen unterstützt.

Extend

Typ: long

Flag, das angibt, wie die Auswahl geändert werden soll. Wenn Extend null (oder tomMove) ist, reduziert die -Methode die Auswahl auf eine Einfügemarke. Wenn Extend den Wert 1 (oder tomExtend) hat, verschiebt die Methode das aktive Ende und lässt das andere Ende allein. Der Standardwert ist 0 (null).

pDelta

Typ: long*

Zeiger auf eine Variable, die die Anzahl der Zeichen empfängt, die die Einfügemarke oder das aktive Ende verschoben haben. Dieser Parameter kann NULL sein.

Rückgabewert

Typ: HRESULT

Die -Methode gibt einen HRESULT-Wert zurück. Wenn die Methode erfolgreich ist, wird S_OK zurückgegeben. Wenn die Methode fehlschlägt, gibt sie einen der folgenden Fehlercodes zurück. Weitere Informationen zu COM-Fehlercodes finden Sie unter Fehlerbehandlung in COM.

Rückgabecode	Beschreibung
E_INVALIDARG	Unit ist weder tomLine noch tomStory.
S_FALSE	Fehler aus einem anderen Grund.

Hinweise

Die Methoden ITextSelection::HomeKey und ITextSelection::EndKey werden verwendet, um das Standardverhalten des Home/End-Schlüssels zu imitieren.

tomLine imitiert das Verhalten der Taste "Start" oder "Ende ", ohne dass die STRG-TASTE gedrückt wird, während tomStory das Verhalten mit gedrückter STRG-Taste imitiert. Ebenso imitiert tomMove das Verhalten der Taste "Start" oder "Ende ", ohne dass die UMSCHALTTASTE gedrückt wird, während tomExtend das Verhalten mit gedrückter UMSCHALTTASTE imitiert. Konvertiert also HomeKey(tomStory) die Auswahl in eine Einfügemarke am Anfang der zugeordneten Story, während HomeKey(tomStory, tomExtend) das aktive Ende der Auswahl an den Anfang der Geschichte verschiebt und das andere Ende an der Stelle belässt, an der es sich befand.

Die HomeKey - und EndKey-Methoden sind logische Methoden wie die Move-Methoden und nicht direktionale Methoden. Sie hängen also von der Sprache ab, die beteiligt ist. In arabischem Text wird homeKey beispielsweise an das rechte Ende einer Zeile verschoben, während er im englischen Text nach links verschoben wird. Daher unterscheiden sich die Methoden HomeKey und EndKey von den Methoden ITextSelection::MoveLeft und ITextSelection::MoveRight . Beachten Sie auch, dass sich die HomeKey-Methode erheblich von der Start-Eigenschaft unterscheidet, bei der es sich um den cp am Anfang der Auswahl handelt. HomeKey und EndKey unterscheiden sich auch von den StartOf - und EndOf-Methoden darin, dass sie vom aktiven Ende aus erweitert werden, während StartOf von Start und EndOf erweitert wird.

Anforderungen

Anforderung	Wert
Unterstützte Mindestversion (Client)	Windows Vista [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows Server 2003 [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	tom.h
DLL	Msftedit.dll