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

#include <IDataLinkAction.h>

Inheritance diagram for IDataLinkAction:
IPMUnknownCPMUnknown< IDataLinkAction >PageItemDataLinkActionCusDtLnkAliasedDataLinkAction

Public Types

enum  { kDefaultIID = IID_IDATALINKACTION }
 

Public Member Functions

virtual ErrorCode GotoLink (PMString *errorString)=0
 
virtual bool16 EnableGotoLink ()=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

An interface used by UI or scripting for datalink related actions. Clients who implement custom datalink and want to disable or change these actions should implement this interface.

Member Function Documentation

virtual bool16 IDataLinkAction::EnableGotoLink ()
pure virtual

Returns whether the go to link is allowd.

Returns
kTrue if the action is allowed, kFalse otherwise.

Implemented in PageItemDataLinkAction, and CusDtLnkAliasedDataLinkAction.

virtual ErrorCode IDataLinkAction::GotoLink (PMString * errorString)
pure virtual

Shows the page where the link is on.

Parameters
errorStringOUT, error message if failed pass in nil if error message is not needed
Returns
error code of the operation

Implemented in CusDtLnkAliasedDataLinkAction, and PageItemDataLinkAction.