ITextPara::GetHyphenation method

Determines whether automatic hyphenation is enabled for the range.

Syntax


HRESULT GetHyphenation(
  long *pBool
);

Parameters

pBool

Type: long*

A variable that is one of the following values:

ValueMeaning
tomTrue

Automatic hyphenation is enabled.

tomFalse

Automatic hyphenation is disabled.

tomUndefined

The hyphenation property is undefined.

 

Return value

Type: HRESULT

If ITextPara::GetHyphenation 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_DONOTHYPHEN effect described in the PARAFORMAT2 structure.

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

 

 

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.