InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IHyperlinkMarker Class Referenceabstract

#include <IHyperlinkMarker.h>

Inheritance diagram for IHyperlinkMarker:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IHYPERLINKTEXTMARKER }
 

Public Member Functions

virtual UID GetHyperlinkSourceUID () const =0
 
virtual UID GetHyperlinkDestinationUID () const =0
 
virtual UID GetTextModel () const =0
 
virtual TextIndex GetLocation () const =0
 
virtual UID GetOtherMarkerUID () const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

Obsolete as we don't use markers for hyperlink sources any more. For hyperlink destinations, we use IHyperlinkTextDestinationMarker instead.

Member Function Documentation

virtual UID IHyperlinkMarker::GetHyperlinkDestinationUID () const
pure virtual

Get the hyperlink destination UID (Will return kInvalidUID if GetHyperlinkSourceUID() returns a valid UID)

Parameters
none
Returns
UID - UID of the destination
virtual UID IHyperlinkMarker::GetHyperlinkSourceUID () const
pure virtual

Get the hyperlink source UID (Will return kInvalidUID if GetHyperlinkDestinationUID() returns a valid UID)

Parameters
none
Returns
UID - UID of the source
virtual TextIndex IHyperlinkMarker::GetLocation () const
pure virtual

Get the location of this marker as a TextIndex

Parameters
none
Returns
TextIndex - This marker's location in the text strand
virtual UID IHyperlinkMarker::GetOtherMarkerUID () const
pure virtual

Get the UID of the marker that corresponds to this one

Parameters
none
Returns
UID - UID of the related marker (kInvalid if this is a destination marker)
virtual UID IHyperlinkMarker::GetTextModel () const
pure virtual

Get the UID of the text model that this marker points to

Parameters
none
Returns
UID - UID of the text model