IMarkupPointer::Gravity Method

Retrieves the gravity attribute of this pointer.

Syntax

HRESULT Gravity(
    POINTER_GRAVITY *pGravity
);

Parameters

  • pGravity
    [out] Pointer to a POINTER_GRAVITY enumeration that returns the gravity attribute of this pointer.

Return Value

Returns S_OK if successful, or an error value otherwise.

Remarks

Pointer gravity determines whether a markup pointer will stay with the markup to its right or left when markup is inserted at the pointer's location. By default, markup pointers have "left gravity": that is, they stay with the markup to their left when text is inserted at the pointer's location.

See Also

IMarkupPointer::SetGravity