InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
PageItemDataLinkAction Class Reference

#include <PageItemDataLinkAction.h>

Inheritance diagram for PageItemDataLinkAction:
CPMUnknown< IDataLinkAction >IDataLinkActionIPMUnknownCusDtLnkAliasedDataLinkAction

Public Member Functions

 PageItemDataLinkAction (IPMUnknown *boss)
 
virtual ErrorCode GotoLink (PMString *errorString)
 
virtual bool16 EnableGotoLink ()
 
- Public Member Functions inherited from CPMUnknown< IDataLinkAction >
IPMUnknownQueryInterface (PMIID interfaceID) const
 
void AddRef () const
 
void Release () const
 
void PreDirty (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
 
void PreDirtyNoMessage (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
 
 CPMUnknown (const CPMUnknown &)=delete
 
CPMUnknownoperator= (const CPMUnknown &)=delete
 

Additional Inherited Members

- Protected Member Functions inherited from CPMUnknown< IDataLinkAction >
 CPMUnknown (IPMUnknown *boss)
 
- Protected Attributes inherited from CPMUnknown< IDataLinkAction >
HelperInterface fHelperInterface
 

Detailed Description

An implementation of IDataLinkAction for regular page item links. An implementation for a custom link could inherit from this implementation.

See Also
IDataLinkAction

Member Function Documentation

virtual bool16 PageItemDataLinkAction::EnableGotoLink ()
virtual

Returns whether the go to link is allowd.

Returns
kTrue if the action is allowed, kFalse otherwise.

Implements IDataLinkAction.

Reimplemented in CusDtLnkAliasedDataLinkAction.

virtual ErrorCode PageItemDataLinkAction::GotoLink (PMStringerrorString)
virtual

Shows the page where the linked page item is on. Calls IShowPageItem::Show().

See Also
IShowPageItem
Parameters
errorStringOUT, error message if failed
Returns
error code of the operation

Implements IDataLinkAction.

Reimplemented in CusDtLnkAliasedDataLinkAction.