ITextPara::SetKeepTogether method

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

Syntax


HRESULT SetKeepTogether(
  [in]  long Value
);

Parameters

Value [in]

Type: long

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

ValueMeaning
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 codeDescription
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

Minimum supported client

Windows 2000 Professional [desktop apps only]

Minimum supported server

Windows 2000 Server [desktop apps only]

Header

Tom.h

DLL

Msftedit.dll

See also

Reference
ITextPara
PARAFORMAT2
Conceptual
Text Object Model

 

 

Community Additions

ADD
Show:
© 2014 Microsoft