Docs

IPWorks ZIP 2022 PHP Edition

Version 22.0 [Build 8203]

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.

ContentTypeCountThe number of records in the ContentType arrays.
ContentTypeIsOverrideSpecifies if this is a default content type or an override.
ContentTypeMediaTypeThe media type for this entry, as defined by RFC2616.
ContentTypeTargetIf it's a default content type, this will be the file extension it applies to.
NamespaceCountThe number of records in the Namespace arrays.
NamespacePrefixThe Prefix for the Namespace .
NamespaceURINamespace URI associated with the corresponding Prefix .
PackagePathThe path to the Open XML package file.
PackagePropertyCountThe number of records in the PackageProperty arrays.
PackagePropertyDataTypeThe data type associated with this property, if the information is available.
PackagePropertyNameThe name of this property.
PackagePropertyNamespaceThe XML Namespace URI associated with this property.
PackagePropertyPropIdIf this is a custom property, this will be the pid assigned to it.
PackagePropertyPropSetIf this is a custom property, this will be the GUID of the property set it belongs to.
PackagePropertyValueThe value of this property.
PartDataThe contents of the currently selected part.
PartNameThe name of the currently selected part.
RelationshipCountThe number of records in the Relationship arrays.
RelationshipContentTypeThe content type for the part referenced by this relationship, resolved from [Content_Types].
RelationshipIdThe unique ID of this relationship within this .
RelationshipPartNameThe name of the part this relationship entry applies to.
RelationshipTypeURIThe XML namespace URI that specifies the meaning of this relationship.
ValidateWhen True, the parser checks that the document consists of well-formed XML.
AttrCountThe number of records in the Attr arrays.
AttrNameThe Name provides the local name (without prefix) of the attribute.
AttrNamespaceAttribute namespace.
AttrPrefixAttribute prefix (if any).
AttrValueAttribute value.
XChildCountThe number of records in the XChild arrays.
XChildNameThe Name property provides the local name (without prefix) of the element.
XChildNamespaceNamespace of the element.
XChildPrefixPrefix of the element (if any).
XChildXTextThe inner text of the element.
XElementThe name of the current element.
XNamespaceThe namespace of the current element.
XParentThe parent of the current element.
XPathProvides a way to point to a specific element in the document.
XPrefixThe prefix of the current element.
XSubTreeA snapshot of the current element in the document.
XTextThe 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.

CloseCloses the Open XML package archive.
ConfigSets or retrieves a configuration setting.
ExtractPartReads the contents of the currently selected part.
FindPartByTypeLooks up a part in the current relationships file by it's type namespace URI.
GetPropertyValueReturns the value of the specified package property.
ListPartsList all the parts contained in the document and their relationships.
OpenOpens the Open XML package archive.
ParsePartParses the specified part as XML.
ReadRelationshipsReads the relationships file in the archive associated with the specified part.
ReplacePartReplaces the contents of the specified part in the package.
ResetResets the class.
ResolveContentTypeReturns 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.

BeginFileFired before each file is processed.
CharactersFired for plain text segments of the input stream.
CommentFired when a comment section is encountered.
EndElementFired when an end-element tag is encountered.
EndFileFired after each file is processed.
EndPrefixMappingFired when leaving the scope of a namespace declaration.
ErrorInformation about errors during data delivery.
EvalEntityFired every time an entity needs to be evaluated.
IgnorableWhitespaceFired when a section of ignorable whitespace is encountered.
MetaFired when a meta section is encountered.
OverwriteFired whenever a file exists and may be overwritten.
PIFired when a processing instruction section is encountered.
ProgressFired as progress is made.
SpecialSectionFired when a special section is encountered.
StartElementFired when a begin-element tag is encountered in the document.
StartPrefixMappingFired 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.

NormalizePartNameWhether to normalize Part Names.
RelationshipIsExternal[x]Whether the relationship part is internal or external.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

ContentTypeCount Property (IPWorksZip_OfficeDoc Class)

The number of records in the ContentType arrays.

Object Oriented Interface


public function getContentTypeCount();


Procedural Interface


ipworkszip_officedoc_get($res, 1 );


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 (IPWorksZip_OfficeDoc Class)

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

Object Oriented Interface


public function getContentTypeIsOverride($contenttypeindex);


Procedural Interface


ipworkszip_officedoc_get($res, 2 , $contenttypeindex);


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 (IPWorksZip_OfficeDoc Class)

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

Object Oriented Interface


public function getContentTypeMediaType($contenttypeindex);


Procedural Interface


ipworkszip_officedoc_get($res, 3 , $contenttypeindex);


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 (IPWorksZip_OfficeDoc Class)

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

Object Oriented Interface


public function getContentTypeTarget($contenttypeindex);


Procedural Interface


ipworkszip_officedoc_get($res, 4 , $contenttypeindex);


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 (IPWorksZip_OfficeDoc Class)

The number of records in the Namespace arrays.

Object Oriented Interface


public function getNamespaceCount();


Procedural Interface


ipworkszip_officedoc_get($res, 5 );


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 (IPWorksZip_OfficeDoc Class)

The Prefix for the Namespace .

Object Oriented Interface


public function getNamespacePrefix($namespaceindex);


Procedural Interface


ipworkszip_officedoc_get($res, 6 , $namespaceindex);


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 (IPWorksZip_OfficeDoc Class)

Namespace URI associated with the corresponding Prefix .

Object Oriented Interface


public function getNamespaceURI($namespaceindex);


Procedural Interface


ipworkszip_officedoc_get($res, 7 , $namespaceindex);


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 (IPWorksZip_OfficeDoc Class)

The path to the Open XML package file.

Object Oriented Interface


public function getPackagePath();


public function setPackagePath($value);

Procedural Interface


ipworkszip_officedoc_get($res, 8 );


ipworkszip_officedoc_set($res, 8, $value );

Default Value

''

Remarks

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

Data Type

String

PackagePropertyCount Property (IPWorksZip_OfficeDoc Class)

The number of records in the PackageProperty arrays.

Object Oriented Interface


public function getPackagePropertyCount();


Procedural Interface


ipworkszip_officedoc_get($res, 9 );


Default Value

0

Remarks

This property controls the size of the following arrays:

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 (IPWorksZip_OfficeDoc Class)

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

Object Oriented Interface


public function getPackagePropertyDataType($packagepropertyindex);


Procedural Interface


ipworkszip_officedoc_get($res, 10 , $packagepropertyindex);


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 (IPWorksZip_OfficeDoc Class)

The name of this property.

Object Oriented Interface


public function getPackagePropertyName($packagepropertyindex);


Procedural Interface


ipworkszip_officedoc_get($res, 11 , $packagepropertyindex);


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 (IPWorksZip_OfficeDoc Class)

The XML Namespace URI associated with this property.

Object Oriented Interface


public function getPackagePropertyNamespace($packagepropertyindex);


Procedural Interface


ipworkszip_officedoc_get($res, 12 , $packagepropertyindex);


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 (IPWorksZip_OfficeDoc Class)

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

Object Oriented Interface


public function getPackagePropertyPropId($packagepropertyindex);


Procedural Interface


ipworkszip_officedoc_get($res, 13 , $packagepropertyindex);


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 (IPWorksZip_OfficeDoc Class)

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

Object Oriented Interface


public function getPackagePropertyPropSet($packagepropertyindex);


Procedural Interface


ipworkszip_officedoc_get($res, 14 , $packagepropertyindex);


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 (IPWorksZip_OfficeDoc Class)

The value of this property.

Object Oriented Interface


public function getPackagePropertyValue($packagepropertyindex);


Procedural Interface


ipworkszip_officedoc_get($res, 15 , $packagepropertyindex);


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 (IPWorksZip_OfficeDoc Class)

The contents of the currently selected part.

Object Oriented Interface


public function getPartData();


public function setPartData($value);

Procedural Interface


ipworkszip_officedoc_get($res, 16 );


ipworkszip_officedoc_set($res, 16, $value );

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 (IPWorksZip_OfficeDoc Class)

The name of the currently selected part.

Object Oriented Interface


public function getPartName();


public function setPartName($value);

Procedural Interface


ipworkszip_officedoc_get($res, 17 );


ipworkszip_officedoc_set($res, 17, $value );

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 (IPWorksZip_OfficeDoc Class)

The number of records in the Relationship arrays.

Object Oriented Interface


public function getRelationshipCount();


Procedural Interface


ipworkszip_officedoc_get($res, 18 );


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 (IPWorksZip_OfficeDoc Class)

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

Object Oriented Interface


public function getRelationshipContentType($relationshipindex);


Procedural Interface


ipworkszip_officedoc_get($res, 19 , $relationshipindex);


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 (IPWorksZip_OfficeDoc Class)

The unique ID of this relationship within this .

Object Oriented Interface


public function getRelationshipId($relationshipindex);


Procedural Interface


ipworkszip_officedoc_get($res, 20 , $relationshipindex);


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 (IPWorksZip_OfficeDoc Class)

The name of the part this relationship entry applies to.

Object Oriented Interface


public function getRelationshipPartName($relationshipindex);


Procedural Interface


ipworkszip_officedoc_get($res, 21 , $relationshipindex);


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 (IPWorksZip_OfficeDoc Class)

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

Object Oriented Interface


public function getRelationshipTypeURI($relationshipindex);


Procedural Interface


ipworkszip_officedoc_get($res, 22 , $relationshipindex);


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 (IPWorksZip_OfficeDoc Class)

When True, the parser checks that the document consists of well-formed XML.

Object Oriented Interface


public function getValidate();


public function setValidate($value);

Procedural Interface


ipworkszip_officedoc_get($res, 23 );


ipworkszip_officedoc_set($res, 23, $value );

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 (IPWorksZip_OfficeDoc Class)

The number of records in the Attr arrays.

Object Oriented Interface


public function getAttrCount();


Procedural Interface


ipworkszip_officedoc_get($res, 24 );


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 (IPWorksZip_OfficeDoc Class)

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

Object Oriented Interface


public function getAttrName($attrindex);


Procedural Interface


ipworkszip_officedoc_get($res, 25 , $attrindex);


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 (IPWorksZip_OfficeDoc Class)

Attribute namespace.

Object Oriented Interface


public function getAttrNamespace($attrindex);


Procedural Interface


ipworkszip_officedoc_get($res, 26 , $attrindex);


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 (IPWorksZip_OfficeDoc Class)

Attribute prefix (if any).

Object Oriented Interface


public function getAttrPrefix($attrindex);


Procedural Interface


ipworkszip_officedoc_get($res, 27 , $attrindex);


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 (IPWorksZip_OfficeDoc Class)

Attribute value.

Object Oriented Interface


public function getAttrValue($attrindex);


Procedural Interface


ipworkszip_officedoc_get($res, 28 , $attrindex);


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 (IPWorksZip_OfficeDoc Class)

The number of records in the XChild arrays.

Object Oriented Interface


public function getXChildCount();


Procedural Interface


ipworkszip_officedoc_get($res, 29 );


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 (IPWorksZip_OfficeDoc Class)

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

Object Oriented Interface


public function getXChildName($xchildindex);


Procedural Interface


ipworkszip_officedoc_get($res, 30 , $xchildindex);


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 (IPWorksZip_OfficeDoc Class)

Namespace of the element.

Object Oriented Interface


public function getXChildNamespace($xchildindex);


Procedural Interface


ipworkszip_officedoc_get($res, 31 , $xchildindex);


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 (IPWorksZip_OfficeDoc Class)

Prefix of the element (if any).

Object Oriented Interface


public function getXChildPrefix($xchildindex);


Procedural Interface


ipworkszip_officedoc_get($res, 32 , $xchildindex);


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 (IPWorksZip_OfficeDoc Class)

The inner text of the element.

Object Oriented Interface


public function getXChildXText($xchildindex);


Procedural Interface


ipworkszip_officedoc_get($res, 33 , $xchildindex);


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 (IPWorksZip_OfficeDoc Class)

The name of the current element.

Object Oriented Interface


public function getXElement();


Procedural Interface


ipworkszip_officedoc_get($res, 34 );


Default Value

''

Remarks

The current element is specified via the XPath property.

This property is read-only.

Data Type

String

XNamespace Property (IPWorksZip_OfficeDoc Class)

The namespace of the current element.

Object Oriented Interface


public function getXNamespace();


Procedural Interface


ipworkszip_officedoc_get($res, 35 );


Default Value

''

Remarks

The current element is specified via the XPath property.

This property is read-only.

Data Type

String

XParent Property (IPWorksZip_OfficeDoc Class)

The parent of the current element.

Object Oriented Interface


public function getXParent();


Procedural Interface


ipworkszip_officedoc_get($res, 36 );


Default Value

''

Remarks

The current element is specified via the XPath property.

This property is read-only.

Data Type

String

XPath Property (IPWorksZip_OfficeDoc Class)

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

Object Oriented Interface


public function getXPath();


public function setXPath($value);

Procedural Interface


ipworkszip_officedoc_get($res, 37 );


ipworkszip_officedoc_set($res, 37, $value );

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

When XPath is set to a valid path, XElement points to the name of the element, with XParent, XNamespace, XPrefix, XChildName, XChildNamespace, XChildPrefix, XChildXText, and XText providing other properties of the element. The attributes of the current element are provided in the AttrName, AttrNamespace, AttrPrefix, and AttrValue properties.

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

Example (Setting XPath):

Document rootXML.XPath = "/"
Specific ElementXML.XPath = "/root/SubElement1/SubElement2/"
i-th ChildXML.XPath = "/root/SubElement1[i]"

Data Type

String

XPrefix Property (IPWorksZip_OfficeDoc Class)

The prefix of the current element.

Object Oriented Interface


public function getXPrefix();


Procedural Interface


ipworkszip_officedoc_get($res, 38 );


Default Value

''

Remarks

The current element is specified via the XPath property.

This property is read-only.

Data Type

String

XSubTree Property (IPWorksZip_OfficeDoc Class)

A snapshot of the current element in the document.

Object Oriented Interface


public function getXSubTree();


Procedural Interface


ipworkszip_officedoc_get($res, 39 );


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 (IPWorksZip_OfficeDoc Class)

The text of the current element.

Object Oriented Interface


public function getXText();


Procedural Interface


ipworkszip_officedoc_get($res, 40 );


Default Value

''

Remarks

The current element is specified via the XPath property.

This property is read-only.

Data Type

String

Close Method (IPWorksZip_OfficeDoc Class)

Closes the Open XML package archive.

Object Oriented Interface

public function doClose();

Procedural Interface

ipworkszip_officedoc_do_close($res);

Remarks

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

Config Method (IPWorksZip_OfficeDoc Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworkszip_officedoc_do_config($res, $configurationstring);

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.

ExtractPart Method (IPWorksZip_OfficeDoc Class)

Reads the contents of the currently selected part.

Object Oriented Interface

public function doExtractPart();

Procedural Interface

ipworkszip_officedoc_do_extractpart($res);

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.

FindPartByType Method (IPWorksZip_OfficeDoc Class)

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

Object Oriented Interface

public function doFindPartByType($typeuri);

Procedural Interface

ipworkszip_officedoc_do_findpartbytype($res, $typeuri);

Remarks

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

GetPropertyValue Method (IPWorksZip_OfficeDoc Class)

Returns the value of the specified package property.

Object Oriented Interface

public function doGetPropertyValue($propname, $propnamespace);

Procedural Interface

ipworkszip_officedoc_do_getpropertyvalue($res, $propname, $propnamespace);

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.

ListParts Method (IPWorksZip_OfficeDoc Class)

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

Object Oriented Interface

public function doListParts();

Procedural Interface

ipworkszip_officedoc_do_listparts($res);

Remarks

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

Open Method (IPWorksZip_OfficeDoc Class)

Opens the Open XML package archive.

Object Oriented Interface

public function doOpen();

Procedural Interface

ipworkszip_officedoc_do_open($res);

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.

ParsePart Method (IPWorksZip_OfficeDoc Class)

Parses the specified part as XML.

Object Oriented Interface

public function doParsePart();

Procedural Interface

ipworkszip_officedoc_do_parsepart($res);

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.

ReadRelationships Method (IPWorksZip_OfficeDoc Class)

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

Object Oriented Interface

public function doReadRelationships();

Procedural Interface

ipworkszip_officedoc_do_readrelationships($res);

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.

ReplacePart Method (IPWorksZip_OfficeDoc Class)

Replaces the contents of the specified part in the package.

Object Oriented Interface

public function doReplacePart();

Procedural Interface

ipworkszip_officedoc_do_replacepart($res);

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.

Reset Method (IPWorksZip_OfficeDoc Class)

Resets the class.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworkszip_officedoc_do_reset($res);

Remarks

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

ResolveContentType Method (IPWorksZip_OfficeDoc Class)

Returns the content type of the specified part.

Object Oriented Interface

public function doResolveContentType();

Procedural Interface

ipworkszip_officedoc_do_resolvecontenttype($res);

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.

BeginFile Event (IPWorksZip_OfficeDoc Class)

Fired before each file is processed.

Object Oriented Interface

public function fireBeginFile($param);

Procedural Interface

ipworkszip_officedoc_register_callback($res, 1, array($this, 'fireBeginFile'));

Parameter List

 'index'
'skip'

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 (IPWorksZip_OfficeDoc Class)

Fired for plain text segments of the input stream.

Object Oriented Interface

public function fireCharacters($param);

Procedural Interface

ipworkszip_officedoc_register_callback($res, 2, array($this, 'fireCharacters'));

Parameter List

 'text'

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 (IPWorksZip_OfficeDoc Class)

Fired when a comment section is encountered.

Object Oriented Interface

public function fireComment($param);

Procedural Interface

ipworkszip_officedoc_register_callback($res, 3, array($this, 'fireComment'));

Parameter List

 'text'

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 (IPWorksZip_OfficeDoc Class)

Fired when an end-element tag is encountered.

Object Oriented Interface

public function fireEndElement($param);

Procedural Interface

ipworkszip_officedoc_register_callback($res, 4, array($this, 'fireEndElement'));

Parameter List

 'namespace'
'element'
'qname'
'isempty'

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 (IPWorksZip_OfficeDoc Class)

Fired after each file is processed.

Object Oriented Interface

public function fireEndFile($param);

Procedural Interface

ipworkszip_officedoc_register_callback($res, 5, array($this, 'fireEndFile'));

Parameter List

 'index'

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 (IPWorksZip_OfficeDoc Class)

Fired when leaving the scope of a namespace declaration.

Object Oriented Interface

public function fireEndPrefixMapping($param);

Procedural Interface

ipworkszip_officedoc_register_callback($res, 6, array($this, 'fireEndPrefixMapping'));

Parameter List

 'prefix'

Remarks

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

Error Event (IPWorksZip_OfficeDoc Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworkszip_officedoc_register_callback($res, 7, array($this, 'fireError'));

Parameter List

 'errorcode'
'description'

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 (IPWorksZip_OfficeDoc Class)

Fired every time an entity needs to be evaluated.

Object Oriented Interface

public function fireEvalEntity($param);

Procedural Interface

ipworkszip_officedoc_register_callback($res, 8, array($this, 'fireEvalEntity'));

Parameter List

 'entity'
'value'

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 (IPWorksZip_OfficeDoc Class)

Fired when a section of ignorable whitespace is encountered.

Object Oriented Interface

public function fireIgnorableWhitespace($param);

Procedural Interface

ipworkszip_officedoc_register_callback($res, 9, array($this, 'fireIgnorableWhitespace'));

Parameter List

 'text'

Remarks

The ignorable whitespace section is provided by the Text parameter.

Meta Event (IPWorksZip_OfficeDoc Class)

Fired when a meta section is encountered.

Object Oriented Interface

public function fireMeta($param);

Procedural Interface

ipworkszip_officedoc_register_callback($res, 10, array($this, 'fireMeta'));

Parameter List

 'text'

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 (IPWorksZip_OfficeDoc Class)

Fired whenever a file exists and may be overwritten.

Object Oriented Interface

public function fireOverwrite($param);

Procedural Interface

ipworkszip_officedoc_register_callback($res, 11, array($this, 'fireOverwrite'));

Parameter List

 'filename'
'overwrite'

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 (IPWorksZip_OfficeDoc Class)

Fired when a processing instruction section is encountered.

Object Oriented Interface

public function firePI($param);

Procedural Interface

ipworkszip_officedoc_register_callback($res, 12, array($this, 'firePI'));

Parameter List

 'text'

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 (IPWorksZip_OfficeDoc Class)

Fired as progress is made.

Object Oriented Interface

public function fireProgress($param);

Procedural Interface

ipworkszip_officedoc_register_callback($res, 13, array($this, 'fireProgress'));

Parameter List

 'data'
'filename'
'bytesprocessed'
'percentprocessed'

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 (IPWorksZip_OfficeDoc Class)

Fired when a special section is encountered.

Object Oriented Interface

public function fireSpecialSection($param);

Procedural Interface

ipworkszip_officedoc_register_callback($res, 14, array($this, 'fireSpecialSection'));

Parameter List

 'sectionid'
'text'

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 (IPWorksZip_OfficeDoc Class)

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

Object Oriented Interface

public function fireStartElement($param);

Procedural Interface

ipworkszip_officedoc_register_callback($res, 15, array($this, 'fireStartElement'));

Parameter List

 'namespace'
'element'
'qname'
'isempty'

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 (IPWorksZip_OfficeDoc Class)

Fired when entering the scope of a namespace declaration.

Object Oriented Interface

public function fireStartPrefixMapping($param);

Procedural Interface

ipworkszip_officedoc_register_callback($res, 16, array($this, 'fireStartPrefixMapping'));

Parameter List

 'prefix'
'uri'

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: /ppt/media/image1.jpeg

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:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8

The following is a list of valid code page identifiers for Mac OS only:

IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

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:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
ProcessIdleEvents:   Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis:   The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20.

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)

Errors

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

268   The specified part name could not be found on the package, or the part is stored in interleaved format.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks ZIP 2022 PHP Edition - Version 22.0 [Build 8203]