DWFToolkit::DWFXPackageWriter Class Reference
[DWF Package API]

#include "dwf/package/writer/DWFXPackageWriter.h"

Collaboration diagram for DWFToolkit::DWFXPackageWriter:

Collaboration graph
[legend]
List of all members.

Detailed Description

This class is used to publish DWFX package files.

Since:
7.4.0
Todo:
Add direct publishing to DWFOutputStream in addition to DWFFile respresentation.

Definition at line 67 of file DWFXPackageWriter.h.

Public Types

typedef enum DWFToolkit::DWFXPackageWriter::teProxyGraphicsRulesType teProxyGraphicsRulesType
 These enumerations are used to specify whether proxy content, if specified, is added to the package. If eAlways is specified, proxy content will always be added. If eIfNoPageOutput is specified, proxy content will only be added if no other FixedPage content would be generated. If eIfOnlyPartialPageOutput is specified, proxy content only be added if at least one section exists which provides no FixedPage content.
enum  teProxyGraphicsRulesType
 These enumerations are used to specify whether proxy content, if specified, is added to the package. If eAlways is specified, proxy content will always be added. If eIfNoPageOutput is specified, proxy content will only be added if no other FixedPage content would be generated. If eIfOnlyPartialPageOutput is specified, proxy content only be added if at least one section exists which provides no FixedPage content.

Public Member Functions

_DWFTK_API DWFXPackageWriter (const DWFFile &rDWFPackageFile, const DWFString &zDWFPackagePassword=L"", DWFXPackageVersionExtension *pVersionExtension=NULL, bool bNoPasswordSalting=true) throw ()
virtual _DWFTK_API ~DWFXPackageWriter () throw ()
virtual _DWFTK_API void addSection (DWFSection *pSection, DWFInterface *pInterface=NULL) throw ( DWFException )
virtual _DWFTK_API void addGlobalSection (DWFGlobalSection *pSection) throw ( DWFException )
virtual _DWFTK_API void addProxyGraphicsSection (DWFSection *pSection, teProxyGraphicsRulesType eRules=eAlways, bool bAsFirstPage=true) throw ( DWFException )
virtual _DWFTK_API void setCoreProperties (DWFPropertySet *pSet) throw ( DWFException )
virtual _DWFTK_API void setDWFProperties (DWFPropertySet *pSet) throw ( DWFException )
virtual _DWFTK_API void setCustomProperties (DWFPropertySet *pSet) throw ( DWFException )
virtual _DWFTK_API void addProxyPage (const DWFString &zProxyPageXPSPath) throw ( DWFException )

Public Attributes

 L
const DWFStringzSourceProductName = L""
const DWFString const DWFStringzSourceProductVersion = L""
const DWFString const DWFString
const DWFString
zDWFProductVendor = L""
const DWFString const DWFString
const DWFString const DWFString
zDWFProductVersion = L""
const DWFString const DWFString
const DWFString const DWFString
DWFZipFileDescriptor::teFileMode 
eCompressionMode

Classes

class  DWFXUndeclaredContentTypeReceiver
class  DWFXUndeclaredPackageRelationshipsReceiver
class  DWFXUndeclaredResourceReceiver


Constructor & Destructor Documentation

_DWFTK_API DWFToolkit::DWFXPackageWriter::DWFXPackageWriter const DWFFile rDWFPackageFile,
const DWFString zDWFPackagePassword = L"",
DWFXPackageVersionExtension pVersionExtension = NULL,
bool  bNoPasswordSalting = true
throw ()
 

Constructor

Parameters:
rDWFPackageFile Identifies the DWFX file to publish.
zDWFPackagePassword Package password.
bNoPasswordSalting No password salting, true or false.
pVersionExtension Optional version extension object to modify the file format version
Exceptions:
None 

virtual _DWFTK_API DWFToolkit::DWFXPackageWriter::~DWFXPackageWriter  )  throw () [virtual]
 

Destructor

Exceptions:
None 


Member Function Documentation

virtual _DWFTK_API void DWFToolkit::DWFXPackageWriter::addGlobalSection DWFGlobalSection pSection  )  throw ( DWFException ) [virtual]
 

virtual _DWFTK_API void DWFToolkit::DWFXPackageWriter::addProxyGraphicsSection DWFSection pSection,
teProxyGraphicsRulesType  eRules = eAlways,
bool  bAsFirstPage = true
throw ( DWFException ) [virtual]
 

This is used to pass proxy graphics content to the package writer for serialization. The provided section should have resources that can be serialized such that valid XPS graphics are produced.

Parameters:
pSection The section containing the proxy content resources. This pointer will be deleted with the DWFCORE_FREE_OBJECT macro.
eRules Values of type teProxyGraphicsRulesType, specifying in which cases the proxy content should be used.
bAsFirstPage A boolean specifying whether the proxy graphics should be the first page (true), or the last page (false).
Exceptions:
DWFException 

virtual _DWFTK_API void DWFToolkit::DWFXPackageWriter::addProxyPage const DWFString zProxyPageXPSPath  )  throw ( DWFException ) [virtual]
 

This is used to add default proxy page to the package from a source proxy page XPS file. The provided proxy page XPS file should be with a full path name.

Parameters:
zProxyPageXPSPath A specified culture proxy page XPS file.
Exceptions:
DWFException 

virtual _DWFTK_API void DWFToolkit::DWFXPackageWriter::addSection DWFSection pSection,
DWFInterface pInterface = NULL
throw ( DWFException ) [virtual]
 

(DWFSection* pSection, DWFInterface* pInterface = NULL)

virtual _DWFTK_API void DWFToolkit::DWFXPackageWriter::setCoreProperties DWFPropertySet pSet  )  throw ( DWFException ) [virtual]
 

This is used to pass properties, conforming to the OPC-defined CoreProperties specification, to the package writer for serialization. For DWFX files the properties get serialized into the core properties separate part. The provided property set must have the core properties schema ID. Any properties that that do not conform to the schema will be ignored.

Parameters:
pSet The property set containing the properties. The property set must have it's schema ID set to OPCXML::kzSchemaID_CoreProperties.
Exceptions:
DWFException 

virtual _DWFTK_API void DWFToolkit::DWFXPackageWriter::setCustomProperties DWFPropertySet pSet  )  throw ( DWFException ) [virtual]
 

This can be used to serialize all documents custom properties provided by the publisher. This is is serilized into a separate part in DWFX. The provided property set should not contain nested any subsets since these will be ignored during serialization.

Parameters:
pSet The property set containing the properties.
Exceptions:
DWFException 

virtual _DWFTK_API void DWFToolkit::DWFXPackageWriter::setDWFProperties DWFPropertySet pSet  )  throw ( DWFException ) [virtual]
 

This is used to pass properties, conforming to the DWF properties specification, to the package writer for serialization. For DWFX files the properties get serialized into the separate DWF Properties part. The provided property set must have the DWFProperties schema ID. Any properties that that do not conform to the schema will be ignored.

Parameters:
pSet The property set containing the properties. The property set must have it's schema ID set to DWFXXML::kzSchemaID_DWFProperties.
Exceptions:
DWFException 


Member Data Documentation

DWFToolkit::DWFXPackageWriter::L
 

(const DWFString& zSourceProductVendor = /*NOXLATE

Definition at line 277 of file DWFXPackageWriter.h.


The documentation for this class was generated from the following file:
Generated on Tue Jan 6 22:40:38 2009 for Autodesk DWF Toolkit by  doxygen 1.4.5