ITextPara::GetListTab method (tom.h)

Article
10/05/2021

Retrieves the list tab setting, which is the distance between the first-line indent and the text on the first line. The numbered or bulleted text is left-justified, centered, or right-justified at the first-line indent value.

Syntax

HRESULT GetListTab(
  float *pValue
);

Parameters

pValue

Type: float*

The list tab setting. The list tab value is in floating-point points.

Return value

Type: HRESULT

If ITextPara::GetListTab 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 determine whether the numbered or bulleted text is left-justified, centered, or right-justified, call ITextPara::GetListAlignment.

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