ITextPara::GetFirstLineIndent method (tom.h)
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 code | Description |
---|---|
|
Meaning |
|
Invalid argument. |
|
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
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 |
See also
Conceptual
Reference