ITextPara::SetHyphenation method

Controls hyphenation for the paragraphs in the range.

Syntax


HRESULT SetHyphenation(
  [in]  long Value
);

Parameters

Value [in]

Type: long

Indicates how hyphenation is controlled. It can be one of the following possible values.

ValueMeaning
tomTrue

Automatic hyphenation is enabled.

tomFalse

Automatic hyphenation is disabled.

tomUndefined

The hyphenation property is undefined.

 

Return value

Type: HRESULT

If ITextPara::SetHyphenation 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.

E_ACCESSDENIED

Write access is denied.

E_OUTOFMEMORY

Insufficient memory.

CO_E_RELEASED

The paragraph formatting object is attached to a range that has been deleted.

 

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

 

 

Community Additions

ADD
Show:
© 2014 Microsoft