ITextPara::GetLeftIndent method (tom.h)

Article
02/22/2024

Retrieves the distance used to indent all lines except the first line of a paragraph. The distance is relative to the left margin.

Syntax

HRESULT GetLeftIndent(
  float *pValue
);

Parameters

pValue

Type: float*

The left indentation, in floating-point points.

Return value

Type: HRESULT

If ITextPara::GetLeftIndent 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.
CO_E_RELEASED	The paragraph formatting object is attached to a range that has been deleted.

Remarks

To set the left indentation amount, call the ITextPara::SetIndents method.

To get the first-line indent, call ITextPara::GetFirstLineIndent.

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