ITextPara::SetLineSpacing method

Sets the paragraph line-spacing rule and the line spacing for a paragraph.

Syntax

HRESULT SetLineSpacing(
  long  Rule,
  float Spacing
);

Parameters

Rule

Type: long

Value of new line-spacing rule. For a list of possible rule values and further discussion, see the ITextPara::GetLineSpacingRule method.

Spacing

Type: float

Value of new line spacing. If the line-spacing rule treats the Spacing value as a linear dimension, then Spacing is given in floating-point points.

Return value

Type: HRESULT

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

Remarks

The line-spacing rule and line spacing work together, and as a result, they must be set together, much as the first and left indents need to be set together.

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

GetLineSpacingRule

ITextPara

Reference

Text Object Model