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

#include <IXMLImporter.h>

Inheritance diagram for IXMLImporter:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IXMLIMPORTER }
 

Public Member Functions

virtual ErrorCode DoImport (IPMStream *stream, ISAXEntityResolver *entityResolver)=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

This is the governor for the complete XML import process. It doesn't actually do any of the import work. Rather it walks through the import timeline and calls signal/responders and service providers where appropriate so that clients of the import process can perform specific actions at the appropriate time.

The timeline contains the following steps/hooks: Transformations. You can either transform the original stream or the DOM. You must have a service provider that handles kXMLImporterTransformerService Match incoming XML elements to existing elements and create new elements where needed. You must have a signal/responder that responds to kXMLImportMatchMakerSignalService Import the contents from the incoming XML into the existing XML elements You must have a service provider that handles kXMLContentHandlerService Handle Post import processes. You must have a signal/responder that responds to kXMLImporterPostImportService

Member Function Documentation

virtual ErrorCode IXMLImporter::DoImport (IPMStreamstream,
ISAXEntityResolverentityResolver 
)
pure virtual

This is the starting point for the import. This method takes an IPMStream that contains the XML.

Parameters
stream- IN The data of import information.
entityResolver- IN The entity resolver to use while handling the content
Returns
ErrorCode