OfficeDoc Class
Properties Methods Events Configuration Settings Errors
The OfficeDoc class implements support for the Open XML Packaging Format used in Office 2007 documents.
Class Name
IPWorksZip_OfficeDoc
Procedural Interface
ipworkszip_officedoc_open(); ipworkszip_officedoc_close($res); ipworkszip_officedoc_register_callback($res, $id, $function); ipworkszip_officedoc_get_last_error($res); ipworkszip_officedoc_get_last_error_code($res); ipworkszip_officedoc_set($res, $id, $index, $value); ipworkszip_officedoc_get($res, $id, $index); ipworkszip_officedoc_do_close($res); ipworkszip_officedoc_do_config($res, $configurationstring); ipworkszip_officedoc_do_extractpart($res); ipworkszip_officedoc_do_findpartbytype($res, $typeuri); ipworkszip_officedoc_do_getpropertyvalue($res, $propname, $propnamespace); ipworkszip_officedoc_do_listparts($res); ipworkszip_officedoc_do_open($res); ipworkszip_officedoc_do_parsepart($res); ipworkszip_officedoc_do_readrelationships($res); ipworkszip_officedoc_do_replacepart($res); ipworkszip_officedoc_do_reset($res); ipworkszip_officedoc_do_resolvecontenttype($res);
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. |
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. |