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

#include <ILinksManager.h>

Inheritance diagram for ILinksManager:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ILINKSMANAGER }
 

Public Member Functions

virtual void ReadWrite (IPMStream *s, ImplementationID prop)=0
 
virtual int32 AddLinks (const UIDList *list)=0
 
virtual int32 RemoveLinks (const UIDList *list)=0
 
virtual UIDRef GetNthLinkUID (int32 index)=0
 
virtual int32 GetLinkCount ()=0
 
virtual int32 GetLinkIndex (UID link)=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 interface contains methods to manipulate a list of data links.

To get the list of links in a document you can use: IDocument *document = theDocument; InterfacePtr<ILinksManager> linksManager(document, IID_ILINKSMANAGER);

Member Function Documentation

virtual int32 ILinksManager::AddLinks (const UIDList * list)
pure virtual

Add data links to a document.

Parameters
UIDList*list: A list of data link (IDataLink) UIDs to add to the document.
Returns
int32: Return 0 when successful.
virtual int32 ILinksManager::GetLinkCount ()
pure virtual

Get the number of data links in the list.

Returns
int32: Return the number of data links.
virtual int32 ILinksManager::GetLinkIndex (UID link)
pure virtual

Find the specified data link in the list.

Returns
int32: Return the index of data link when found, otherwise return -1.
virtual UIDRef ILinksManager::GetNthLinkUID (int32 index)
pure virtual

Get a data link from the list.

Parameters
int32index: The index of the item to get.
Returns
UIDRef: UIDRef of the data link.
virtual void ILinksManager::ReadWrite (IPMStream * s,
ImplementationID prop 
)
pure virtual

ReadWrite method. This class is persistent.

virtual int32 ILinksManager::RemoveLinks (const UIDList * list)
pure virtual

Remove data links from a document.

Parameters
UIDList*list: A list of data link (IDataLink) UIDs to remove from the document.
Returns
int32: Return 0 when successful.