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

#include <IINXImportValidation.h>

Inheritance diagram for IINXImportValidation:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IINXIMPORTVALIDATION }
 

Public Member Functions

virtual ErrorCode ValidateINXType (const WideString &type)=0
 
virtual ErrorCode ValidateDOMVersion (const ScriptInfo::ScriptVersion &version)=0
 
virtual ErrorCode ValidateBuildNumber (int32 buildNumber)=0
 
virtual ErrorCode ValidatePI (const WideString &target, const WideString &data)=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

Allows a client to validate that an INX file can be imported. IINXImportValidation methods are called at various points during INX validation and are used to override default behavior.

Member Function Documentation

virtual ErrorCode IINXImportValidation::ValidateBuildNumber (int32 buildNumber)
pure virtual

Called to validate the Build number. NOTE: Production files do not contain build number information. Therefore, this method will only be called for pre-release files.

Parameters
TheINX file's build number.
Returns
kSuccess if validation should continue. Otherwise, an error code.
virtual ErrorCode IINXImportValidation::ValidateDOMVersion (const ScriptInfo::ScriptVersionversion)
pure virtual

Called to validate the DOM version.

Parameters
TheINX file's DOM version.
Returns
kSuccess if validation should continue. Otherwise, an error code.
virtual ErrorCode IINXImportValidation::ValidateINXType (const WideStringtype)
pure virtual

Called to validate the file type.

Parameters
TheINX type as a string.
Returns
kSuccess if validation should continue. Otherwise, an error code.
virtual ErrorCode IINXImportValidation::ValidatePI (const WideStringtarget,
const WideStringdata 
)
pure virtual

Called to validate PIs found before the first element.

Parameters
ThePI target string.
ThePI data (probably a series of name-value pairs).
Returns
kSuccess if validation should continue. Otherwise, an error code.