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

#include <IDeleteCleanup.h>

Inheritance diagram for IDeleteCleanup:
IPMUnknown

Public Member Functions

virtual ICommand * GetPreDeleteCommand (ICommand *cmd, IScrapItem *scrapItem)=0
 
virtual ICommand * GetPostDeleteCommand (ICommand *cmd, IScrapItem *scrapItem)=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

Service interface that is called when a page item is deleted To use, create a Boss that implements IID_IK2SERVICEPROVIDER as kDeleteCleanupProviderImpl And IID_IDELETECLEANUP as a custom version of IDeleteCleanup...

An example is kBehaviorDeleteCleanupImpl that checks the IScrapItem parameter to see if it is referenced by behaviors, using IPageItemBehaviorXRef

See Also
IPageItemBehaviorXRef If a page item is referenced by a behavior, the behavior can then be modified so that it doesn't reference the page item being deleted...

Member Function Documentation

virtual ICommand* IDeleteCleanup::GetPostDeleteCommand (ICommand * cmd,
IScrapItem * scrapItem 
)
pure virtual

Get a command to be executed after scrapItem is deleted

Parameters
cmdThe command being executed to delete scrapItem
scrapItempage item being deleted
Returns
a command to be executed after scrapItem is deleted
virtual ICommand* IDeleteCleanup::GetPreDeleteCommand (ICommand * cmd,
IScrapItem * scrapItem 
)
pure virtual

Get a command to be executed before scrapItem is deleted

Parameters
cmdThe command being executed to delete scrapItem
scrapItempage item being deleted
Returns
a command to be executed before scrapItem is deleted