ITextRange2::GetGravity method (tom.h)

Gets the gravity of this range.

Syntax

HRESULT GetGravity(
  [out, retval] long *pValue
);

Parameters

[out, retval] pValue

Type: long*

The gravity value, which can be one of the following:

tomGravityUI

tomGravityBack

tomGravityFore

tomGravityIn

tomGravityOut

Return value

Type: HRESULT

If the method succeeds, it returns NOERROR. Otherwise, it returns an HRESULT error code.

Requirements

Requirement	Value
Minimum supported client	Windows 8 [desktop apps only]
Minimum supported server	Windows Server 2012 [desktop apps only]
Target Platform	Windows
Header	tom.h
DLL	Msftedit.dll

See also

ITextRange2

ITextRange2::SetGravity