Edit

ITextFont::GetPosition method (tom.h)

  • Article

Gets the amount that characters are offset vertically relative to the baseline.

Syntax

HRESULT GetPosition(
  float *pValue
);

Parameters

pValue

Type: float*

The amount of vertical offset, in floating-point points.

Return value

Type: HRESULT

If the method 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
E_INVALIDARG
 Invalid argument.
CO_E_RELEASED
 The font object is attached to a range that has been deleted.

Remarks

Displayed text typically has a zero value for this property. Positive values raise the text, and negative values lower it.

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

ITextFont

Reference

SetPosition

Text Object Model