OfficeDoc Class

Properties   Methods   Events   Config Settings   Errors  

The OfficeDoc class implements support for the Open XML Packaging Format used in Office 2007 documents.

Syntax

OfficeDoc

Remarks

The class provides a way to extract information and content from an Open XML packaged document, examine the package properties and basic read/update facilities.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

ContentTypeCount Property (OfficeDoc Class)

The number of records in the ContentType arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetContentTypeCount();

Unicode (Windows)
INT GetContentTypeCount();

int ipworkszip_officedoc_getcontenttypecount(void* lpObj);

int GetContentTypeCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• ContentTypeIsOverride
• ContentTypeMediaType
• ContentTypeTarget

The array indices start at 0 and end at ContentTypeCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

ContentTypeIsOverride Property (OfficeDoc Class)

Specifies if this is a default content type or an override.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetContentTypeIsOverride(int iContentTypeIndex);

Unicode (Windows)
BOOL GetContentTypeIsOverride(INT iContentTypeIndex);

int ipworkszip_officedoc_getcontenttypeisoverride(void* lpObj, int contenttypeindex);

bool GetContentTypeIsOverride(int iContentTypeIndex);

Default Value

TRUE

Remarks

Specifies if this is a default content type or an override.

The ContentTypeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContentTypeCount property.

This property is read-only and not available at design time.

Data Type

Boolean

ContentTypeMediaType Property (OfficeDoc Class)

The media type for this entry, as defined by RFC2616.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetContentTypeMediaType(int iContentTypeIndex);

Unicode (Windows)
LPWSTR GetContentTypeMediaType(INT iContentTypeIndex);

char* ipworkszip_officedoc_getcontenttypemediatype(void* lpObj, int contenttypeindex);

QString GetContentTypeMediaType(int iContentTypeIndex);

Default Value

""

Remarks

The media type for this entry, as defined by RFC2616.

The ContentTypeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContentTypeCount property.

This property is read-only and not available at design time.

Data Type

String

ContentTypeTarget Property (OfficeDoc Class)

If it's a default content type, this will be the file extension it applies to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetContentTypeTarget(int iContentTypeIndex);

Unicode (Windows)
LPWSTR GetContentTypeTarget(INT iContentTypeIndex);

char* ipworkszip_officedoc_getcontenttypetarget(void* lpObj, int contenttypeindex);

QString GetContentTypeTarget(int iContentTypeIndex);

Default Value

""

Remarks

If it's a default content type, this will be the file extension it applies to. Otherwise, it will be the part name.

The ContentTypeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContentTypeCount property.

This property is read-only and not available at design time.

Data Type

String

NamespaceCount Property (OfficeDoc Class)

The number of records in the Namespace arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetNamespaceCount();

Unicode (Windows)
INT GetNamespaceCount();

int ipworkszip_officedoc_getnamespacecount(void* lpObj);

int GetNamespaceCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• NamespacePrefix
• NamespaceURI

The array indices start at 0 and end at NamespaceCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

NamespacePrefix Property (OfficeDoc Class)

The Prefix for the Namespace .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNamespacePrefix(int iNamespaceIndex);

Unicode (Windows)
LPWSTR GetNamespacePrefix(INT iNamespaceIndex);

char* ipworkszip_officedoc_getnamespaceprefix(void* lpObj, int namespaceindex);

QString GetNamespacePrefix(int iNamespaceIndex);

Default Value

""

Remarks

The NamespacePrefix for the Namespace.

The NamespaceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the NamespaceCount property.

This property is read-only and not available at design time.

Data Type

String

NamespaceURI Property (OfficeDoc Class)

Namespace URI associated with the corresponding Prefix .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetNamespaceURI(int iNamespaceIndex);

Unicode (Windows)
LPWSTR GetNamespaceURI(INT iNamespaceIndex);

char* ipworkszip_officedoc_getnamespaceuri(void* lpObj, int namespaceindex);

QString GetNamespaceURI(int iNamespaceIndex);

Default Value

""

Remarks

Namespace URI associated with the corresponding NamespacePrefix. This is usually a URL pointing to the XML schema for the namespace.

The NamespaceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the NamespaceCount property.

This property is read-only and not available at design time.

Data Type

String

PackagePath Property (OfficeDoc Class)

The path to the Open XML package file.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackagePath();
int SetPackagePath(const char* lpszPackagePath);

Unicode (Windows)
LPWSTR GetPackagePath();
INT SetPackagePath(LPCWSTR lpszPackagePath);

char* ipworkszip_officedoc_getpackagepath(void* lpObj);
int ipworkszip_officedoc_setpackagepath(void* lpObj, const char* lpszPackagePath);

QString GetPackagePath();
int SetPackagePath(QString qsPackagePath);

Default Value

""

Remarks

This property specifies the path and filename of the Open XML package to work on.

Data Type

String

PackagePropertyCount Property (OfficeDoc Class)

The number of records in the PackageProperty arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPackagePropertyCount();

Unicode (Windows)
INT GetPackagePropertyCount();

int ipworkszip_officedoc_getpackagepropertycount(void* lpObj);

int GetPackagePropertyCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• PackagePropertyDataType
• PackagePropertyName
• PackagePropertyNamespace
• PackagePropertyPropId
• PackagePropertyPropSet
• PackagePropertyValue

The array indices start at 0 and end at PackagePropertyCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

PackagePropertyDataType Property (OfficeDoc Class)

The data type associated with this property, if the information is available.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackagePropertyDataType(int iPackagePropertyIndex);

Unicode (Windows)
LPWSTR GetPackagePropertyDataType(INT iPackagePropertyIndex);

char* ipworkszip_officedoc_getpackagepropertydatatype(void* lpObj, int packagepropertyindex);

QString GetPackagePropertyDataType(int iPackagePropertyIndex);

Default Value

""

Remarks

The data type associated with this property, if the information is available.

The PackagePropertyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PackagePropertyCount property.

This property is read-only and not available at design time.

Data Type

String

PackagePropertyName Property (OfficeDoc Class)

The name of this property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackagePropertyName(int iPackagePropertyIndex);

Unicode (Windows)
LPWSTR GetPackagePropertyName(INT iPackagePropertyIndex);

char* ipworkszip_officedoc_getpackagepropertyname(void* lpObj, int packagepropertyindex);

QString GetPackagePropertyName(int iPackagePropertyIndex);

Default Value

""

Remarks

The name of this property

The PackagePropertyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PackagePropertyCount property.

This property is read-only and not available at design time.

Data Type

String

PackagePropertyNamespace Property (OfficeDoc Class)

The XML Namespace URI associated with this property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackagePropertyNamespace(int iPackagePropertyIndex);

Unicode (Windows)
LPWSTR GetPackagePropertyNamespace(INT iPackagePropertyIndex);

char* ipworkszip_officedoc_getpackagepropertynamespace(void* lpObj, int packagepropertyindex);

QString GetPackagePropertyNamespace(int iPackagePropertyIndex);

Default Value

""

Remarks

The XML Namespace URI associated with this property. For custom properties, this will be an empty string.

The PackagePropertyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PackagePropertyCount property.

This property is read-only and not available at design time.

Data Type

String

PackagePropertyPropId Property (OfficeDoc Class)

If this is a custom property, this will be the pid assigned to it.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackagePropertyPropId(int iPackagePropertyIndex);

Unicode (Windows)
LPWSTR GetPackagePropertyPropId(INT iPackagePropertyIndex);

char* ipworkszip_officedoc_getpackagepropertypropid(void* lpObj, int packagepropertyindex);

QString GetPackagePropertyPropId(int iPackagePropertyIndex);

Default Value

""

Remarks

If this is a custom property, this will be the pid assigned to it.

The PackagePropertyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PackagePropertyCount property.

This property is read-only and not available at design time.

Data Type

String

PackagePropertyPropSet Property (OfficeDoc Class)

If this is a custom property, this will be the GUID of the property set it belongs to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackagePropertyPropSet(int iPackagePropertyIndex);

Unicode (Windows)
LPWSTR GetPackagePropertyPropSet(INT iPackagePropertyIndex);

char* ipworkszip_officedoc_getpackagepropertypropset(void* lpObj, int packagepropertyindex);

QString GetPackagePropertyPropSet(int iPackagePropertyIndex);

Default Value

""

Remarks

If this is a custom property, this will be the GUID of the property set it belongs to.

The PackagePropertyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PackagePropertyCount property.

This property is read-only and not available at design time.

Data Type

String

PackagePropertyValue Property (OfficeDoc Class)

The value of this property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPackagePropertyValue(int iPackagePropertyIndex);

Unicode (Windows)
LPWSTR GetPackagePropertyValue(INT iPackagePropertyIndex);

char* ipworkszip_officedoc_getpackagepropertyvalue(void* lpObj, int packagepropertyindex);

QString GetPackagePropertyValue(int iPackagePropertyIndex);

Default Value

""

Remarks

The value of this property

The PackagePropertyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PackagePropertyCount property.

This property is read-only and not available at design time.

Data Type

String

PartData Property (OfficeDoc Class)

The contents of the currently selected part.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPartData(char* &lpPartData, int &lenPartData);
int SetPartData(const char* lpPartData, int lenPartData);

Unicode (Windows)
INT GetPartData(LPSTR &lpPartData, INT &lenPartData);
INT SetPartData(LPCSTR lpPartData, INT lenPartData);

int ipworkszip_officedoc_getpartdata(void* lpObj, char** lpPartData, int* lenPartData);
int ipworkszip_officedoc_setpartdata(void* lpObj, const char* lpPartData, int lenPartData);

QByteArray GetPartData();
int SetPartData(QByteArray qbaPartData);

Default Value

""

Remarks

This property will hold the contents of the part selected by PartName after calling the ExtractPart method. It can also be set before calling ReplacePart.

Data Type

Binary String

PartName Property (OfficeDoc Class)

The name of the currently selected part.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPartName();
int SetPartName(const char* lpszPartName);

Unicode (Windows)
LPWSTR GetPartName();
INT SetPartName(LPCWSTR lpszPartName);

char* ipworkszip_officedoc_getpartname(void* lpObj);
int ipworkszip_officedoc_setpartname(void* lpObj, const char* lpszPartName);

QString GetPartName();
int SetPartName(QString qsPartName);

Default Value

""

Remarks

This property specifies the name of the currently selected part in the document. If null or empty, no part is currently selected.

Data Type

String

RelationshipCount Property (OfficeDoc Class)

The number of records in the Relationship arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRelationshipCount();

Unicode (Windows)
INT GetRelationshipCount();

int ipworkszip_officedoc_getrelationshipcount(void* lpObj);

int GetRelationshipCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• RelationshipContentType
• RelationshipId
• RelationshipPartName
• RelationshipTypeURI

The array indices start at 0 and end at RelationshipCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

RelationshipContentType Property (OfficeDoc Class)

The content type for the part referenced by this relationship, resolved from [Content_Types].

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRelationshipContentType(int iRelationshipIndex);

Unicode (Windows)
LPWSTR GetRelationshipContentType(INT iRelationshipIndex);

char* ipworkszip_officedoc_getrelationshipcontenttype(void* lpObj, int relationshipindex);

QString GetRelationshipContentType(int iRelationshipIndex);

Default Value

""

Remarks

The content type for the part referenced by this relationship, resolved from [Content_Types].xml according to the Open XML packaging specification rules.

The RelationshipIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RelationshipCount property.

This property is read-only and not available at design time.

Data Type

String

RelationshipId Property (OfficeDoc Class)

The unique ID of this relationship within this .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRelationshipId(int iRelationshipIndex);

Unicode (Windows)
LPWSTR GetRelationshipId(INT iRelationshipIndex);

char* ipworkszip_officedoc_getrelationshipid(void* lpObj, int relationshipindex);

QString GetRelationshipId(int iRelationshipIndex);

Default Value

""

Remarks

The unique ID of this relationship within this .rels file

The RelationshipIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RelationshipCount property.

This property is read-only and not available at design time.

Data Type

String

RelationshipPartName Property (OfficeDoc Class)

The name of the part this relationship entry applies to.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRelationshipPartName(int iRelationshipIndex);

Unicode (Windows)
LPWSTR GetRelationshipPartName(INT iRelationshipIndex);

char* ipworkszip_officedoc_getrelationshippartname(void* lpObj, int relationshipindex);

QString GetRelationshipPartName(int iRelationshipIndex);

Default Value

""

Remarks

The name of the part this relationship entry applies to.

The RelationshipIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RelationshipCount property.

This property is read-only and not available at design time.

Data Type

String

RelationshipTypeURI Property (OfficeDoc Class)

The XML namespace URI that specifies the meaning of this relationship.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetRelationshipTypeURI(int iRelationshipIndex);

Unicode (Windows)
LPWSTR GetRelationshipTypeURI(INT iRelationshipIndex);

char* ipworkszip_officedoc_getrelationshiptypeuri(void* lpObj, int relationshipindex);

QString GetRelationshipTypeURI(int iRelationshipIndex);

Default Value

""

Remarks

The XML namespace URI that specifies the meaning of this relationship.

The RelationshipIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RelationshipCount property.

This property is read-only and not available at design time.

Data Type

String

Validate Property (OfficeDoc Class)

This property controls whether documents are validated during parsing.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetValidate();
int SetValidate(int bValidate);

Unicode (Windows)
BOOL GetValidate();
INT SetValidate(BOOL bValidate);

int ipworkszip_officedoc_getvalidate(void* lpObj);
int ipworkszip_officedoc_setvalidate(void* lpObj, int bValidate);

bool GetValidate();
int SetValidate(bool bValidate);

Default Value

TRUE

Remarks

When true (default) the document will be validated during parsing. To disable validation set Validate to false. Disabling validation may be useful in cases where data can still be parsed even if the document is not well-formed.

Data Type

Boolean

AttrCount Property (OfficeDoc Class)

The number of records in the Attr arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetAttrCount();

Unicode (Windows)
INT GetAttrCount();

int ipworkszip_officedoc_getattrcount(void* lpObj);

int GetAttrCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• AttrName
• AttrNamespace
• AttrPrefix
• AttrValue

The array indices start at 0 and end at AttrCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

AttrName Property (OfficeDoc Class)

The Name provides the local name (without prefix) of the attribute.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttrName(int iAttrIndex);

Unicode (Windows)
LPWSTR GetAttrName(INT iAttrIndex);

char* ipworkszip_officedoc_getattrname(void* lpObj, int attrindex);

QString GetAttrName(int iAttrIndex);

Default Value

""

Remarks

The AttrName provides the local name (without prefix) of the attribute.

The AttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrCount property.

This property is read-only and not available at design time.

Data Type

String

AttrNamespace Property (OfficeDoc Class)

Attribute namespace.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttrNamespace(int iAttrIndex);

Unicode (Windows)
LPWSTR GetAttrNamespace(INT iAttrIndex);

char* ipworkszip_officedoc_getattrnamespace(void* lpObj, int attrindex);

QString GetAttrNamespace(int iAttrIndex);

Default Value

""

Remarks

Attribute namespace.

The AttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrCount property.

This property is read-only and not available at design time.

Data Type

String

AttrPrefix Property (OfficeDoc Class)

Attribute prefix (if any).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttrPrefix(int iAttrIndex);

Unicode (Windows)
LPWSTR GetAttrPrefix(INT iAttrIndex);

char* ipworkszip_officedoc_getattrprefix(void* lpObj, int attrindex);

QString GetAttrPrefix(int iAttrIndex);

Default Value

""

Remarks

Attribute prefix (if any). If the attribute does not have a prefix, this property is empty.

The AttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrCount property.

This property is read-only and not available at design time.

Data Type

String

AttrValue Property (OfficeDoc Class)

Attribute value.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAttrValue(int iAttrIndex);

Unicode (Windows)
LPWSTR GetAttrValue(INT iAttrIndex);

char* ipworkszip_officedoc_getattrvalue(void* lpObj, int attrindex);

QString GetAttrValue(int iAttrIndex);

Default Value

""

Remarks

Attribute value.

The AttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrCount property.

This property is read-only and not available at design time.

Data Type

String

XChildCount Property (OfficeDoc Class)

The number of records in the XChild arrays.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetXChildCount();

Unicode (Windows)
INT GetXChildCount();

int ipworkszip_officedoc_getxchildcount(void* lpObj);

int GetXChildCount();

Default Value

0

Remarks

This property controls the size of the following arrays:

• XChildName
• XChildNamespace
• XChildPrefix
• XChildXText

The array indices start at 0 and end at XChildCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

XChildName Property (OfficeDoc Class)

The Name property provides the local name (without prefix) of the element.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXChildName(int iXChildIndex);

Unicode (Windows)
LPWSTR GetXChildName(INT iXChildIndex);

char* ipworkszip_officedoc_getxchildname(void* lpObj, int xchildindex);

QString GetXChildName(int iXChildIndex);

Default Value

""

Remarks

The XChildName property provides the local name (without prefix) of the element.

The XChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the XChildCount property.

This property is read-only and not available at design time.

Data Type

String

XChildNamespace Property (OfficeDoc Class)

Namespace of the element.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXChildNamespace(int iXChildIndex);

Unicode (Windows)
LPWSTR GetXChildNamespace(INT iXChildIndex);

char* ipworkszip_officedoc_getxchildnamespace(void* lpObj, int xchildindex);

QString GetXChildNamespace(int iXChildIndex);

Default Value

""

Remarks

Namespace of the element.

The XChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the XChildCount property.

This property is read-only and not available at design time.

Data Type

String

XChildPrefix Property (OfficeDoc Class)

Prefix of the element (if any).

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXChildPrefix(int iXChildIndex);

Unicode (Windows)
LPWSTR GetXChildPrefix(INT iXChildIndex);

char* ipworkszip_officedoc_getxchildprefix(void* lpObj, int xchildindex);

QString GetXChildPrefix(int iXChildIndex);

Default Value

""

Remarks

Prefix of the element (if any). If the element does not have a prefix, this property is empty.

The XChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the XChildCount property.

This property is read-only and not available at design time.

Data Type

String

XChildXText Property (OfficeDoc Class)

The inner text of the element.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXChildXText(int iXChildIndex);

Unicode (Windows)
LPWSTR GetXChildXText(INT iXChildIndex);

char* ipworkszip_officedoc_getxchildxtext(void* lpObj, int xchildindex);

QString GetXChildXText(int iXChildIndex);

Default Value

""

Remarks

The inner text of the element.

The XChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the XChildCount property.

This property is read-only and not available at design time.

Data Type

String

XElement Property (OfficeDoc Class)

The name of the current element.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXElement();

Unicode (Windows)
LPWSTR GetXElement();

char* ipworkszip_officedoc_getxelement(void* lpObj);

QString GetXElement();

Default Value

""

Remarks

The current element is specified via the XPath property.

This property is read-only.

Data Type

String

XNamespace Property (OfficeDoc Class)

The namespace of the current element.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXNamespace();

Unicode (Windows)
LPWSTR GetXNamespace();

char* ipworkszip_officedoc_getxnamespace(void* lpObj);

QString GetXNamespace();

Default Value

""

Remarks

The current element is specified via the XPath property.

This property is read-only.

Data Type

String

XParent Property (OfficeDoc Class)

The parent of the current element.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXParent();

Unicode (Windows)
LPWSTR GetXParent();

char* ipworkszip_officedoc_getxparent(void* lpObj);

QString GetXParent();

Default Value

""

Remarks

The current element is specified via the XPath property.

This property is read-only.

Data Type

String

XPath Property (OfficeDoc Class)

Provides a way to point to a specific element in the document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXPath();
int SetXPath(const char* lpszXPath);

Unicode (Windows)
LPWSTR GetXPath();
INT SetXPath(LPCWSTR lpszXPath);

char* ipworkszip_officedoc_getxpath(void* lpObj);
int ipworkszip_officedoc_setxpath(void* lpObj, const char* lpszXPath);

QString GetXPath();
int SetXPath(QString qsXPath);

Default Value

""

Remarks

XPath implements a subset of the XML XPath specification, allowing you to point to specific elements in the XML documents.

The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location.

The following are possible values for an element accessor:

BuildDOM must be set to True prior to parsing the document for the XPath functionality to be available.

Example (Setting XPath):

Data Type

String

XPrefix Property (OfficeDoc Class)

The prefix of the current element.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXPrefix();

Unicode (Windows)
LPWSTR GetXPrefix();

char* ipworkszip_officedoc_getxprefix(void* lpObj);

QString GetXPrefix();

Default Value

""

Remarks

The current element is specified via the XPath property.

This property is read-only.

Data Type

String

XSubTree Property (OfficeDoc Class)

A snapshot of the current element in the document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXSubTree();

Unicode (Windows)
LPWSTR GetXSubTree();

char* ipworkszip_officedoc_getxsubtree(void* lpObj);

QString GetXSubTree();

Default Value

""

Remarks

The current element is specified via the XPath property. In order for this property to work you must have the CacheContent set to true.

This property is read-only.

Data Type

String

XText Property (OfficeDoc Class)

The text of the current element.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetXText();

Unicode (Windows)
LPWSTR GetXText();

char* ipworkszip_officedoc_getxtext(void* lpObj);

QString GetXText();

Default Value

""

Remarks

The current element is specified via the XPath property.

This property is read-only.

Data Type

String

Close Method (OfficeDoc Class)

Closes the Open XML package archive.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Close();

Unicode (Windows)
INT Close();

int ipworkszip_officedoc_close(void* lpObj);

int Close();

Remarks

When this method is called, the class will close the current archive and release all resources.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Config Method (OfficeDoc Class)

Sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworkszip_officedoc_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

ExtractPart Method (OfficeDoc Class)

Reads the contents of the currently selected part.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ExtractPart();

Unicode (Windows)
INT ExtractPart();

int ipworkszip_officedoc_extractpart(void* lpObj);

int ExtractPart();

Remarks

If the part specified by the PartName property exists, the corresponding physical file will be extracted from the archive and will be available through the PartData property.

If the part doesn't exists, or it's stored in interleaved format, an error will be raised.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

FindPartByType Method (OfficeDoc Class)

Looks up a part in the current relationships file by it's type namespace URI.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* FindPartByType(const char* lpszTypeURI);

Unicode (Windows)
LPWSTR FindPartByType(LPCWSTR lpszTypeURI);

char* ipworkszip_officedoc_findpartbytype(void* lpObj, const char* lpszTypeURI);

QString FindPartByType(const QString& qsTypeURI);

Remarks

If a matching part can be found, it's part name is returned. Otherwise, an empty string is returned.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetPropertyValue Method (OfficeDoc Class)

Returns the value of the specified package property.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetPropertyValue(const char* lpszPropName, const char* lpszPropNamespace);

Unicode (Windows)
LPWSTR GetPropertyValue(LPCWSTR lpszPropName, LPCWSTR lpszPropNamespace);

char* ipworkszip_officedoc_getpropertyvalue(void* lpObj, const char* lpszPropName, const char* lpszPropNamespace);

QString GetPropertyValue(const QString& qsPropName, const QString& qsPropNamespace);

Remarks

Looks up a package property named PropName in namespace PropNamespace in the core and app properties tables and returns it's value, if found.

If the property doesn't exists, an empty string is returned.

For custom properties. use an empty string ("") as the value of the PropNamespace parameter.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

ListParts Method (OfficeDoc Class)

List all the parts contained in the document and their relationships.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListParts();

Unicode (Windows)
INT ListParts();

int ipworkszip_officedoc_listparts(void* lpObj);

int ListParts();

Remarks

When this method is called, the class will read all the relationships in the document, recursively, and populate the Relationships collection.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Open Method (OfficeDoc Class)

Opens the Open XML package archive.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Open();

Unicode (Windows)
INT Open();

int ipworkszip_officedoc_open(void* lpObj);

int Open();

Remarks

When this method is called, the class will attempt to open the archive specified in PackagePath and extract package properties, content types and parse the master relationships file in the archive.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ParsePart Method (OfficeDoc Class)

Parses the specified part as XML.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ParsePart();

Unicode (Windows)
INT ParsePart();

int ipworkszip_officedoc_parsepart(void* lpObj);

int ParsePart();

Remarks

If the part specified by PartName exists, the corresponding physical file will be extracted from the archive and parsed as XML. If BuildDOM is enabled, the DOM will be built internally and you can use XPath to query the resulting document, using the XPath property. If BuildDOM is disabled, only the XML parser-related events will be fired.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ReadRelationships Method (OfficeDoc Class)

Reads the relationships file in the archive associated with the specified part.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ReadRelationships();

Unicode (Windows)
INT ReadRelationships();

int ipworkszip_officedoc_readrelationships(void* lpObj);

int ReadRelationships();

Remarks

When this method is called, the class will look for a .rels file associated with the part specified by the PartName property. If found, the Relationships collection will now expose the contents of the relationships for that part.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ReplacePart Method (OfficeDoc Class)

Replaces the contents of the specified part in the package.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ReplacePart();

Unicode (Windows)
INT ReplacePart();

int ipworkszip_officedoc_replacepart(void* lpObj);

int ReplacePart();

Remarks

If the part specified by the PartName property exists, the corresponding physical file will be replaced with the contents of the PartData property. The package file will be modified in place right away.

If the part doesn't exists, it's stored in interleaved format, or PartData is null or empty, an error will be raised.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (OfficeDoc Class)

Resets the class.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworkszip_officedoc_reset(void* lpObj);

int Reset();

Remarks

Reset resets the state of the class. All properties will be set to their default values, and any files open will be closed.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ResolveContentType Method (OfficeDoc Class)

Returns the content type of the specified part.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* ResolveContentType();

Unicode (Windows)
LPWSTR ResolveContentType();

char* ipworkszip_officedoc_resolvecontenttype(void* lpObj);

QString ResolveContentType();

Remarks

Applies the content type resolution rules specified in the Open XML packaging specification and returns the content type associated with PartName in the archive.

If there's no content type mapped for the part or for the extension, an empty string is returned.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

BeginFile Event (OfficeDoc Class)

Fired before each file is processed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireBeginFile(OfficeDocBeginFileEventParams *e);

typedef struct {
  int Index;
  int Skip;
  int reserved;
} OfficeDocBeginFileEventParams;


Unicode (Windows)
virtual INT FireBeginFile(OfficeDocBeginFileEventParams *e);

typedef struct {
  INT Index;
  BOOL Skip;
  INT reserved;
} OfficeDocBeginFileEventParams;

#define EID_OFFICEDOC_BEGINFILE 1

virtual INT IPWORKSZIP_CALL FireBeginFile(INT &iIndex, BOOL &bSkip);

class OfficeDocBeginFileEventParams {
public:
  int Index();

  bool Skip();
  void SetSkip(bool bSkip);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void BeginFile(OfficeDocBeginFileEventParams *e);

// Or, subclass OfficeDoc and override this emitter function.
virtual int FireBeginFile(OfficeDocBeginFileEventParams *e) {...}

Remarks

BeginFile is fired before each file is processed by the compressor or decompressor, as appropriate. Index contains the array index of the file about to be processed, and the FileCompressedName, FileDecompressedName, FileCompressedSize (decompression only), and FileDecompressedSize fields of the Files collection for this index contain more detailed information about the file about to be processed.

When extracting, an alternate location may be specified by trapping the event, and modifying FileDecompressedName and/or ExtractToPath. If FileDecompressedName is set to an empty string, the file will not be written to disk. If WriteToProgressEvent is true, the file will still be decompressed, and the data may be extracted through the Progress event.

This event may also be trapped while compressing. FileCompressedName and FileDecompressedName may be changed.

You may set the Skip parameter to true in order to skip the file completely while compressing or extracting.

Characters Event (OfficeDoc Class)

Fired for plain text segments of the input stream.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireCharacters(OfficeDocCharactersEventParams *e);

typedef struct {
  const char *Text;
  int reserved;
} OfficeDocCharactersEventParams;


Unicode (Windows)
virtual INT FireCharacters(OfficeDocCharactersEventParams *e);

typedef struct {
  LPCWSTR Text;
  INT reserved;
} OfficeDocCharactersEventParams;

#define EID_OFFICEDOC_CHARACTERS 2

virtual INT IPWORKSZIP_CALL FireCharacters(LPSTR &lpszText);

class OfficeDocCharactersEventParams {
public:
  const QString &Text();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Characters(OfficeDocCharactersEventParams *e);

// Or, subclass OfficeDoc and override this emitter function.
virtual int FireCharacters(OfficeDocCharactersEventParams *e) {...}

Remarks

The Characters event provides the plain text content of the XML document (i.e. the text inside the tags). The text is provided through the Text parameter.

The text includes white space as well as end of line characters, except for ignorable whitespace which is fired through the IgnorableWhitespace event.

Comment Event (OfficeDoc Class)

Fired when a comment section is encountered.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireComment(OfficeDocCommentEventParams *e);

typedef struct {
  const char *Text;
  int reserved;
} OfficeDocCommentEventParams;


Unicode (Windows)
virtual INT FireComment(OfficeDocCommentEventParams *e);

typedef struct {
  LPCWSTR Text;
  INT reserved;
} OfficeDocCommentEventParams;

#define EID_OFFICEDOC_COMMENT 3

virtual INT IPWORKSZIP_CALL FireComment(LPSTR &lpszText);

class OfficeDocCommentEventParams {
public:
  const QString &Text();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Comment(OfficeDocCommentEventParams *e);

// Or, subclass OfficeDoc and override this emitter function.
virtual int FireComment(OfficeDocCommentEventParams *e) {...}

Remarks

The Comment event is fired whenever a comment section (<!-- ..text... -->) is found in the document.

The full text of the comment is provided by the Text parameter.

EndElement Event (OfficeDoc Class)

Fired when an end-element tag is encountered.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireEndElement(OfficeDocEndElementEventParams *e);

typedef struct {
  const char *Namespace;
  const char *Element;
  const char *QName;
  int IsEmpty;
  int reserved;
} OfficeDocEndElementEventParams;


Unicode (Windows)
virtual INT FireEndElement(OfficeDocEndElementEventParams *e);

typedef struct {
  LPCWSTR Namespace;
  LPCWSTR Element;
  LPCWSTR QName;
  BOOL IsEmpty;
  INT reserved;
} OfficeDocEndElementEventParams;

#define EID_OFFICEDOC_ENDELEMENT 4

virtual INT IPWORKSZIP_CALL FireEndElement(LPSTR &lpszNamespace, LPSTR &lpszElement, LPSTR &lpszQName, BOOL &bIsEmpty);

class OfficeDocEndElementEventParams {
public:
  const QString &Namespace();

  const QString &Element();

  const QString &QName();

  bool IsEmpty();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void EndElement(OfficeDocEndElementEventParams *e);

// Or, subclass OfficeDoc and override this emitter function.
virtual int FireEndElement(OfficeDocEndElementEventParams *e) {...}

Remarks

The EndElement event is fired when an end-element tag is found in the document.

The element name is provided by the Element parameter.

The IsEmpty parameter is true when the event corresponds with an empty element declaration.

EndFile Event (OfficeDoc Class)

Fired after each file is processed.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireEndFile(OfficeDocEndFileEventParams *e);

typedef struct {
  int Index;
  int reserved;
} OfficeDocEndFileEventParams;


Unicode (Windows)
virtual INT FireEndFile(OfficeDocEndFileEventParams *e);

typedef struct {
  INT Index;
  INT reserved;
} OfficeDocEndFileEventParams;

#define EID_OFFICEDOC_ENDFILE 5

virtual INT IPWORKSZIP_CALL FireEndFile(INT &iIndex);

class OfficeDocEndFileEventParams {
public:
  int Index();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void EndFile(OfficeDocEndFileEventParams *e);

// Or, subclass OfficeDoc and override this emitter function.
virtual int FireEndFile(OfficeDocEndFileEventParams *e) {...}

Remarks

EndFile is fired after each file is processed by the compressor or decompressor, as appropriate. Index contains the array index of the file processed, and the FileCompressedName, FileDecompressedName, FileCompressedSize, and FileDecompressedSize fields in the Files collection for this index contain more detailed information about the file processed.

EndPrefixMapping Event (OfficeDoc Class)

Fired when leaving the scope of a namespace declaration.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireEndPrefixMapping(OfficeDocEndPrefixMappingEventParams *e);

typedef struct {
  const char *Prefix;
  int reserved;
} OfficeDocEndPrefixMappingEventParams;


Unicode (Windows)
virtual INT FireEndPrefixMapping(OfficeDocEndPrefixMappingEventParams *e);

typedef struct {
  LPCWSTR Prefix;
  INT reserved;
} OfficeDocEndPrefixMappingEventParams;

#define EID_OFFICEDOC_ENDPREFIXMAPPING 6

virtual INT IPWORKSZIP_CALL FireEndPrefixMapping(LPSTR &lpszPrefix);

class OfficeDocEndPrefixMappingEventParams {
public:
  const QString &Prefix();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void EndPrefixMapping(OfficeDocEndPrefixMappingEventParams *e);

// Or, subclass OfficeDoc and override this emitter function.
virtual int FireEndPrefixMapping(OfficeDocEndPrefixMappingEventParams *e) {...}

Remarks

The StartPrefixMapping event is fired when entering the scope of a namespace declaration.

Error Event (OfficeDoc Class)

Information about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(OfficeDocErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} OfficeDocErrorEventParams;


Unicode (Windows)
virtual INT FireError(OfficeDocErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} OfficeDocErrorEventParams;

#define EID_OFFICEDOC_ERROR 7

virtual INT IPWORKSZIP_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class OfficeDocErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(OfficeDocErrorEventParams *e);

// Or, subclass OfficeDoc and override this emitter function.
virtual int FireError(OfficeDocErrorEventParams *e) {...}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

EvalEntity Event (OfficeDoc Class)

Fired every time an entity needs to be evaluated.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireEvalEntity(OfficeDocEvalEntityEventParams *e);

typedef struct {
  const char *Entity;
  char *Value;
  int reserved;
} OfficeDocEvalEntityEventParams;


Unicode (Windows)
virtual INT FireEvalEntity(OfficeDocEvalEntityEventParams *e);

typedef struct {
  LPCWSTR Entity;
  LPWSTR Value;
  INT reserved;
} OfficeDocEvalEntityEventParams;

#define EID_OFFICEDOC_EVALENTITY 8

virtual INT IPWORKSZIP_CALL FireEvalEntity(LPSTR &lpszEntity, LPSTR &lpszValue);

class OfficeDocEvalEntityEventParams {
public:
  const QString &Entity();

  const QString &Value();
  void SetValue(const QString &qsValue);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void EvalEntity(OfficeDocEvalEntityEventParams *e);

// Or, subclass OfficeDoc and override this emitter function.
virtual int FireEvalEntity(OfficeDocEvalEntityEventParams *e) {...}

Remarks

The Value parameter contains a suggested value for the entity (normally the entity name itself). You may set Value to a value of your choice, which will be later passed into the text stream.

IgnorableWhitespace Event (OfficeDoc Class)

Fired when a section of ignorable whitespace is encountered.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireIgnorableWhitespace(OfficeDocIgnorableWhitespaceEventParams *e);

typedef struct {
  const char *Text;
  int reserved;
} OfficeDocIgnorableWhitespaceEventParams;


Unicode (Windows)
virtual INT FireIgnorableWhitespace(OfficeDocIgnorableWhitespaceEventParams *e);

typedef struct {
  LPCWSTR Text;
  INT reserved;
} OfficeDocIgnorableWhitespaceEventParams;

#define EID_OFFICEDOC_IGNORABLEWHITESPACE 9

virtual INT IPWORKSZIP_CALL FireIgnorableWhitespace(LPSTR &lpszText);

class OfficeDocIgnorableWhitespaceEventParams {
public:
  const QString &Text();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void IgnorableWhitespace(OfficeDocIgnorableWhitespaceEventParams *e);

// Or, subclass OfficeDoc and override this emitter function.
virtual int FireIgnorableWhitespace(OfficeDocIgnorableWhitespaceEventParams *e) {...}

Remarks

The ignorable whitespace section is provided by the Text parameter.

Meta Event (OfficeDoc Class)

Fired when a meta section is encountered.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireMeta(OfficeDocMetaEventParams *e);

typedef struct {
  const char *Text;
  int reserved;
} OfficeDocMetaEventParams;


Unicode (Windows)
virtual INT FireMeta(OfficeDocMetaEventParams *e);

typedef struct {
  LPCWSTR Text;
  INT reserved;
} OfficeDocMetaEventParams;

#define EID_OFFICEDOC_META 10

virtual INT IPWORKSZIP_CALL FireMeta(LPSTR &lpszText);

class OfficeDocMetaEventParams {
public:
  const QString &Text();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Meta(OfficeDocMetaEventParams *e);

// Or, subclass OfficeDoc and override this emitter function.
virtual int FireMeta(OfficeDocMetaEventParams *e) {...}

Remarks

The Meta event is fired whenever a meta information section (<! ..text... >) is found in the document.

The full text of the meta section is provided by the Text parameter.

Overwrite Event (OfficeDoc Class)

Fired whenever a file exists and may be overwritten.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireOverwrite(OfficeDocOverwriteEventParams *e);

typedef struct {
  char *Filename;
  int Overwrite;
  int reserved;
} OfficeDocOverwriteEventParams;


Unicode (Windows)
virtual INT FireOverwrite(OfficeDocOverwriteEventParams *e);

typedef struct {
  LPWSTR Filename;
  BOOL Overwrite;
  INT reserved;
} OfficeDocOverwriteEventParams;

#define EID_OFFICEDOC_OVERWRITE 11

virtual INT IPWORKSZIP_CALL FireOverwrite(LPSTR &lpszFilename, BOOL &bOverwrite);

class OfficeDocOverwriteEventParams {
public:
  const QString &Filename();
  void SetFilename(const QString &qsFilename);

  bool Overwrite();
  void SetOverwrite(bool bOverwrite);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Overwrite(OfficeDocOverwriteEventParams *e);

// Or, subclass OfficeDoc and override this emitter function.
virtual int FireOverwrite(OfficeDocOverwriteEventParams *e) {...}

Remarks

Overwrite is fired when a file is about to be overwritten, and would overwrite an existing file. The event is fired during decompression.

Filename contains the full name of the file, specified with its pathname.

Overwrite specifies whether or not the file will be overwritten. For Zip, Jar, and Tar, this is equal by default to the value of the OverwriteFiles property. For Gzip, this value defaults to true.

Either of the parameters may be changed when the event is fired. Changing the value of Overwrite will override the default behavior of the class, and cause the file to be overwritten or not overwritten, depending on the value set. If Filename is changed, the value of Overwrite will be ignored, and the file will be written with the specified name. If a file of the new name also exists this file will be silently overwritten.

PI Event (OfficeDoc Class)

Fired when a processing instruction section is encountered.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FirePI(OfficeDocPIEventParams *e);

typedef struct {
  const char *Text;
  int reserved;
} OfficeDocPIEventParams;


Unicode (Windows)
virtual INT FirePI(OfficeDocPIEventParams *e);

typedef struct {
  LPCWSTR Text;
  INT reserved;
} OfficeDocPIEventParams;

#define EID_OFFICEDOC_PI 12

virtual INT IPWORKSZIP_CALL FirePI(LPSTR &lpszText);

class OfficeDocPIEventParams {
public:
  const QString &Text();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void PI(OfficeDocPIEventParams *e);

// Or, subclass OfficeDoc and override this emitter function.
virtual int FirePI(OfficeDocPIEventParams *e) {...}

Remarks

The PI event is fired whenever a processing instruction section (<? ..text... ?>) is found in the document.

The full text of the processing instruction is provided by the Text parameter.

Progress Event (OfficeDoc Class)

Fired as progress is made.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireProgress(OfficeDocProgressEventParams *e);

typedef struct {
  const char *Data;
  int lenData;
  const char *Filename;
  int64 BytesProcessed;
  int PercentProcessed;
  int reserved;
} OfficeDocProgressEventParams;


Unicode (Windows)
virtual INT FireProgress(OfficeDocProgressEventParams *e);

typedef struct {
  LPCSTR Data;
  INT lenData;
  LPCWSTR Filename;
  LONG64 BytesProcessed;
  INT PercentProcessed;
  INT reserved;
} OfficeDocProgressEventParams;

#define EID_OFFICEDOC_PROGRESS 13

virtual INT IPWORKSZIP_CALL FireProgress(LPSTR &lpData, INT &lenData, LPSTR &lpszFilename, LONG64 &lBytesProcessed, INT &iPercentProcessed);

class OfficeDocProgressEventParams {
public:
  const QByteArray &Data();

  const QString &Filename();

  qint64 BytesProcessed();

  int PercentProcessed();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Progress(OfficeDocProgressEventParams *e);

// Or, subclass OfficeDoc and override this emitter function.
virtual int FireProgress(OfficeDocProgressEventParams *e) {...}

Remarks

The Progress event is automatically fired as compression or decompression is performed. When WriteToProgressEvent is true, the output data is provided through the Data parameter, allowing for it to be streamed out.

Filename contains the name of the file being written. If no file is being written, Filename will contain an empty string, and the output data will be provided exclusively through this event.

BytesProcessed contains the total number of uncompressed bytes processed. PercentProcessed contains the percent of uncompressed bytes processed, corresponding roughly to the running time of the operation.

For Gzip extraction only, BytesProcessed and PercentProcessed will reflect the number of compressed bytes extracted, as it is generally impossible to predetermine the total uncompressed size.

If WriteToProgressEvent is false, Data will contain null.

SpecialSection Event (OfficeDoc Class)

Fired when a special section is encountered.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireSpecialSection(OfficeDocSpecialSectionEventParams *e);

typedef struct {
  const char *SectionId;
  const char *Text;
  int reserved;
} OfficeDocSpecialSectionEventParams;


Unicode (Windows)
virtual INT FireSpecialSection(OfficeDocSpecialSectionEventParams *e);

typedef struct {
  LPCWSTR SectionId;
  LPCWSTR Text;
  INT reserved;
} OfficeDocSpecialSectionEventParams;

#define EID_OFFICEDOC_SPECIALSECTION 14

virtual INT IPWORKSZIP_CALL FireSpecialSection(LPSTR &lpszSectionId, LPSTR &lpszText);

class OfficeDocSpecialSectionEventParams {
public:
  const QString &SectionId();

  const QString &Text();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void SpecialSection(OfficeDocSpecialSectionEventParams *e);

// Or, subclass OfficeDoc and override this emitter function.
virtual int FireSpecialSection(OfficeDocSpecialSectionEventParams *e) {...}

Remarks

The SpecialSection event is fired whenever a special section (such as <![ CDATA [ ..text... ]]>) is found in the document.

The full text of the special section is provided by the Text parameter, while the SectionId parameter provides the section identifier (e.g. "CDATA").

StartElement Event (OfficeDoc Class)

Fired when a begin-element tag is encountered in the document.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStartElement(OfficeDocStartElementEventParams *e);

typedef struct {
  const char *Namespace;
  const char *Element;
  const char *QName;
  int IsEmpty;
  int reserved;
} OfficeDocStartElementEventParams;


Unicode (Windows)
virtual INT FireStartElement(OfficeDocStartElementEventParams *e);

typedef struct {
  LPCWSTR Namespace;
  LPCWSTR Element;
  LPCWSTR QName;
  BOOL IsEmpty;
  INT reserved;
} OfficeDocStartElementEventParams;

#define EID_OFFICEDOC_STARTELEMENT 15

virtual INT IPWORKSZIP_CALL FireStartElement(LPSTR &lpszNamespace, LPSTR &lpszElement, LPSTR &lpszQName, BOOL &bIsEmpty);

class OfficeDocStartElementEventParams {
public:
  const QString &Namespace();

  const QString &Element();

  const QString &QName();

  bool IsEmpty();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void StartElement(OfficeDocStartElementEventParams *e);

// Or, subclass OfficeDoc and override this emitter function.
virtual int FireStartElement(OfficeDocStartElementEventParams *e) {...}

Remarks

The StartElement event is fired when a begin-element tag is found in the document.

The element name is provided through the Element parameter. The attribute names and values (if any) are provided through the AttrName, AttrNamespace, AttrPrefix, and AttrValue properties.

The IsEmpty parameter is true when the event corresponds with an empty element declaration.

StartPrefixMapping Event (OfficeDoc Class)

Fired when entering the scope of a namespace declaration.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireStartPrefixMapping(OfficeDocStartPrefixMappingEventParams *e);

typedef struct {
  const char *Prefix;
  const char *URI;
  int reserved;
} OfficeDocStartPrefixMappingEventParams;


Unicode (Windows)
virtual INT FireStartPrefixMapping(OfficeDocStartPrefixMappingEventParams *e);

typedef struct {
  LPCWSTR Prefix;
  LPCWSTR URI;
  INT reserved;
} OfficeDocStartPrefixMappingEventParams;

#define EID_OFFICEDOC_STARTPREFIXMAPPING 16

virtual INT IPWORKSZIP_CALL FireStartPrefixMapping(LPSTR &lpszPrefix, LPSTR &lpszURI);

class OfficeDocStartPrefixMappingEventParams {
public:
  const QString &Prefix();

  const QString &URI();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void StartPrefixMapping(OfficeDocStartPrefixMappingEventParams *e);

// Or, subclass OfficeDoc and override this emitter function.
virtual int FireStartPrefixMapping(OfficeDocStartPrefixMappingEventParams *e) {...}

Remarks

The EndPrefixMapping event is fired when leaving the scope of a namespace declaration.

Config Settings (OfficeDoc Class)

OfficeDoc Config Settings

Base Config Settings

Trappable Errors (OfficeDoc Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

The following errors may be generated by the class. Note that frequently the error message will contain more specific information than what is listed here.

Note that some non-fatal errors may be trapped and explicitly ignored in the Error event. This will allow the class to continue operation even in case of error.

OfficeDoc Errors