ITextPara::GetPageBreakBefore method

Determines whether each paragraph in the range must begin on a new page.

Syntax


HRESULT GetPageBreakBefore(
   long *pBool
);

Parameters

pBool

Type: long*

A variable that is one of the following values:

ValueMeaning
tomTrueEach paragraph in this range must begin on a new page.
tomFalseThe paragraphs in this range do not need to begin on a new page.
tomUndefinedThe property is undefined.

 

Return value

Type: HRESULT

If ITextPara::GetPageBreakBefore 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.

CO_E_RELEASED

The paragraph formatting object is attached to a range that has been deleted.

 

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

 

 

Show: