OfficeDoc Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

ipworkszip.OfficeDoc

Remarks

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

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

ContentTypes Property (OfficeDoc Class)

Collection of content type entries.

Syntax

public ContentTypeList getContentTypes();

Remarks

Contains the default content types, as well as overrides for parts in the archive.

This property is read-only.

Please refer to the ContentType type for a complete list of fields.

Namespaces Property (OfficeDoc Class)

Collection of namespaces in the current namespace stack.

Syntax

public XMLNamespaceList getNamespaces();

Remarks

This property contains a collection of XML namespaces, which are standards for providing uniquely named elements and attributes in an XML instance.

This collection is indexed from 0 to size -1.

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

Please refer to the XMLNamespace type for a complete list of fields.

PackagePath Property (OfficeDoc Class)

The path to the Open XML package file.

Syntax

public String getPackagePath();
public void setPackagePath(String packagePath);

Default Value

""

Remarks

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

PackageProperties Property (OfficeDoc Class)

Collection of core/app/custom metadata properties associated with the archive.

Syntax

public PackagePropertyList getPackageProperties();

Remarks

When the package is first opened using Open, the class looks for any metadata property files in the archive and will expose their contents through this collection.

This property is read-only.

Please refer to the PackageProperty type for a complete list of fields.

PartData Property (OfficeDoc Class)

The contents of the currently selected part.

Syntax

public byte[] getPartData();
public void setPartData(byte[] partData);

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.

PartName Property (OfficeDoc Class)

The name of the currently selected part.

Syntax

public String getPartName();
public void setPartName(String partName);

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.

Relationships Property (OfficeDoc Class)

Collection of Relationships in the current relationships (*.rels) file.

Syntax

public RelationshipList getRelationships();

Remarks

When the package is first opened using Open, the top-level relationships file (/rels/.rels) is parsed and this collection populated with its contents. The ReadRelationships method can be used to populate this collection with the contents of other, part-specific relationship files, as needed.

This property is read-only.

Please refer to the Relationship type for a complete list of fields.

Validate Property (OfficeDoc Class)

This property controls whether documents are validated during parsing.

Syntax

public boolean isValidate();
public void setValidate(boolean validate);

Default Value

True

Remarks

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

XAttributes Property (OfficeDoc Class)

A collection of attributes of the current element.

Syntax

public XMLAttributeList getXAttributes();

Remarks

This collection consists of all attributes of the current XML element. The component parses each attribute into a collection of XMLAttribute types.

This collection is indexed from 0 to size -1.

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

Please refer to the XMLAttribute type for a complete list of fields.

XChildren Property (OfficeDoc Class)

Collection of child elements of the current element.

Syntax

public XMLElementList getXChildren();

Remarks

The elements are provided in the collection in the same order they are found in the document.

This collection is indexed from 0 to size -1.

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

Please refer to the XMLElement type for a complete list of fields.

XElement Property (OfficeDoc Class)

The name of the current element.

Syntax

public String getXElement();

Default Value

""

Remarks

The current element is specified via the XPath property.

This property is read-only.

XNamespace Property (OfficeDoc Class)

The namespace of the current element.

Syntax

public String getXNamespace();

Default Value

""

Remarks

The current element is specified via the XPath property.

This property is read-only.

XParent Property (OfficeDoc Class)

This property includes the parent of the current element.

Syntax

public String getXParent();

Default Value

""

Remarks

The current element is specified through the XPath property.

This property is read-only.

XPath Property (OfficeDoc Class)

This property provides a way to point to a specific element in the document.

Syntax

public String getXPath();
public void setXPath(String XPath);

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:

When XPath is set to a valid path, XElement points to the name of the element, with XParent, XNamespace, XPrefix, XChildren , and XText providing other properties of the element. The attributes of the current element are provided in the XAttributes collection.

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

Example. Setting XPath:

XPrefix Property (OfficeDoc Class)

The prefix of the current element.

Syntax

public String getXPrefix();

Default Value

""

Remarks

The current element is specified via the XPath property.

This property is read-only.

XSubTree Property (OfficeDoc Class)

This property includes a snapshot of the current element in the document.

Syntax

public String getXSubTree();

Default Value

""

Remarks

The current element is specified through the XPath property. For this property to work, you must set the CacheContent to True.

This property is read-only.

XText Property (OfficeDoc Class)

The text of the current element.

Syntax

public String getXText();

Default Value

""

Remarks

The current element is specified via the XPath property.

This property is read-only.

Close Method (OfficeDoc Class)

Closes the Open XML package archive.

Syntax

public void close();

Remarks

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

Config Method (OfficeDoc Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String 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 (OfficeDoc Class)

Reads the contents of the currently selected part.

Syntax

public void 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.

FindPartByType Method (OfficeDoc Class)

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

Syntax

public String findPartByType(String typeURI);

Remarks

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

GetPropertyValue Method (OfficeDoc Class)

Returns the value of the specified package property.

Syntax

public String getPropertyValue(String propName, String 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 (OfficeDoc Class)

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

Syntax

public void listParts();

Remarks

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

Open Method (OfficeDoc Class)

Opens the Open XML package archive.

Syntax

public void 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.

ParsePart Method (OfficeDoc Class)

Parses the specified part as XML.

Syntax

public void 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.

ReadRelationships Method (OfficeDoc Class)

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

Syntax

public void 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.

ReplacePart Method (OfficeDoc Class)

Replaces the contents of the specified part in the package.

Syntax

public void 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.

Reset Method (OfficeDoc Class)

Resets the class.

Syntax

public void 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.

ResolveContentType Method (OfficeDoc Class)

Returns the content type of the specified part.

Syntax

public String 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.

BeginFile Event (OfficeDoc Class)

Fired before each file is processed.

Syntax

public class DefaultOfficeDocEventListener implements OfficeDocEventListener {
  ...
  public void beginFile(OfficeDocBeginFileEvent e) {}
  ...
}

public class OfficeDocBeginFileEvent {
  public int index;
  public boolean skip; //read-write
}

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 CompressedName, DecompressedName, CompressedSize (decompression only), and DecompressedSize 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 DecompressedName and/or ExtractToPath. If DecompressedName 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. CompressedName and DecompressedName 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)

This event is fired for plaintext segments of the input stream.

Syntax

public class DefaultOfficeDocEventListener implements OfficeDocEventListener {
  ...
  public void characters(OfficeDocCharactersEvent e) {}
  ...
}

public class OfficeDocCharactersEvent {
  public String text;
}

Remarks

The Characters event provides the plaintext 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)

This event is fired when a comment section is encountered.

Syntax

public class DefaultOfficeDocEventListener implements OfficeDocEventListener {
  ...
  public void comment(OfficeDocCommentEvent e) {}
  ...
}

public class OfficeDocCommentEvent {
  public String 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 (OfficeDoc Class)

This event is fired when an end-element tag is encountered.

Syntax

public class DefaultOfficeDocEventListener implements OfficeDocEventListener {
  ...
  public void endElement(OfficeDocEndElementEvent e) {}
  ...
}

public class OfficeDocEndElementEvent {
  public String namespace;
  public String element;
  public String QName;
  public boolean 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 to an empty element declaration.

EndFile Event (OfficeDoc Class)

Fired after each file is processed.

Syntax

public class DefaultOfficeDocEventListener implements OfficeDocEventListener {
  ...
  public void endFile(OfficeDocEndFileEvent e) {}
  ...
}

public class OfficeDocEndFileEvent {
  public int 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 CompressedName, DecompressedName, CompressedSize, and DecompressedSize fields in the Files collection for this index contain more detailed information about the file processed.

EndPrefixMapping Event (OfficeDoc Class)

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

Syntax

public class DefaultOfficeDocEventListener implements OfficeDocEventListener {
  ...
  public void endPrefixMapping(OfficeDocEndPrefixMappingEvent e) {}
  ...
}

public class OfficeDocEndPrefixMappingEvent {
  public String prefix;
}

Remarks

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

Error Event (OfficeDoc Class)

Fired when information is available about errors during data delivery.

Syntax

public class DefaultOfficeDocEventListener implements OfficeDocEventListener {
  ...
  public void error(OfficeDocErrorEvent e) {}
  ...
}

public class OfficeDocErrorEvent {
  public int errorCode;
  public String description;
}

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class throws an exception.

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

EvalEntity Event (OfficeDoc Class)

This event is fired every time an entity needs to be evaluated.

Syntax

public class DefaultOfficeDocEventListener implements OfficeDocEventListener {
  ...
  public void evalEntity(OfficeDocEvalEntityEvent e) {}
  ...
}

public class OfficeDocEvalEntityEvent {
  public String entity;
  public String value; //read-write
}

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)

This event is fired when a section of ignorable whitespace is encountered.

Syntax

public class DefaultOfficeDocEventListener implements OfficeDocEventListener {
  ...
  public void ignorableWhitespace(OfficeDocIgnorableWhitespaceEvent e) {}
  ...
}

public class OfficeDocIgnorableWhitespaceEvent {
  public String text;
}

Remarks

The ignorable whitespace section is provided by the Text parameter.

Meta Event (OfficeDoc Class)

This event fires when a meta section is encountered.

Syntax

public class DefaultOfficeDocEventListener implements OfficeDocEventListener {
  ...
  public void meta(OfficeDocMetaEvent e) {}
  ...
}

public class OfficeDocMetaEvent {
  public String 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 (OfficeDoc Class)

Fired whenever a file exists and may be overwritten.

Syntax

public class DefaultOfficeDocEventListener implements OfficeDocEventListener {
  ...
  public void overwrite(OfficeDocOverwriteEvent e) {}
  ...
}

public class OfficeDocOverwriteEvent {
  public String filename; //read-write
  public boolean overwrite; //read-write
}

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)

This event is fired when a processing instruction section is encountered.

Syntax

public class DefaultOfficeDocEventListener implements OfficeDocEventListener {
  ...
  public void PI(OfficeDocPIEvent e) {}
  ...
}

public class OfficeDocPIEvent {
  public String 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 (OfficeDoc Class)

Fired as progress is made.

Syntax

public class DefaultOfficeDocEventListener implements OfficeDocEventListener {
  ...
  public void progress(OfficeDocProgressEvent e) {}
  ...
}

public class OfficeDocProgressEvent {
  public byte[] data;
  public String filename;
  public long bytesProcessed;
  public int 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 (OfficeDoc Class)

This event is fired when a special section is encountered.

Syntax

public class DefaultOfficeDocEventListener implements OfficeDocEventListener {
  ...
  public void specialSection(OfficeDocSpecialSectionEvent e) {}
  ...
}

public class OfficeDocSpecialSectionEvent {
  public String sectionId;
  public String 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, and the SectionId parameter provides the section identifier (e.g., CDATA).

StartElement Event (OfficeDoc Class)

This event is fired when a begin-element tag is encountered in the document.

Syntax

public class DefaultOfficeDocEventListener implements OfficeDocEventListener {
  ...
  public void startElement(OfficeDocStartElementEvent e) {}
  ...
}

public class OfficeDocStartElementEvent {
  public String namespace;
  public String element;
  public String QName;
  public boolean 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 XAttributes collection.

The IsEmpty parameter is True when the event corresponds to an empty element declaration.

StartPrefixMapping Event (OfficeDoc Class)

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

Syntax

public class DefaultOfficeDocEventListener implements OfficeDocEventListener {
  ...
  public void startPrefixMapping(OfficeDocStartPrefixMappingEvent e) {}
  ...
}

public class OfficeDocStartPrefixMappingEvent {
  public String prefix;
  public String URI;
}

Remarks

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

ContentType Type

The Content Type entry as defined in the package.

Remarks

The content type represents an entry in the [Content_Types].xml file in the archive. It can either represent a default type associated with an extension, or an override specific to a given part in the archive.

Fields

Constructors

public ContentType();

PackageProperty Type

A core/app/custom metadata property attached to the package.

Remarks

A property is an entry in one of the package's property files.

All the properties, including core Open XML properties, application-specific properties and custom properties are represented here using the same structure.

Fields

Constructors

public PackageProperty();

Relationship Type

A relationship entry in a .rels file in the archive.

Remarks

A relationship represents a reference to another part within the archive.

A relationship entry specifies a part name, the type of relationship (what it means) and a unique Id for this relation in the currently selected relationship file.

Fields

Constructors

public Relationship();

XMLAttribute Type

This type describes an XML attribute from the current XML element.

Remarks

This type describes an XML attribute from the current element. It includes fields to denote information about the attribute being defined.

Fields

Constructors

public XMLAttribute();

XMLElement Type

This type describes an element contained within the XML document.

Remarks

This type describes an XML element. The fields for this type describe the element Name, Prefix, and Namespace of the given element.

The elements are inserted into the array in the same order they are found in the document.

Fields

Constructors

public XMLElement();

XMLNamespace Type

This type describes an XML namespace from the current namespace stack.

Remarks

This type describes an XML namespace from the current stack. It includes fields to denote the Prefix and the URI of the namespace being defined.

The default namespace exists at index 0. The Prefix field at index 0 is xmlns, and the Name field contains the default namespace.

Fields

Constructors

public XMLNamespace();

public XMLNamespace( URI,  prefix);

Config 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 Config Settings

Base Config Settings

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