ITextPara::SetKeepTogether-Methode (tom.h)

  • Artikel

Steuert, ob Seitenumbrüche innerhalb eines Absatzes in einem Bereich zulässig sind.

Syntax

HRESULT SetKeepTogether(
  [in] long Value
);

Parameter

[in] Value

Typ: long

Gibt an, ob Seitenumbrüche innerhalb eines Absatzes in einem Bereich zulässig sind. Es kann sich um einen der folgenden möglichen Werte handeln.

Wert Bedeutung
tomTrue
 Seitenumbrüche sind innerhalb eines Absatzes nicht zulässig.
tomFalse
 Seitenumbrüche sind innerhalb eines Absatzes zulässig.
tomUndefined
 Die Eigenschaft ist nicht definiert.

Rückgabewert

Typ: HRESULT

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

Rückgabecode Beschreibung
Wert
 Bedeutung
E_INVALIDARG
 Ungültiges Argument.
E_ACCESSDENIED
 Der Schreibzugriff wird verweigert.
E_OUTOFMEMORY
 Nicht genügend Arbeitsspeicher.
CO_E_RELEASED
 Das Absatzformatierungsobjekt wird einem gelöschten Bereich angefügt.

Hinweise

Diese Eigenschaft entspricht dem in der PARAFORMAT2-Struktur beschriebenen PFE_KEEP Effekt.

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

Siehe auch

Konzept

ITextPara

PARAFORMAT2

Referenz

Textobjektmodell