Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Retrieves the widow and orphan control state for the paragraphs in a range.
Syntax
HRESULT GetWidowControl(
long *pValue
);
Parameters
pValue
Type: long*
A tomBool value that indicates the state of widow and orphan control. It can be one of the following values.
| Value | Meaning |
|---|---|
| tomTrue | Prevents the printing of a widow or orphan |
| tomFalse | Allows the printing of a widow or orphan. |
| tomUndefined | The 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 code | Description |
|---|---|
|
Meaning |
|
Invalid argument. |
|
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
| 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