IMarkupPointer::SetCling Method

  • Article

Sets or resets the cling attribute of a markup pointer.

Syntax

HRESULT SetCling(
    BOOL fCLing
);

Parameters

  • fCLing
    [in] Value of type BOOL that specifies one of the following possible values.
    • TRUE
      The pointer will move with the markup surrounding it or will lose its position setting when the markup surrounding it is deleted.
    • FALSE
      The pointer will stay in its current location when the markup surrounding it is deleted or moved.

Return Value

Returns S_OK if successful, or an error value otherwise.

Remarks

The cling attribute determines whether a markup pointer will move or be deleted with the markup around it when the markup is deleted or moved.

By default, a markup pointer does not cling to the markup surrounding it.

See Also

IMarkupPointer::Cling