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

#include <IInCopyImportOptions.h>

Inheritance diagram for IInCopyImportOptions:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IINCOPYIMPORTOPTIONS }
 

Public Member Functions

virtual void Set (bool16 importStyleTable, bool16 importSwatchList, bool16 importXMPData=kTrue, bool16 importXMLTagList=kTrue, IInCopyImportSupport *importSupport=nil)=0
 
virtual void ImportSupport (IInCopyImportSupport *importSupport)=0
 
virtual IInCopyImportSupportImportSupport () const =0
 
virtual void ImportStyleTable (bool16 importStyleTable)=0
 
virtual bool16 ImportStyleTable () const =0
 
virtual void ImportSwatchList (bool16 importSwatchList)=0
 
virtual bool16 ImportSwatchList () const =0
 
virtual void ImportXMPData (bool16 importXMPData)=0
 
virtual bool16 ImportXMPData () const =0
 
virtual bool16 ImportXMLTagList () 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 IInCopyImportOptions

This class is used to control the import of various elements that might exist in an InCopy file.

By setting ImportStyleTable(), ImportSwatchList() or ImportXMLTagList() to kFalse, the InCopy import code will skip the data associated with those elements in the InCopy file.

For more information on usage/purpose of ImportSupport() please see IInCopyImportSupport.h. 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.

ImportXMPData() value is ignored by the import code.

Member Function Documentation

virtual void IInCopyImportOptions::ImportStyleTable (bool16 importStyleTable)
pure virtual

Get value of import style table flag

Parameters
importStyleTable
virtual bool16 IInCopyImportOptions::ImportStyleTable () const
pure virtual

Get value of import style table flag, kTrue to import, kFalse to ignore

Parameters
none
Returns
bool16
virtual void IInCopyImportOptions::ImportSupport (IInCopyImportSupportimportSupport)
pure virtual

Set the IInCopyImportSupport* value, can be nil

Parameters
importSupport
virtual IInCopyImportSupport* IInCopyImportOptions::ImportSupport () const
pure virtual

Get the IInCopyImportSupport* value, may be nil

Parameters
none
Returns
IInCopyImportSupport*
virtual void IInCopyImportOptions::ImportSwatchList (bool16 importSwatchList)
pure virtual

Set value of import swatch list flag, kTrue to import, kFalse to ignore

Parameters
importSwatchList
virtual bool16 IInCopyImportOptions::ImportSwatchList () const
pure virtual

Get value of import swatch list flag, kTrue to import, kFalse to ignore

Parameters
none
Returns
bool16
virtual bool16 IInCopyImportOptions::ImportXMLTagList () const
pure virtual

Get value of import xml tag list flag, kTrue to import, kFalse to ignore

Parameters
none
Returns
bool16
virtual void IInCopyImportOptions::ImportXMPData (bool16 importXMPData)
pure virtual

Set value of import xmp data flag Not used, always import xmp data if it exists

Parameters
importXMPDatakTrue to import, kFalse to ignore
virtual bool16 IInCopyImportOptions::ImportXMPData () const
pure virtual

Get value of import xmp data flag, kTrue to import, kFalse to ignore Not used, always import xmp data if it exists

Parameters
none
Returns
bool16
virtual void IInCopyImportOptions::Set (bool16 importStyleTable,
bool16 importSwatchList,
bool16 importXMPData = kTrue,
bool16 importXMLTagList = kTrue,
IInCopyImportSupportimportSupport = nil 
)
pure virtual

Set method to set the options

Parameters
importStyleTablekTrue to import, kFalse to ignore
importSwatchListkTrue to import, kFalse to ignore
importXMPDataDefault to kTrue, Not used for version 2.0, always import xmp data
importXMLTagListDefault to kTrue, kTrue to import, kFalse to ignore
importSupportDefault to nil