ITextPara::SetKeepWithNext method

Controls whether page breaks are allowed between the paragraphs in a range.

Syntax


HRESULT SetKeepWithNext(
  [inlong Value
);

Parameters

Value [in]

Type: long

Indicates if page breaks can be used between the paragraphs of a range. It can be one of the following possible values.

ValueMeaning
tomTrue

Page breaks are not allowed between paragraphs.

tomFalse

Page breaks are allowed between paragraphs.

tomUndefined

The property is undefined.

 

Return value

Type: HRESULT

If ITextPara::SetKeepWithNext 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_KEEPNEXT effect described in the PARAFORMAT2 structure.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

Tom.h

DLL

Msftedit.dll

See also

Reference
ITextPara
PARAFORMAT2
Conceptual
Text Object Model

 

 

Show: