ITextPara::SetHyphenation method

Controls hyphenation for the paragraphs in the range.

Syntax

HRESULT SetHyphenation(
  long Value
);

Parameters

Value

Type: long

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

Value Meaning
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 code Description
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 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

GetHyphenation

ITextPara

Reference

Text Object Model