IMarkupTextFrags Interface

IID_IMarkupTextFrags

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

This interface provides methods that enable you to insert and remove text from a markup container that is not a part of the actual markup in the container. These text fragments are attached to the content of a markup container, but are not a part of the container itself. They are not represented in the tree for the document. They are, however, saved to the document when the document is saved (for instance, by sending the command IDM_SAVE or IDM_SAVEAS through the IOleCommandTarget interface).

Documentation: IMarkupTextFrags Interface

Methods in VTable order

IUnknown Methods

Description

QueryInterface

Returns pointers to supported interfaces.

AddRef

Increments reference count.

Release

Decrements reference count.

IMarkupTextFrags Method

Description

GetTextFragCount

Retrieves a count of the markup text fragments in a markup container.

GetTextFrag

Retrieves the text fragment for a specified index and positions a markup pointer at the fragment's location.

RemoveTextFrag

Removes the specified markup text fragment.

InsertTextFrag

Inserts a new markup text fragment at a specified markup pointer.

FindTextFragFromMarkupPointer

Looks for a markup text fragment at the location of a specified markup pointer.

GetTextFragCount

FUNCTION IMarkupTextFrags_GetTextFragCount ( _
  BYVAL pthis AS DWORD PTR _
, BYREF pcFrags AS LONG _
  ) AS LONG

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

END FUNCTION
 

GetTextFrag

FUNCTION IMarkupTextFrags_GetTextFrag ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL iFrag AS LONG _
, BYREF pbstrFrag AS STRING _
, BYVAL pPointerFrag AS DWORD _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[4] USING IMarkupTextFrags_GetTextFrag (pthis, iFrag, pbstrFrag, pPointerFrag) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

RemoveTextFrag

FUNCTION IMarkupTextFrags_RemoveTextFrag ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL iFrag AS LONG _
  ) AS LONG

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

END FUNCTION
 

InsertTextFrag

FUNCTION IMarkupTextFrags_InsertTextFrag ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL iFrag AS LONG _
, BYVAL bstrInsert AS STRING _
, BYVAL pPointerInsert AS LONG _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[6] USING IMarkupTextFrags_InsertTextFrag (pthis, iFrag, bstrInsert, pPointerInsert) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION
 

FindTextFragFromMarkupPointer

FUNCTION IMarkupTextFrags_FindTextFragFromMarkupPointer ( _
  BYVAL pthis AS DWORD PTR _
, BYVAL pPointerInsert AS LONG _
, BYREF iFrag AS LONG _
, BYREF pfFragFound AS LONG _
  ) AS LONG

  LOCAL HRESULT AS LONG
  CALL DWORD @@pthis[7] USING IMarkupTextFrags_FindTextFragFromMarkupPointer (pthis, pPointerInsert, iFrag, pfFragFound) TO HRESULT
  FUNCTION = HRESULT

END FUNCTION