ITextPara::GetPageBreakBefore method (tom.h)
Determines whether each paragraph in the range must begin on a new page.
Syntax
HRESULT GetPageBreakBefore(
long *pValue
);
Parameters
pValue
Type: long*
A variable that is one of the following values:
| Value | Meaning |
|---|---|
| tomTrue | Each paragraph in this range must begin on a new page. |
| tomFalse | The paragraphs in this range do not need to begin on a new page. |
| tomUndefined | The 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 code | Description |
|---|---|
|
Meaning |
|
Invalid argument. |
|
The paragraph formatting object is attached to a range that has been deleted. |
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 |
See also
Conceptual
Reference