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

#include <IInCopyImportSupport.h>

Inheritance diagram for IInCopyImportSupport:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IINCOPYIMPORTSUPPORT }
 

Public Member Functions

virtual UID FindSwatchByName (IDataBase *db, const PMString &swatchName) const =0
 
virtual UID FindStyleByName (IDataBase *db, const PMString &styleName) const =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


Class IInCopyImportSupport

The IInCopyImportSupport interface provides alternate methods to match style/swatch names that are encountered in the InCopy story but not found in the style/swatch lists.

Third-parties may provide an implementation for this interface and use it along with the IInCopyImportOptions to control how various InCopy file data are imported.

In normal operation, InCopy import will try to match a swatch name or style name used in a story with one that exists in current style list/swatch table. If there is no match, the user will be presented with a dialog allowing them to assign a new style/swatch to the missing name. If there the user does not reassign a missing style/swatch, the default will be used.

Using the IInCopyImportSupport interface third-party develepers can provide an alternate method for finding a style/swatch match. If a valid IInCopyImportSupport* is provided to the IInCopyImportOptions, when a missing style/swatch is encountered, the IInCopyImportSupport->FindSwatchByName() or IInCopyImportSupport->FindStyleByName() will be called. If a valid UID is returned (!= kInvalidUID), that UID will be used to mapped the swatch/style name.


Member Function Documentation

virtual UID IInCopyImportSupport::FindStyleByName (IDataBasedb,
const PMStringstyleName 
) const
pure virtual

Returns a valid style UID by given param styleName or kInvalidUID

Parameters
dbThe database to search the style
styleNameThe style name
Returns
UID
virtual UID IInCopyImportSupport::FindSwatchByName (IDataBasedb,
const PMStringswatchName 
) const
pure virtual

Returns a valid swatch UID by given param swatchName or kInvalidUID

Parameters
dbThe database to search the swatch
swatchNameThe swatch name
Returns
UID