GetKeepTogether

ITextPara::GetKeepTogether method

Determines whether page breaks are allowed within paragraphs.

Syntax


HRESULT GetKeepTogether(
   long *pBool
);

Parameters

pBool

Type: long*

A variable that is one of the following 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::GetKeepTogether 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.

 

Remarks

This property corresponds to the PFE_KEEP 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
SetKeepTogether
PARAFORMAT2
Conceptual
Text Object Model

 

 

Show:
© 2016 Microsoft