InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Facade::IDynamicTargetsFacade Class Referenceabstract
Inheritance diagram for Facade::IDynamicTargetsFacade:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IDYNAMICTARGETSFACADE }
 

Public Member Functions

virtual UIDRef GetTargetPageItemRef (const UIDRef &targetRef) const =0
 
virtual PMString GetTargetName (const UIDRef &targetRef) const =0
 
virtual bool IsTargetInMSO (const UIDRef &targetRef, UIDRef &msoRef) const =0
 
virtual bool GetTargetList (const UIDRef &ownerRef, const ISpreadDynamicContentMgr::DynamicContentType &filterType, std::vector< UID > &targetList, bool includeMasterPage=false) const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Member Function Documentation

virtual bool Facade::IDynamicTargetsFacade::GetTargetList (const UIDRefownerRef,
const ISpreadDynamicContentMgr::DynamicContentTypefilterType,
std::vector< UID > & targetList,
bool includeMasterPage = false 
) const
pure virtual

Returns a list of targets for the given owner.

Parameters
ownerRefis the owner ref
filterTypeis target type interested
targetListis the list of applicable targets for this owner.
includeMasterPageis true if including master page targets.
Returns
true is successful.
virtual PMString Facade::IDynamicTargetsFacade::GetTargetName (const UIDReftargetRef) const
pure virtual

Get name for the specified target.

Parameters
targetRefis the target to get.
Returns
name for the target.
virtual UIDRef Facade::IDynamicTargetsFacade::GetTargetPageItemRef (const UIDReftargetRef) const
pure virtual

Get the page item UIDRef for the specified target. Target could be an action UIDRef or a page item UIDRef.

Parameters
targetRefis the target to get.
Returns
page item UIDRef for the target.
virtual bool Facade::IDynamicTargetsFacade::IsTargetInMSO (const UIDReftargetRef,
UIDRefmsoRef 
) const
pure virtual

Return true if target is part of a MSO object.

Parameters
targetRefis the target to get.
msoRefis the mso ref that this target belongs to.
Returns
true if target is part of a MSO object.