ITextPara::SetKeepTogether method (tom.h)

Article
02/22/2024

Controls whether page breaks are allowed within a paragraph in a range.

Syntax

HRESULT SetKeepTogether(
  [in] long Value
);

Parameters

[in] Value

Type: long

Indicates whether page breaks are allowed within a paragraph in a range. It can be one of the following possible values.

Value	Meaning
tomTrue	Page breaks are not allowed within a paragraph.
tomFalse	Page breaks are allowed within a paragraph.
tomUndefined	The property is undefined.

Return value

Type: HRESULT

If ITextPara::SetKeepTogether succeeds, it returns S_OK. If the method fails, it returns one of the following COM error codes. For more information about COM error codes, see Error Handling in COM.

Return code	Description
Value	Meaning
E_INVALIDARG	Invalid argument.
E_ACCESSDENIED	Write access is denied.
E_OUTOFMEMORY	Insufficient memory.
CO_E_RELEASED	The paragraph formatting object is attached to a range that has been deleted.

Remarks

This property corresponds to the PFE_KEEP effect described in the PARAFORMAT2 structure.

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	tom.h
DLL	Msftedit.dll