# OfficeDoc Class

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.*

|  |  |
| --- | --- |
| [ContentTypes](#officedoccontenttypes-property) | Collection of content type entries. |
| [Namespaces](#officedocnamespaces-property) | Collection of namespaces in the current namespace stack. |
| [PackagePath](#officedocpackagepath-property) | The path to the Open XML package file. |
| [PackageProperties](#officedocpackageproperties-property) | Collection of core/app/custom metadata properties associated with the archive. |
| [PartData](#officedocpartdata-property) | The contents of the currently selected part. |
| [PartName](#officedocpartname-property) | The name of the currently selected part. |
| [Relationships](#officedocrelationships-property) | Collection of Relationships in the current relationships (*.rels) file. |
| [Validate](#officedocvalidate-property) | This property controls whether documents are validated during parsing. |
| [XAttributes](#officedocxattributes-property) | A collection of attributes of the current element. |
| [XChildren](#officedocxchildren-property) | Collection of child elements of the current element. |
| [XElement](#officedocxelement-property) | The name of the current element. |
| [XNamespace](#officedocxnamespace-property) | The namespace of the current element. |
| [XParent](#officedocxparent-property) | This property includes the parent of the current element. |
| [XPath](#officedocxpath-property) | This property provides a way to point to a specific element in the document. |
| [XPrefix](#officedocxprefix-property) | The prefix of the current element. |
| [XSubTree](#officedocxsubtree-property) | This property includes a snapshot of the current element in the document. |
| [XText](#officedocxtext-property) | 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](#officedocclose-method) | Closes the Open XML package archive. |
| [Config](#officedocconfig-method) | Sets or retrieves a configuration setting. |
| [ExtractPart](#officedocextractpart-method) | Reads the contents of the currently selected part. |
| [FindPartByType](#officedocfindpartbytype-method) | Looks up a part in the current relationships file by it's type namespace URI. |
| [GetPropertyValue](#officedocgetpropertyvalue-method) | Returns the value of the specified package property. |
| [ListParts](#officedoclistparts-method) | List all the parts contained in the document and their relationships. |
| [Open](#officedocopen-method) | Opens the Open XML package archive. |
| [ParsePart](#officedocparsepart-method) | Parses the specified part as XML. |
| [ReadRelationships](#officedocreadrelationships-method) | Reads the relationships file in the archive associated with the specified part. |
| [ReplacePart](#officedocreplacepart-method) | Replaces the contents of the specified part in the package. |
| [Reset](#officedocreset-method) | Resets the class. |
| [ResolveContentType](#officedocresolvecontenttype-method) | 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](#officedocbeginfile-event) | Fired before each file is processed. |
| [Characters](#officedoccharacters-event) | This event is fired for plaintext segments of the input stream. |
| [Comment](#officedoccomment-event) | This event is fired when a comment section is encountered. |
| [EndElement](#officedocendelement-event) | This event is fired when an end-element tag is encountered. |
| [EndFile](#officedocendfile-event) | Fired after each file is processed. |
| [EndPrefixMapping](#officedocendprefixmapping-event) | This event is fired when leaving the scope of a namespace declaration. |
| [Error](#officedocerror-event) | Fired when information is available about errors during data delivery. |
| [EvalEntity](#officedocevalentity-event) | This event is fired every time an entity needs to be evaluated. |
| [IgnorableWhitespace](#officedocignorablewhitespace-event) | This event is fired when a section of ignorable whitespace is encountered. |
| [Meta](#officedocmeta-event) | This event fires when a meta section is encountered. |
| [Overwrite](#officedocoverwrite-event) | Fired whenever a file exists and may be overwritten. |
| [PI](#officedocpi-event) | This event is fired when a processing instruction section is encountered. |
| [Progress](#officedocprogress-event) | Fired as progress is made. |
| [SpecialSection](#officedocspecialsection-event) | This event is fired when a special section is encountered. |
| [StartElement](#officedocstartelement-event) | This event is fired when a begin-element tag is encountered in the document. |
| [StartPrefixMapping](#officedocstartprefixmapping-event) | This event is fired when entering the scope of a namespace declaration. |

## Config Settings

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

|  |  |
| --- | --- |
| [NormalizePartName](#NormalizePartName) | Whether to normalize Part Names. |
| [RelationshipIsExternal\[x\]](#RelationshipIsExternal[x]) | Whether the relationship part is internal or external. |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# [OfficeDoc](#officedoc-class).ContentTypes Property

Collection of content type entries.

## Syntax

```text
getContentTypes(): ContentTypeList;
```

## Default Value

## 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](#contenttype-type) type for a complete list of fields.

# [OfficeDoc](#officedoc-class).Namespaces Property

Collection of namespaces in the current namespace stack.

## Syntax

```text
getNamespaces(): XMLNamespaceList;
```

## Default Value

## Remarks

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

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

 Please refer to the [XMLNamespace](#xmlnamespace-type) type for a complete list of fields.

# [OfficeDoc](#officedoc-class).PackagePath Property

The path to the Open XML package file.

## Syntax

```text
getPackagePath(): string;
setPackagePath(packagePath: string): void;
```

## Default Value

""

## Remarks

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

# [OfficeDoc](#officedoc-class).PackageProperties Property

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

## Syntax

```text
getPackageProperties(): PackagePropertyList;
```

## Default Value

## Remarks

When the package is first opened using [Open](#officedocopen-method), 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](#packageproperty-type) type for a complete list of fields.

# [OfficeDoc](#officedoc-class).PartData Property

The contents of the currently selected part.

## Syntax

```text
getPartData(): Uint8Array;
setPartData(partData: Uint8Array): void;
```

## Default Value

""

## Remarks

This property will hold the contents of the part selected by [PartName](#officedocpartname-property) after calling the [ExtractPart](#officedocextractpart-method) method. It can also be set before calling [ReplacePart](#officedocreplacepart-method).

# [OfficeDoc](#officedoc-class).PartName Property

The name of the currently selected part.

## Syntax

```text
getPartName(): string;
setPartName(partName: string): void;
```

## 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.

# [OfficeDoc](#officedoc-class).Relationships Property

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

## Syntax

```text
getRelationships(): RelationshipList;
```

## Default Value

## Remarks

When the package is first opened using [Open](#officedocopen-method), the top-level relationships file (/rels/.rels) is parsed and this collection populated with its contents. The [ReadRelationships](#officedocreadrelationships-method) 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](#relationship-type) type for a complete list of fields.

# [OfficeDoc](#officedoc-class).Validate Property

This property controls whether documents are validated during parsing.

## Syntax

```text
isValidate(): boolean;
setValidate(validate: boolean): void;
```

## 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.

# [OfficeDoc](#officedoc-class).XAttributes Property

A collection of attributes of the current element.

## Syntax

```text
getXAttributes(): XMLAttributeList;
```

## Default Value

## Remarks

This collection consists of all attributes of the current XML element. The component parses each attribute into a collection of [XMLAttribute](#xmlattribute-type) types.

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

 Please refer to the [XMLAttribute](#xmlattribute-type) type for a complete list of fields.

# [OfficeDoc](#officedoc-class).XChildren Property

Collection of child elements of the current element.

## Syntax

```text
getXChildren(): XMLElementList;
```

## Default Value

## Remarks

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

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

 Please refer to the [XMLElement](#xmlelement-type) type for a complete list of fields.

# [OfficeDoc](#officedoc-class).XElement Property

The name of the current element.

## Syntax

```text
getXElement(): string;
```

## Default Value

""

## Remarks

The current element is specified via the [XPath](#officedocxpath-property) property.

This property is read-only.

# [OfficeDoc](#officedoc-class).XNamespace Property

The namespace of the current element.

## Syntax

```text
getXNamespace(): string;
```

## Default Value

""

## Remarks

The current element is specified via the [XPath](#officedocxpath-property) property.

This property is read-only.

# [OfficeDoc](#officedoc-class).XParent Property

This property includes the parent of the current element.

## Syntax

```text
getXParent(): string;
```

## Default Value

""

## Remarks

The current element is specified through the [XPath](#officedocxpath-property) property.

This property is read-only.

# [OfficeDoc](#officedoc-class).XPath Property

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

## Syntax

```text
getXPath(): string;
setXPath(XPath: string): void;
```

## Default Value

""

## Remarks

XPath implements a subset of the XML XPath specification, allowing you to point to specific elements in the XML document.

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](#officedocxelement-property) points to the name of the element, with [XParent](#officedocxparent-property), [XNamespace](#officedocxnamespace-property), [XPrefix](#officedocxprefix-property), XChildrenName, XChildrenNamespace, XChildrenPrefix, XChildrenXText, and [XText](#officedocxtext-property) providing other properties of the element. The attributes of the current element are provided in the XAttributesName, XAttributesNamespace, XAttributesPrefix, and XAttributesValue collection.

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

**Example. Setting XPath:**

|  |  |
| --- | --- |
| Document root | XML.XPath = "/" |
| Specific Element | XML.XPath = "/root/SubElement1/SubElement2/" |
| i-th Child | XML.XPath = "/root/SubElement1[i]" |

# [OfficeDoc](#officedoc-class).XPrefix Property

The prefix of the current element.

## Syntax

```text
getXPrefix(): string;
```

## Default Value

""

## Remarks

The current element is specified via the [XPath](#officedocxpath-property) property.

This property is read-only.

# [OfficeDoc](#officedoc-class).XSubTree Property

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

## Syntax

```text
getXSubTree(): string;
```

## Default Value

""

## Remarks

The current element is specified through the [XPath](#officedocxpath-property) property. For this property to work, you must set [CacheContent](#CacheContent) to *true*.

This property is read-only.

# [OfficeDoc](#officedoc-class).XText Property

The text of the current element.

## Syntax

```text
getXText(): string;
```

## Default Value

""

## Remarks

The current element is specified via the [XPath](#officedocxpath-property) property.

This property is read-only.

# [OfficeDoc](#officedoc-class).close Method

Closes the Open XML package archive.

## Syntax

```text
async officedoc.close(): Promise< void>
```

## Remarks

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

# [OfficeDoc](#officedoc-class).config Method

Sets or retrieves a configuration setting.

## Syntax

```text
async officedoc.config(configurationString : string): Promise< string>
```

## Remarks

Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-class-ipworkszipofficedoc) 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](#config-settings-class-ipworkszipofficedoc), you must call *Config("PROPERTY")*. The value will be returned as a string.

# [OfficeDoc](#officedoc-class).extractPart Method

Reads the contents of the currently selected part.

## Syntax

```text
async officedoc.extractPart(): Promise< void>
```

## Remarks

If the part specified by the [PartName](#officedocpartname-property) property exists, the corresponding physical file will be extracted from the archive and will be available through the [PartData](#officedocpartdata-property) property.

If the part doesn't exists, or it's stored in interleaved format, an error will be raised.

# [OfficeDoc](#officedoc-class).findPartByType Method

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

## Syntax

```text
async officedoc.findPartByType(typeURI : string): Promise< string>
```

## Remarks

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

# [OfficeDoc](#officedoc-class).getPropertyValue Method

Returns the value of the specified package property.

## Syntax

```text
async officedoc.getPropertyValue(propName : string, propNamespace : string): Promise< string>
```

## 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.

# [OfficeDoc](#officedoc-class).listParts Method

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

## Syntax

```text
async officedoc.listParts(): Promise< void>
```

## Remarks

When this method is called, the class will read all the relationships in the document, recursively, and populate the [Relationships](#officedocrelationships-property) collection.

# [OfficeDoc](#officedoc-class).open Method

Opens the Open XML package archive.

## Syntax

```text
async officedoc.open(): Promise< void>
```

## Remarks

When this method is called, the class will attempt to open the archive specified in [PackagePath](#officedocpackagepath-property) and extract package properties, content types and parse the master relationships file in the archive.

# [OfficeDoc](#officedoc-class).parsePart Method

Parses the specified part as XML.

## Syntax

```text
async officedoc.parsePart(): Promise< void>
```

## Remarks

If the part specified by [PartName](#officedocpartname-property) 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](#officedocxpath-property) property. If BuildDOM is disabled, only the XML parser-related events will be fired.

# [OfficeDoc](#officedoc-class).readRelationships Method

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

## Syntax

```text
async officedoc.readRelationships(): Promise< void>
```

## Remarks

When this method is called, the class will look for a .rels file associated with the part specified by the [PartName](#officedocpartname-property) property. If found, the [Relationships](#officedocrelationships-property) collection will now expose the contents of the relationships for that part.

# [OfficeDoc](#officedoc-class).replacePart Method

Replaces the contents of the specified part in the package.

## Syntax

```text
async officedoc.replacePart(): Promise< void>
```

## Remarks

If the part specified by the [PartName](#officedocpartname-property) property exists, the corresponding physical file will be replaced with the contents of the [PartData](#officedocpartdata-property) 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](#officedocpartdata-property) is null or empty, an error will be raised.

# [OfficeDoc](#officedoc-class).reset Method

Resets the class.

## Syntax

```text
async officedoc.reset(): Promise< void>
```

## Remarks

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

# [OfficeDoc](#officedoc-class).resolveContentType Method

Returns the content type of the specified part.

## Syntax

```text
async officedoc.resolveContentType(): Promise< string>
```

## Remarks

Applies the content type resolution rules specified in the Open XML packaging specification and returns the content type associated with [PartName](#officedocpartname-property) in the archive.

If there's no content type mapped for the part or for the extension, an empty string is returned.

# [OfficeDoc](#officedoc-class).BeginFile Event

Fired before each file is processed.

## Syntax

```text
officedoc.on('BeginFile', listener: (e: {readonly index: number, skip: boolean}) => void )
```

## 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 FilesCompressedName, FilesDecompressedName, FilesCompressedSize (decompression only), and FilesDecompressedSize 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 FilesDecompressedName and/or ExtractToPath. If FilesDecompressedName is set to an empty string, the file will not be written to disk. If [WriteToProgressEvent](#WriteToProgressEvent) is true, the file will still be decompressed, and the data may be extracted through the [Progress](#officedocprogress-event) event.

This event may also be trapped while compressing. FilesCompressedName and FilesDecompressedName may be changed.

 You may set the *Skip* parameter to true in order to skip the file completely while compressing or extracting.

# [OfficeDoc](#officedoc-class).Characters Event

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

## Syntax

```text
officedoc.on('Characters', listener: (e: {readonly text: string}) => void )
```

## 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 whitespace as well as end-of-line characters, except for ignorable whitespace, which is fired through the [IgnorableWhitespace](#officedocignorablewhitespace-event) event.

# [OfficeDoc](#officedoc-class).Comment Event

This event is fired when a comment section is encountered.

## Syntax

```text
officedoc.on('Comment', listener: (e: {readonly text: string}) => void )
```

## 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.

# [OfficeDoc](#officedoc-class).EndElement Event

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

## Syntax

```text
officedoc.on('EndElement', listener: (e: {readonly nameSpace: string, readonly element: string, readonly QName: string, readonly isEmpty: boolean}) => void )
```

## 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.

# [OfficeDoc](#officedoc-class).EndFile Event

Fired after each file is processed.

## Syntax

```text
officedoc.on('EndFile', listener: (e: {readonly index: number}) => void )
```

## 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 FilesCompressedName, FilesDecompressedName, FilesCompressedSize, and FilesDecompressedSize fields in the Files collection for this index contain more detailed information about the file processed.

# [OfficeDoc](#officedoc-class).EndPrefixMapping Event

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

## Syntax

```text
officedoc.on('EndPrefixMapping', listener: (e: {readonly prefix: string}) => void )
```

## Remarks

The [StartPrefixMapping](#officedocstartprefixmapping-event) event is fired when entering the scope of a namespace declaration.

# [OfficeDoc](#officedoc-class).Error Event

Fired when information is available about errors during data delivery.

## Syntax

```text
officedoc.on('Error', listener: (e: {readonly errorCode: number, readonly description: string}) => void )
```

## Remarks

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

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](#trappable-errors-class-ipworkszipofficedoc) section.

# [OfficeDoc](#officedoc-class).EvalEntity Event

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

## Syntax

```text
officedoc.on('EvalEntity', listener: (e: {readonly entity: string, value: string}) => void )
```

## 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 later be passed into the text stream.

# [OfficeDoc](#officedoc-class).IgnorableWhitespace Event

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

## Syntax

```text
officedoc.on('IgnorableWhitespace', listener: (e: {readonly text: string}) => void )
```

## Remarks

The ignorable whitespace section is provided by the *Text* parameter.

# [OfficeDoc](#officedoc-class).Meta Event

This event fires when a meta section is encountered.

## Syntax

```text
officedoc.on('Meta', listener: (e: {readonly text: string}) => void )
```

## 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.

# [OfficeDoc](#officedoc-class).Overwrite Event

Fired whenever a file exists and may be overwritten.

## Syntax

```text
officedoc.on('Overwrite', listener: (e: {fileName: string, overwrite: boolean}) => void )
```

## 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.

# [OfficeDoc](#officedoc-class).PI Event

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

## Syntax

```text
officedoc.on('PI', listener: (e: {readonly text: string}) => void )
```

## 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.

# [OfficeDoc](#officedoc-class).Progress Event

Fired as progress is made.

## Syntax

```text
officedoc.on('Progress', listener: (e: {readonly data: string, readonly dataB: Uint8Array, readonly fileName: string, readonly bytesProcessed: number, readonly percentProcessed: number}) => void )
```

## Remarks

The Progress event is automatically fired as compression or decompression is performed. When [WriteToProgressEvent](#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](#WriteToProgressEvent) is false, *Data* will contain null.

# [OfficeDoc](#officedoc-class).SpecialSection Event

This event is fired when a special section is encountered.

## Syntax

```text
officedoc.on('SpecialSection', listener: (e: {readonly sectionId: string, readonly text: string}) => void )
```

## 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*).

# [OfficeDoc](#officedoc-class).StartElement Event

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

## Syntax

```text
officedoc.on('StartElement', listener: (e: {readonly nameSpace: string, readonly element: string, readonly QName: string, readonly isEmpty: boolean}) => void )
```

## 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 XAttributesName, XAttributesNamespace, XAttributesPrefix, and XAttributesValue collection.

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

# [OfficeDoc](#officedoc-class).StartPrefixMapping Event

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

## Syntax

```text
officedoc.on('StartPrefixMapping', listener: (e: {readonly prefix: string, readonly URI: string}) => void )
```

## Remarks

The [EndPrefixMapping](#officedocendprefixmapping-event) 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.

The following fields are available:

- [IsOverride](#ContentType_f_IsOverride)

- [MediaType](#ContentType_f_MediaType)

- [Target](#ContentType_f_Target)

## Fields

 **IsOverride** *boolean (read-only)*
*Default Value: True*

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

 **MediaType** *string (read-only)*
*Default Value: ""*

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

 **Target** *string (read-only)*
*Default Value: ""*

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

## Constructors

```text
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.

The following fields are available:

- [DataType](#PackageProperty_f_DataType)

- [Name](#PackageProperty_f_Name)

- [Namespace](#PackageProperty_f_Namespace)

- [PropId](#PackageProperty_f_PropId)

- [PropSet](#PackageProperty_f_PropSet)

- [Value](#PackageProperty_f_Value)

## Fields

 **DataType** *string (read-only)*
*Default Value: ""*

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

 **Name** *string (read-only)*
*Default Value: ""*

The name of this property

 **Namespace** *string (read-only)*
*Default Value: ""*

The XML Namespace URI associated with this property. For custom properties, this will be an empty string.

 **PropId** *string (read-only)*
*Default Value: ""*

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

 **PropSet** *string (read-only)*
*Default Value: ""*

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

 **Value** *string (read-only)*
*Default Value: ""*

The value of this property

## Constructors

```text
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.

The following fields are available:

- [ContentType](#Relationship_f_ContentType)

- [Id](#Relationship_f_Id)

- [PartName](#Relationship_f_PartName)

- [TypeURI](#Relationship_f_TypeURI)

## Fields

 **ContentType** *string (read-only)*
*Default Value: ""*

The content type for the part referenced by this relationship, resolved from [Content_Types].xml according to the Open XML packaging specification rules.

 **Id** *string (read-only)*
*Default Value: ""*

The unique ID of this relationship within this .rels file

 **PartName** *string (read-only)*
*Default Value: ""*

The name of the part this relationship entry applies to.

 **TypeURI** *string (read-only)*
*Default Value: ""*

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

## Constructors

```text
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.

The following fields are available:

- [Name](#XMLAttribute_f_Name)

- [Namespace](#XMLAttribute_f_Namespace)

- [Prefix](#XMLAttribute_f_Prefix)

- [Value](#XMLAttribute_f_Value)

## Fields

 **Name** *string (read-only)*
*Default Value: ""*

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

 **Namespace** *string (read-only)*
*Default Value: ""*

This property contains the attribute namespace.

 **Prefix** *string (read-only)*
*Default Value: ""*

This property contains the attribute prefix (if any). If the attribute does not have a prefix, this property is empty.

 **Value** *string (read-only)*
*Default Value: ""*

This property contains the attribute value.

## Constructors

```text
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 , , and  of the given element.

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

The following fields are available:

- [Name](#XMLElement_f_Name)

- [Namespace](#XMLElement_f_Namespace)

- [Prefix](#XMLElement_f_Prefix)

- [XText](#XMLElement_f_XText)

## Fields

 **Name** *string (read-only)*
*Default Value: ""*

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

 **Namespace** *string (read-only)*
*Default Value: ""*

This property contains the namespace of the element.

 **Prefix** *string (read-only)*
*Default Value: ""*

This property contains the prefix of the element (if any). If the element does not have a prefix, this property is empty.

 **XText** *string (read-only)*
*Default Value: ""*

This property contains the inner text of the element.

## Constructors

```text
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  and the  of the namespace being defined.

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

The following fields are available:

- [Prefix](#XMLNamespace_f_Prefix)

- [URI](#XMLNamespace_f_URI)

## Fields

 **Prefix** *string*
*Default Value: ""*

This property contains the  for the namespace.

 **URI** *string*
*Default Value: ""*

This property contains the namespace URI associated with the corresponding . This URL is usually pointing to the XML schema for the namespace.

## Constructors

```text
public XMLNamespace();
```

```text
public XMLNamespace(String URI, String prefix);
```

# Config Settings (*class *ipworkszip.[officedoc](#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](#officedocconfig-method) method.

### OfficeDoc Config 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](#officedocpartname-property) property when retrieving the part. For example:

```text
/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](#officedocpartname-property) property for retrieving the part. For example, the above would become:

```text
/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](#officedocextractpart-method). This configuration option will return "1" if the relationship at index "x" of [Relationships](#officedocrelationships-property) is an external part. Otherwise it will return "0"

### Base Config 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:

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

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

|  |  |
| --- | --- |
| Identifier | Name |
| 1 | ASCII |
| 2 | NEXTSTEP |
| 3 | JapaneseEUC |
| 4 | UTF8 |
| 5 | ISOLatin1 |
| 6 | Symbol |
| 7 | NonLossyASCII |
| 8 | ShiftJIS |
| 9 | ISOLatin2 |
| 10 | Unicode |
| 11 | WindowsCP1251 |
| 12 | WindowsCP1252 |
| 13 | WindowsCP1253 |
| 14 | WindowsCP1254 |
| 15 | WindowsCP1250 |
| 21 | ISO2022JP |
| 30 | MacOSRoman |
| 10 | UTF16String |
| 0x90000100 | UTF16BigEndian |
| 0x94000100 | UTF16LittleEndian |
| 0x8c000100 | UTF32String |
| 0x98000100 | UTF32BigEndian |
| 0x9c000100 | UTF32LittleEndian |
| 65536 | Proprietary |

**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.

**MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*.

**UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to *true* tells the class to use the internal implementation instead of using the system security libraries.

 This setting is set to *false* by default on all platforms.

# Trappable Errors (*class *ipworkszip.[officedoc](#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](#officedocerror-event) 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. |