IHTMLCaret Interface

IID_IHTMLCaret

{3050F604-98B5-11CF-BB82-00AA00BDCE0B}

This interface provides methods that control the insertion point (caret) in the editor.

Documentation: IHTMLCaret Interface

Methods in VTable order

IUnknown Methods

Description

QueryInterface

Returns pointers to supported interfaces.

AddRef

Increments reference count.

Release

Decrements reference count.

IHTMLCaret Methods

Description

MoveCaretToPointer

Moves this display pointer to the specified coordinates on a page.

MoveCaretToPointerEx

Moves a display pointer to the specified position.

MoveMarkupPointerToCaret

Positions a markup pointer at the location of the display pointer to which this interface refers.

MoveDisplaypointerToCaret

Moves this display pointer to the position of another display pointer.

IsVisible

Sets the pointer gravity for the display pointer.

Show

Retrieves the pointer gravity for the display pointer.

Hide

Sets the display gravity for the display pointer.

InsertText

Retrieves the display gravity for the display pointer.

ScrollIntoView

Determines whether the display pointer has been positioned.

GetLocation

Sets the display pointer to an unpositioned state.

GetCaretDirection

Determines whether two display pointers specify the same position in the markup of an HTML document.

SetCaretDirection

Determines whether the display pointer this interface refers to is to the left of another one.

MoveCaretToPoint

FUNCTION IHTMLCaret_MoveCaretToPointer ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL pDispPointer AS DWORD _
, BYVAL fScrollIntoView AS LONG _
, BYREF eDir AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[3] USING IHTMLCaret_MoveCaretToPointer (pthis, pDispPointer, fScrollIntoView, eDir) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

MoveCaretToPointEx

FUNCTION IHTMLCaret_MoveCaretToPointerEx ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL pDispPointer AS DWORD _
, BYVAL fVisible AS LONG _
, BYVAL fScrollIntoView AS LONG _
, BYREF eDir AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[4] USING IHTMLCaret_MoveCaretToPointerEx (pthis, pDispPointer, fVisible, fScrollIntoView, eDir) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

MoveMarkupPointerToCaret

FUNCTION IHTMLCaret_MoveMarkupPointerToCaret ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL pIMarkupPointer AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[5] USING IHTMLCaret_MoveMarkupPointerToCaret (pthis, pIMarkupPointer) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

MoveDisplayPointerToCaret

FUNCTION IHTMLCaret_MoveDisplayPointerToCaret ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL pDispPointer AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[6] USING IHTMLCaret_MoveDisplayPointerToCaret (pthis, pDispPointer) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

IsVisible

FUNCTION IHTMLCaret_IsVisible ( _
  BYVAL pthis AS DWORD PTR _
, BYREF pIsVisible AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[7] USING IHTMLCaret_IsVisible (pthis, pIsVisible) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

Show

FUNCTION IHTMLCaret_Show ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL fScrollIntoView AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[8] USING IHTMLCaret_Show (pthis, fScrollIntoView) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

Hide

FUNCTION IHTMLCaret_Hide ( _
  BYVAL pthis AS DWORD PTR _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[9] USING IHTMLCaret_Hide (pthis) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

InsertText

FUNCTION IHTMLCaret_InsertText ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL strText AS STRING _
, BYVAL iLen AS LONG _
  ) AS LONG

  LOCAL HRESULT AS LONG

  strText = UCODE$(strText) & $NUL
  CALL DWORD @@pthis[10] USING IHTMLCaret_InsertText (pthis, strText, iLen) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

ScrollIntoView

FUNCTION IHTMLCaret_ScrollIntoView ( _
  BYVAL pthis AS DWORD PTR _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[11] USING IHTMLCaret_ScrollIntoView (pthis) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

GetLocation

FUNCTION IHTMLCaret_GetLocation ( _
  BYVAL pthis AS DWORD PTR _
, BYREF pPoint AS POINTAPI _
, BYVAL fTranslate AS LONG _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[12] USING IHTMLCaret_GetLocation (pthis, pPoint, fTranslate) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

GetCaretDirection

FUNCTION IHTMLCaret_GetCaretDirection ( _
  BYVAL pthis AS DWORD PTR _
, BYREF peDir AS LONG _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[13] USING IHTMLCaret_GetCaretDirection (pthis, peDir) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

SetCaretDirection

FUNCTION IHTMLCaret_SetCaretDirection ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL eDir AS LONG _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[14] USING IHTMLCaret_SetCaretDirection (pthis, eDir) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION