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
IPWorksZipOfficeDoc
IPWorksZipOfficeDocSwift
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:(int)contentTypeIndex | Specifies if this is a default content type or an override. |
| - contentTypeMediaType:(int)contentTypeIndex | The media type for this entry, as defined by RFC2616. |
| - contentTypeTarget:(int)contentTypeIndex | 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:(int)namespaceIndex | The Prefix for the Namespace . |
| - namespaceURI:(int)namespaceIndex | 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:(int)packagePropertyIndex | The data type associated with this property, if the information is available. |
| - packagePropertyName:(int)packagePropertyIndex | The name of this property. |
| - packagePropertyNamespace:(int)packagePropertyIndex | The XML Namespace URI associated with this property. |
| - packagePropertyPropId:(int)packagePropertyIndex | If this is a custom property, this will be the pid assigned to it. |
| - packagePropertyPropSet:(int)packagePropertyIndex | If this is a custom property, this will be the GUID of the property set it belongs to. |
| - packagePropertyValue:(int)packagePropertyIndex | 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:(int)relationshipIndex | The content type for the part referenced by this relationship, resolved from [Content_Types]. |
| - relationshipId:(int)relationshipIndex | The unique ID of this relationship within this . |
| - relationshipPartName:(int)relationshipIndex | The name of the part this relationship entry applies to. |
| - relationshipTypeURI:(int)relationshipIndex | 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:(int)attrIndex | The Name provides the local name (without prefix) of the attribute. |
| - attrNamespace:(int)attrIndex | Attribute namespace. |
| - attrPrefix:(int)attrIndex | Attribute prefix (if any). |
| - attrValue:(int)attrIndex | Attribute value. |
| - XChildCount | The number of records in the XChild arrays. |
| - XChildName:(int)xChildIndex | The Name property provides the local name (without prefix) of the element. |
| - XChildNamespace:(int)xChildIndex | Namespace of the element. |
| - XChildPrefix:(int)xChildIndex | Prefix of the element (if any). |
| - XChildXText:(int)xChildIndex | 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.
| - onBeginFile | Fired before each file is processed. |
| - onCharacters | Fired for plain text segments of the input stream. |
| - onComment | Fired when a comment section is encountered. |
| - onEndElement | Fired when an end-element tag is encountered. |
| - onEndFile | Fired after each file is processed. |
| - onEndPrefixMapping | Fired when leaving the scope of a namespace declaration. |
| - onError | Information about errors during data delivery. |
| - onEvalEntity | Fired every time an entity needs to be evaluated. |
| - onIgnorableWhitespace | Fired when a section of ignorable whitespace is encountered. |
| - onMeta | Fired when a meta section is encountered. |
| - onOverwrite | Fired whenever a file exists and may be overwritten. |
| - onPI | Fired when a processing instruction section is encountered. |
| - onProgress | Fired as progress is made. |
| - onSpecialSection | Fired when a special section is encountered. |
| - onStartElement | Fired when a begin-element tag is encountered in the document. |
| - onStartPrefixMapping | 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. |
| ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
| SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
| UseInternalSecurityAPI | Tells the class whether or not to use the system security libraries or an internal implementation. |