OfficeDoc Class
Properties Methods Events Configuration 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.
ContentTypeCount | The number of records in the ContentType arrays. |
ContentTypeIsOverride | Specifies if this is a default content type or an override. |
ContentTypeMediaType | The media type for this entry, as defined by RFC2616. |
ContentTypeTarget | If it's a default content type, this will be the file extension it applies to. |
NamespaceCount | The number of records in the Namespace arrays. |
NamespacePrefix | The Prefix for the Namespace . |
NamespaceURI | Namespace URI associated with the corresponding Prefix . |
PackagePath | The path to the Open XML package file. |
PackagePropertyCount | The number of records in the PackageProperty arrays. |
PackagePropertyDataType | The data type associated with this property, if the information is available. |
PackagePropertyName | The name of this property. |
PackagePropertyNamespace | The XML Namespace URI associated with this property. |
PackagePropertyPropId | If this is a custom property, this will be the pid assigned to it. |
PackagePropertyPropSet | If this is a custom property, this will be the GUID of the property set it belongs to. |
PackagePropertyValue | The value of this property. |
PartData | The contents of the currently selected part. |
PartName | The name of the currently selected part. |
RelationshipCount | The number of records in the Relationship arrays. |
RelationshipContentType | The content type for the part referenced by this relationship, resolved from [Content_Types]. |
RelationshipId | The unique ID of this relationship within this . |
RelationshipPartName | The name of the part this relationship entry applies to. |
RelationshipTypeURI | The XML namespace URI that specifies the meaning of this relationship. |
Validate | When True, the parser checks that the document consists of well-formed XML. |
AttrCount | The number of records in the Attr arrays. |
AttrName | The Name provides the local name (without prefix) of the attribute. |
AttrNamespace | Attribute namespace. |
AttrPrefix | Attribute prefix (if any). |
AttrValue | Attribute value. |
XChildCount | The number of records in the XChild arrays. |
XChildName | The Name property provides the local name (without prefix) of the element. |
XChildNamespace | Namespace of the element. |
XChildPrefix | Prefix of the element (if any). |
XChildXText | The inner text of the element. |
XElement | The name of the current element. |
XNamespace | The namespace of the current element. |
XParent | The parent of the current element. |
XPath | Provides a way to point to a specific element in the document. |
XPrefix | The prefix of the current element. |
XSubTree | A snapshot of the current element in the document. |
XText | The text of the current element. |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
Close | Closes the Open XML package archive. |
Config | Sets or retrieves a configuration setting. |
ExtractPart | Reads the contents of the currently selected part. |
FindPartByType | Looks up a part in the current relationships file by it's type namespace URI. |
GetPropertyValue | Returns the value of the specified package property. |
ListParts | List all the parts contained in the document and their relationships. |
Open | Opens the Open XML package archive. |
ParsePart | Parses the specified part as XML. |
ReadRelationships | Reads the relationships file in the archive associated with the specified part. |
ReplacePart | Replaces the contents of the specified part in the package. |
Reset | Resets the class. |
ResolveContentType | Returns the content type of the specified part. |
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.
BeginFile | Fired before each file is processed. |
Characters | Fired for plain text segments of the input stream. |
Comment | Fired when a comment section is encountered. |
EndElement | Fired when an end-element tag is encountered. |
EndFile | Fired after each file is processed. |
EndPrefixMapping | Fired when leaving the scope of a namespace declaration. |
Error | Information about errors during data delivery. |
EvalEntity | Fired every time an entity needs to be evaluated. |
IgnorableWhitespace | Fired when a section of ignorable whitespace is encountered. |
Meta | Fired when a meta section is encountered. |
Overwrite | Fired whenever a file exists and may be overwritten. |
PI | Fired when a processing instruction section is encountered. |
Progress | Fired as progress is made. |
SpecialSection | Fired when a special section is encountered. |
StartElement | Fired when a begin-element tag is encountered in the document. |
StartPrefixMapping | Fired when entering the scope of a namespace declaration. |
Configuration Settings
The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.
NormalizePartName | Whether to normalize Part Names. |
RelationshipIsExternal[x] | Whether the relationship part is internal or external. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |
ContentTypeCount Property (OfficeDoc Class)
The number of records in the ContentType arrays.
Syntax
int GetContentTypeCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
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
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
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
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
int GetNamespaceCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
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
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
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
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
int GetPackagePropertyCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
- PackagePropertyDataType
- PackagePropertyName
- PackagePropertyNamespace
- PackagePropertyPropId
- PackagePropertyPropSet
- PackagePropertyValue
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
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
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
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
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
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
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
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
Byte Array
PartName Property (OfficeDoc Class)
The name of the currently selected part.
Syntax
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
int GetRelationshipCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
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
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
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
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
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)
When True, the parser checks that the document consists of well-formed XML.
Syntax
bool GetValidate();
int SetValidate(bool bValidate);
Default Value
true
Remarks
You can set Validate to False when you want to ignore XML format rules (e.g. while parsing HTML files).
Data Type
Boolean
AttrCount Property (OfficeDoc Class)
The number of records in the Attr arrays.
Syntax
int GetAttrCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
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
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
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
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
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
int GetXChildCount();
Default Value
0
Remarks
This property controls the size of the following arrays:
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
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
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
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
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
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
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
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
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:
'name' | A particular element name |
name[i] | The i-th subelement of the current element with the given name |
[i] | The i-th subelement of the current element |
[last()] | The last subelement of the current element |
[last()-i] | The subelement located at the last location minus i in the current element |
name[@attrname="attrvalue"] | The subelement containing a particular value for a given attribute (supports single AND double quotes) |
.. | The parent of the current element |
BuildDOM must be set to True prior to parsing the document for the XPath functionality to be available.
Example (Setting XPath):
Document root | XML.XPath = "/" |
Specific Element | XML.XPath = "/root/SubElement1/SubElement2/" |
i-th Child | XML.XPath = "/root/SubElement1[i]" |
Data Type
String
XPrefix Property (OfficeDoc Class)
The prefix of the current element.
Syntax
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
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
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
int Close();
Remarks
When this method is called, the class will close the current archive and release all resources.
Error Handling
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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 the appropriate value of 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
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
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
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
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
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
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.
ErrorCode contains an error code and Description 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
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
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
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
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
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
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
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
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
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.
Configuration Settings (OfficeDoc Class)
The class accepts one or more of the following configuration settings. Configuration 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.OfficeDoc Configuration Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
NormalizePartName:
Whether to normalize Part Names.Sometimes the Part Names retrieved
from a document will be of a format that is not directly usable in the PartName
property when retrieving the part. For example:
/ppt/slides/../media/image1.jpeg
When this option is set to True the component will automatically normalize
these Part Names so that they can be directly used in the PartName property
for retrieving the part. For example, the above would become:
The default is True. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
RelationshipIsExternal[x]: Whether the relationship part is internal or external.Some relationships in an Office document may be external items, such as URLs and files on disk. These relationships are not directly accessible via ExtractPart. This configuration option will return "1" if the relationship at index "x" of the Relationship* arrays is an external part. Otherwise it will return "0" | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Base Configuration Settings | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
BuildInfo: Information about the product's build.When queried, this setting will return a string containing information about the product's build. | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
CodePage:
The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).
The following is a list of valid code page identifiers:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
LicenseInfo:
Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
UseInternalSecurityAPI: Tells the class whether or not to use the system security libraries or an internal implementation. By default the class will use the system security libraries to perform cryptographic functions where applicable. Setting this to true tells the class to use the internal implementation instead of using the system's security API. |
Trappable Errors (OfficeDoc Class)
ErrorsThe 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
268 The specified part name could not be found on the package, or the part is stored in interleaved format. |