InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
IDupHyperlinkTextSourceData Class Referenceabstract

#include <IDupHyperlinkTextSourceData.h>

Inheritance diagram for IDupHyperlinkTextSourceData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IDUPHYPERLINKTEXTSOURCEDATA }
 

Public Member Functions

virtual void Set (const UIDRef &hyperLinkSource, TextRangeReference newRangeRef, const UIDRef &targetStory)=0
 
virtual const UIDRef & GetSource () const =0
 
virtual TextRangeReference GetNewHyperlinkRangeReference () const =0
 
virtual const UIDRef & GetTargetStory () const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknown * QueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

This class stores information needed in order to duplicate a text source (used in conjunction with the DupHyperlinkTextSourceCmd.)

Member Function Documentation

virtual TextRangeReference IDupHyperlinkTextSourceData::GetNewHyperlinkRangeReference () const
pure virtual

Get the text range reference to duplicate to

Returns
- The text range reference
virtual const UIDRef& IDupHyperlinkTextSourceData::GetSource () const
pure virtual

Get the UIDRef of the source that we are duplicating

Returns
- The source UIDRef
virtual const UIDRef& IDupHyperlinkTextSourceData::GetTargetStory () const
pure virtual

Get the UIDRef of the story that we are duplicating into

Returns
- The target story UIDRef
virtual void IDupHyperlinkTextSourceData::Set (const UIDRef & hyperLinkSource,
TextRangeReference newRangeRef,
const UIDRef & targetStory 
)
pure virtual

Use this method to setup of the data

Parameters
&hyperLinkSource- the source to be duplicated
&newRangeRef- The range reference this source should be duplicated to
&targetStory- The UIDRef of the story that this hyperlink should be duplicated to