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

#include <ISnippetImport.h>

Inheritance diagram for ISnippetImport:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ISNIPPETIMPORT }
 

Public Member Functions

virtual ErrorCode ImportFromStream (IPMStream *stream, IDOMElement *rootElement, ClassID policyClass=kInvalidClass, UIFlags uiFlags=kFullUI, const PMString *progressBarTitle=nil)=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 main access point for reading in (importing) snippets of XML in INX format. You can use ISnippetExport to write objects out to INX.

Access this interface via the Utils<> helper.

See Also
ISnippetExport
Utils

Member Function Documentation

virtual ErrorCode ISnippetImport::ImportFromStream (IPMStreamstream,
IDOMElementrootElement,
ClassID policyClass = kInvalidClass,
UIFlags uiFlags = kFullUI,
const PMStringprogressBarTitle = nil 
)
pure virtual

Import from a snippet in a stream, to make it a child of rootElement.

Parameters
stream- XML will is read in from this output stream (assumes whole stream is INX)
rootElement- where in the ID document the objects read in should appear.
policyClass- which import policy to use (depends on type of snippet). kInvalidClass means it will figure it out.
uiFlags- how to handle UI during the import process
progressBarTitleIN A pointer to a PMString object to be used as the title of the progress bar, or nil.
Returns
ErrorCode kSuccess if it worked