IMarkupPointer2 Interface

IID_IMarkupPointer2

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

This interface provides methods that move a markup pointer within a markup container and gather information about the contents of the container.

Documentation: IMarkupPointer2 Interface

Methods in VTable order

IUnknown Methods

Description

QueryInterface

Returns pointers to supported interfaces.

AddRef

Increments reference count.

Release

Decrements reference count.

IMarkupPointer Methods

Description

OwningDoc

Retrieves the top-level document associated with this object.

Gravity

Retrieves the gravity attribute of this pointer.

SetGravity

Sets the gravity attribute of this pointer.

Cling

Retrieves the cling attribute for this markup pointer.

SetCling

Sets or resets the cling attribute of a markup pointer.

Unposition

Resets the position of the pointer.

IsPositioned

Checks the position of the pointer.

GetContainer

Retrieves the container associated with this markup pointer.

MoveAdjacentToElement

Moves the pointer adjacent to an element.

MoveToPointer

Moves this pointer to another pointer's location.

MoveToContainer

Moves the pointer to a markup container.

Left

Inspects the content of the container to the left of the markup pointer and optionally moves the pointer one position to the left.

Right

Inspects the content of the container to the right of the markup pointer and optionally moves the pointer one position to the right.

CurrentScope

Retrieves the IHTMLElement positioned in this pointer.

IsLeftOf

Checks to see whether this pointer's position is to the left of another pointer's position.

IsLeftOfOrEqualTo

Checks to see whether this pointer's position is to the left of or is equal to another pointer's position.

IsRightOf

Checks to see whether this pointer's position is to the right of another pointer's position.

IsRightOfOrEqualTo

Checks to see whether this pointer's position is to the right of or is equal to another pointer's position.

IsEqualTo

Checks to see whether this pointer's position is equal to another pointer's position.

MoveUnit

Moves the pointer one unit.

FindText

Searches for specified text, from the current pointer's position to another pointer's position.

IMarkupPointer2 Methods

Description

IsAtWordBreak

Determines if the markup pointer is positioned at a word break.

GetMarkupPosition

Retrieves the position of a markup pointer.

MoveToMarkupPosition

Moves a markup pointer to a given position in a given markup container.

MoveUnitBounded

Moves a markup pointer to a specified location in a specified direction, but not past another given markup pointer.

IsInsideURL

Determines if a markup pointer is located inside of, at the beginning of, or at the end of text that is formatted as a URL.

MoveToContent

Moves a markup pointer to a particular element in a markup container.

OwningDoc

FUNCTION IMarkupPointer2_OwningDoc ( _
  BYVAL pthis AS DWORD PTR _
, BYREF ppdoc AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[3] USING IMarkupPointer2_OwningDoc (pthis, ppdoc) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

Gravity

FUNCTION IMarkupPointer2_Gravity ( _
  BYVAL pthis AS DWORD PTR _
, BYREF pGravity AS LONG _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[4] USING IMarkupPointer2_Gravity (pthis, pGravity) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

SetGravity

FUNCTION IMarkupPointer2_SetGravity ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL pGravity AS LONG _
  ) AS LONG

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

END FUNCTION
 

Cling

FUNCTION IMarkupPointer2_Cling ( _
  BYVAL pthis AS DWORD PTR _
, BYREF pfCLing AS LONG _
  ) AS LONG

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

END FUNCTION
 

SetCling

FUNCTION IMarkupPointer2_SetCling ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL pfCLing AS LONG _
  ) AS LONG

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

END FUNCTION
 

Unposition

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

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

END FUNCTION
 

IsPositioned

FUNCTION IMarkupPointer2_IsPositioned ( _
  BYVAL pthis AS DWORD PTR _
, BYREF pfPositioned AS LONG _
  ) AS LONG

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

END FUNCTION
 

GetContainer

FUNCTION IMarkupPointer2_GetContainer ( _
  BYVAL pthis AS DWORD PTR _
, BYREF ppContainer AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[10] USING IMarkupPointer2_GetContainer (pthis, ppContainer) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

MoveAdjacentToElement

FUNCTION IMarkupPointer2_MoveAdjacentToElement ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL pElement AS DWORD _
, BYVAL eAdj AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[11] USING IMarkupPointer2_MoveAdjacentToElement (pthis, pElement, eAdj) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

MoveToPointer

FUNCTION IMarkupPointer2_MoveToPointer ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL pPointer AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[12] USING IMarkupPointer2_MoveToPointer (pthis, pPointer) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

MoveToContainer

FUNCTION IMarkupPointer2_MoveToContainer ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL pContainer AS DWORD _
, BYVAL fAtStart AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[13] USING IMarkupPointer2_MoveToContainer (pthis, pContainer, fAtStart) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

Left

DECLARE FUNCTION Proto_IMarkupPointer2_Left ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL fMove AS LONG _
, BYREF pContext AS LONG _
, BYREF ppElement AS DWORD _
, BYREF pcch AS LONG _
, BYREF pchText AS DWORD _
  ) AS LONG
 

FUNCTION IMarkupPointer2_Left ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL fMove AS LONG _
, BYREF pContext AS LONG _
, BYREF ppElement AS DWORD _
, BYREF pcch AS LONG _
, BYREF strText AS STRING _
  ) AS LONG

  LOCAL HRESULT AS LONG

  LOCAL pchText AS DWORD

  LOCAL bstrlen AS LONG

  CALL DWORD @@pthis[14] USING Proto_IMarkupPointer2_Left (pthis, fMove, pContext, ppElement, pcch, pchText) TO HRESULT

  IF ISTRUE pchText THEN

     bstrlen = lstrlenW(BYVAL pchText)

     strText = PEEK$(pchText, bstrlen * 2)

  END IF

  CoTaskMemFree pchText
  FUNCTION = HRESULT

END FUNCTION
 

Right

DECLARE FUNCTION Proto_IMarkupPointer2_Right ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL fMove AS LONG _
, BYREF pContext AS LONG _
, BYREF ppElement AS DWORD _
, BYREF pcch AS LONG _
, BYREF pchText AS DWORD _
  ) AS LONG
 

FUNCTION IMarkupPointer2_Right ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL fMove AS LONG _
, BYREF pContext AS LONG _
, BYREF ppElement AS DWORD _
, BYREF pcch AS LONG _
, BYREF strText AS STRING _
  ) AS LONG

  LOCAL HRESULT AS LONG

  LOCAL pchText AS DWORD

  LOCAL bstrlen AS LONG

  CALL DWORD @@pthis[15] USING Proto_IMarkupPointer2_Right (pthis, fMove, pContext, ppElement, pcch, pchText) TO HRESULT

  IF ISTRUE pchText THEN

     bstrlen = lstrlenW(BYVAL pchText)

     strText = PEEK$(pchText, bstrlen * 2)

  END IF

  CoTaskMemFree pchText
  FUNCTION = HRESULT

END FUNCTION
 

CurrentScope

FUNCTION IMarkupPointer2_CurrentScope ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL ppElemCurrent AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[16] USING IMarkupPointer2_CurrentScope (pthis, ppElemCurrent) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

IsLeftOf

FUNCTION IMarkupPointer2_IsLeftOf ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL pPointerThat AS DWORD _
, BYREF pfResult AS LONG _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[17] USING IMarkupPointer2_IsLeftOf (pthis, pPointerThat, pfResult) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

IsLeftOfOrEqualTo

FUNCTION IMarkupPointer2_IsLeftOfOrEqualTo ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL pPointerThat AS DWORD _
, BYREF pfResult AS LONG _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[18] USING IMarkupPointer2_IsLeftOfOrEqualTo (pthis, pPointerThat, pfResult) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

IsRightOf

FUNCTION IMarkupPointer2_IsRightOf ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL pPointerThat AS DWORD _
, BYREF pfResult AS LONG _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[19] USING IMarkupPointer2_IsRightOf (pthis, pPointerThat, pfResult) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

IsRightOfOrEqualTo

FUNCTION IMarkupPointer2_IsRightOfOrEqualTo ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL pPointerThat AS DWORD _
, BYREF pfResult AS LONG _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[20] USING IMarkupPointer2_IsRightOfOrEqualTo (pthis, pPointerThat, pfResult) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

IsEqualTo

FUNCTION IMarkupPointer2_IsEqualTo ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL pPointerThat AS DWORD _
, BYREF pfResult AS LONG _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[21] USING IMarkupPointer2_IsEqualTo (pthis, pPointerThat, pfResult) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

MoveUnit

FUNCTION IMarkupPointer2_MoveUnit ( _
  BYVAL pthis AS DWORD PTR _
, BYREF muAction AS LONG _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[22] USING IMarkupPointer2_MoveUnit (pthis, muAction) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

FindText

FUNCTION IMarkupPointer2_FindText ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL strFindText AS STRING _
, BYVAL dwFlags AS DWORD _
, BYVAL pIEndMatch AS DWORD _
, BYVAL pIEndSearch AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG

  strFindText  = UCODE$(strFindText) & $NUL
  CALL DWORD @@pthis[23] USING Proto_IMarkupPointer2_FindText (pthis, strFindText, dwFlags, pIEndMatch, pIEndSearch) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

IsAtWordBreak

FUNCTION IMarkupPointer2_IsAtWordBreak ( _
  BYVAL pthis AS DWORD PTR _
, BYREF pfAtBreak AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[24] USING IMarkupPointer2_IsAtWordBreak (pthis, pfAtBreak) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

GetMarkupPosition

FUNCTION IMarkupPointer2_GetMarkupPosition ( _
  BYVAL pthis AS DWORD PTR _
, BYREF plMP AS LONG _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[25] USING IMarkupPointer2_GetMarkupPosition (pthis, plMp) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

MoveToMarkupPosition

FUNCTION IMarkupPointer2_MoveToMarkupPosition ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL pContainer AS DWORD _
, BYVAL plMP AS LONG _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[26] USING IMarkupPointer2_MoveToMarkupPosition (pthis, pContainer, plMp) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

MoveUnitBounded

FUNCTION IMarkupPointer2_MoveUnitBounded ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL muAction AS LONG _
, BYVAL pIBoundary AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[27] USING IMarkupPointer2_MoveUnitBounded (pthis, muAction, pIBoundary) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

IsInsideURL

FUNCTION IMarkupPointer2_IsInsideURL ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL pRight AS DWORD _
, BYREF pfResult AS LONG _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[28] USING IMarkupPointer2_IsInsideURL (pthis, pRight, pfResult) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

MoveToContent

FUNCTION IMarkupPointer2_MoveToContent ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL pIElement AS DWORD _
, BYREF fAtStart AS LONG _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[29] USING IMarkupPointer2_MoveToContent (pthis, pIElement, fAtStart) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION