ITextPara::GetWidowControl method

Retrieves the widow and orphan control state for the paragraphs in a range.

Syntax


HRESULT GetWidowControl(
  long *pBool
);

Parameters

pBool

Type: long*

A tomBool value that indicates the state of widow and orphan control. It can be one of the following values.

ValueMeaning
tomTruePrevents the printing of a widow or orphan
tomFalseAllows the printing of a widow or orphan.
tomUndefinedThe widow-control property is undefined.

 

Return value

Type: HRESULT

If ITextPara::GetWidowControl 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

A widow is created when the last line of a paragraph is printed by itself at the top of a page. An orphan is when the first line of a paragraph is printed by itself at the bottom of a page.

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

 

 

Community Additions

ADD
Show:
© 2014 Microsoft