ITextPara::SetPageBreakBefore method

Controls whether there is a page break before each paragraph in a range.

Syntax


HRESULT SetPageBreakBefore(
  [in]  long Bool
);

Parameters

Bool [in]

Type: long

A tomBool value that controls page breaks before paragraphs. It can be one of the following values.

ValueMeaning
tomTrue

Paragraphs in this range must begin on a new page.

tomFalse

Paragraphs in this range do not need to begin on a new page.

tomToggle

Toggle the property value.

tomUndefined

The property is undefined.

 

Return value

Type: HRESULT

If ITextPara::SetPageBreakBefore 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 method is included for compatibility with Microsoft Word; it does not affect how the rich edit control displays text.

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
Conceptual
Text Object Model

 

 

Community Additions

ADD
Show:
© 2014 Microsoft