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

#include <IAddLinkCmdData.h>

Inheritance diagram for IAddLinkCmdData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IADDLINKCMDDATA }
 

Public Member Functions

virtual void Set (IDataBase *db, IDataLink *dl, UID pageItemUID, const PMString *formatName=nil)=0
 
virtual IDataBaseGetDataBase ()=0
 
virtual IDataLinkGetDataLink ()=0
 
virtual UID GetPageItemUID ()=0
 
virtual PMStringGetFormatName ()=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

Member Function Documentation

virtual IDataBase* IAddLinkCmdData::GetDataBase ()
pure virtual

Method to get the stored data base.

Returns
the data base.
virtual IDataLink* IAddLinkCmdData::GetDataLink ()
pure virtual

Method to get the stored data link.

Returns
the data link.
virtual PMString* IAddLinkCmdData::GetFormatName ()
pure virtual

Method to get the stored format name string.

Returns
the format name string.
virtual UID IAddLinkCmdData::GetPageItemUID ()
pure virtual

Method to get the stored page item.

Returns
the page item.
virtual void IAddLinkCmdData::Set (IDataBasedb,
IDataLinkdl,
UID pageItemUID,
const PMStringformatName = nil 
)
pure virtual

Set data to use with a add link command.

Parameters
dbis the data base of the document where you are adding the data link.
dlis the data link you are adding.
pageItemUIDis the page item to associate with the link.
formatNameis optional string descripting the type of data link. This string appears in the Link Information dialog.