ITextPara::GetFirstLineIndent method

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

Syntax


HRESULT GetFirstLineIndent(
   float *pValue
);

Parameters

pValue

Type: float*

The first-line indentation amount in floating-point points.

Return value

Type: HRESULT

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

CO_E_RELEASED

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

 

Remarks

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

To get and set the indent for all other lines of the paragraph (that is, the left indent), use ITextPara::GetLeftIndent and ITextPara::SetIndents.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2003 [desktop apps only]

Header

Tom.h

DLL

Msftedit.dll

See also

Reference
ITextPara
GetLeftIndent
SetIndents
Conceptual
Text Object Model

 

 

Show: