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

#include <ITOCDataLinkHelper.h>

Inheritance diagram for ITOCDataLinkHelper:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ITOCDATALINKHELPER }
 

Public Member Functions

virtual ErrorCode AddTOCDataLink (const UIDRef &datalinkRef, const UIDRef &storyRef, const UIDRef &tocStyleRef)=0
 
virtual ErrorCode AddTOCDataLink (const UIDList *itemList)=0
 
virtual ErrorCode RemoveTOCDataLink (const UIDRef &datalinkRef, const UIDRef &storyRef, const UIDRef &tocStyleRef)=0
 
virtual ErrorCode RemoveTOCDataLink (const UIDList *itemList)=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 is a helper interface to attach/remove data link related to table of content from the story.

See Also
kAttachTOCDataLinkCmdBoss and kRemoveTOCDataLinkCmdBoss.

Member Function Documentation

virtual ErrorCode ITOCDataLinkHelper::AddTOCDataLink (const UIDRef & datalinkRef,
const UIDRef & storyRef,
const UIDRef & tocStyleRef 
)
pure virtual

This is a helper interface to add an table of content(TOC) link to the story and have the story back reference to the datalink. This is all through the AttachTOCDataLinkCmd.

Parameters
datalinkRefIN UIDRef of datalink to be attached to the TOC style's link manager.
storyRefIN UIDRef of story stored in the datalink.
tocStyleRefIN UIDRef o TOC style.
Returns
ErrorCode the result of the operation. By default, it return kSuccess.
virtual ErrorCode ITOCDataLinkHelper::AddTOCDataLink (const UIDList * itemList)
pure virtual

This is a helper interface to add an table of content(TOC) link to the story and have the story back reference to the datalink. This is all through the AttachTOCDataLinkCmd.

Parameters
itemListIN the list of datalinks to be attached to the TOC style's link manager.
Returns
ErrorCode the result of the operation. By default, it return kSuccess.
virtual ErrorCode ITOCDataLinkHelper::RemoveTOCDataLink (const UIDRef & datalinkRef,
const UIDRef & storyRef,
const UIDRef & tocStyleRef 
)
pure virtual

This is a helper interface to remove the table of content(TOC) link from the story and from the TOC style's link manager too. This is all through the RemoveTOCDataLinkCmd.

Parameters
datalinkRefIN UIDRef of datalink to be removed from the TOC style's link manager.
storyRefIN UIDRef of story stored in the datalink.
tocStyleRefIN UIDRef o TOC style.
Returns
ErrorCode the result of the operation.
virtual ErrorCode ITOCDataLinkHelper::RemoveTOCDataLink (const UIDList * itemList)
pure virtual

This is a helper interface to remove the table of content(TOC) link from the story and from the TOC style's link manager too. This is all through the RemoveTOCDataLinkCmd.

Parameters
itemListIN the list of datalinks to be removed from the TOC style's link manager.
Returns
ErrorCode the result of the operation. By default, it return kSuccess.