OfficeDoc Module

Properties   Methods   Events   Config Settings   Errors  

The OfficeDoc module 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 module with short descriptions. Click on the links for further details.

ContentTypesCollection of content type entries.
NamespacesCollection of namespaces in the current namespace stack.
PackagePathThe path to the Open XML package file.
PackagePropertiesCollection of core/app/custom metadata properties associated with the archive.
PartDataThe contents of the currently selected part.
PartNameThe name of the currently selected part.
RelationshipsCollection of Relationships in the current relationships (*.rels) file.
ValidateThis property controls whether documents are validated during parsing.
XAttributesA collection of attributes of the current element.
XChildrenCollection of child elements of the current 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 module 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 module.
ResolveContentTypeReturns the content type of the specified part.

Event List


The following is the full list of the events fired by the module 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.

Config Settings


The following is a list of config settings for the module 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.
MaskSensitiveWhether sensitive data is masked in log messages.
UseInternalSecurityAPITells the module whether or not to use the system security libraries or an internal implementation.

ContentTypes Property (OfficeDoc Module)

Collection of content type entries.

Syntax

public var contentTypes: Array<ContentType> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=contentTypeCount) int contentTypeCount;

- (int)contentTypeCount;

- (BOOL)contentTypeIsOverride:(int)contentTypeIndex;

- (NSString*)contentTypeMediaType:(int)contentTypeIndex;

- (NSString*)contentTypeTarget:(int)contentTypeIndex;

Default Value

""

Remarks

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

This property is read-only.

Namespaces Property (OfficeDoc Module)

Collection of namespaces in the current namespace stack.

Syntax

public var namespaces: Array<XMLNamespace> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=namespaceCount) int namespaceCount;

- (int)namespaceCount;

- (NSString*)namespacePrefix:(int)namespaceIndex;

- (NSString*)namespaceURI:(int)namespaceIndex;

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.

PackagePath Property (OfficeDoc Module)

The path to the Open XML package file.

Syntax

public var packagePath: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=packagePath,setter=setPackagePath:) NSString* packagePath;

- (NSString*)packagePath;
- (void)setPackagePath :(NSString*)newPackagePath;

Default Value

""

Remarks

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

PackageProperties Property (OfficeDoc Module)

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

Syntax

public var packageProperties: Array<PackageProperty> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=packagePropertyCount) int packagePropertyCount;

- (int)packagePropertyCount;

- (NSString*)packagePropertyDataType:(int)packagePropertyIndex;

- (NSString*)packagePropertyName:(int)packagePropertyIndex;

- (NSString*)packagePropertyNamespace:(int)packagePropertyIndex;

- (NSString*)packagePropertyPropId:(int)packagePropertyIndex;

- (NSString*)packagePropertyPropSet:(int)packagePropertyIndex;

- (NSString*)packagePropertyValue:(int)packagePropertyIndex;

Default Value

""

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.

PartData Property (OfficeDoc Module)

The contents of the currently selected part.

Syntax

public var partData: String {
  get {...}
  set {...}
}

public var partDataB: Data { get {...} set {...} }

@property (nonatomic,readwrite,assign,getter=partData,setter=setPartData:) NSString* partData;

- (NSString*)partData;
- (void)setPartData :(NSString*)newPartData;

@property (nonatomic,readwrite,assign,getter=partDataB,setter=setPartDataB:) NSData* partDataB;

- (NSData*)partDataB;
- (void)setPartDataB :(NSData*)newPartData;

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 Module)

The name of the currently selected part.

Syntax

public var partName: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=partName,setter=setPartName:) NSString* partName;

- (NSString*)partName;
- (void)setPartName :(NSString*)newPartName;

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 Module)

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

Syntax

public var relationships: Array<Relationship> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=relationshipCount) int relationshipCount;

- (int)relationshipCount;

- (NSString*)relationshipContentType:(int)relationshipIndex;

- (NSString*)relationshipId:(int)relationshipIndex;

- (NSString*)relationshipPartName:(int)relationshipIndex;

- (NSString*)relationshipTypeURI:(int)relationshipIndex;

Default Value

""

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.

Validate Property (OfficeDoc Module)

This property controls whether documents are validated during parsing.

Syntax

public var validate: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=validate,setter=setValidate:) BOOL validate;

- (BOOL)validate;
- (void)setValidate :(BOOL)newValidate;

Default Value

True

Remarks

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

XAttributes Property (OfficeDoc Module)

A collection of attributes of the current element.

Syntax

public var xAttributes: Array<XMLAttribute> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=attrCount) int attrCount;

- (int)attrCount;

- (NSString*)attrName:(int)attrIndex;

- (NSString*)attrNamespace:(int)attrIndex;

- (NSString*)attrPrefix:(int)attrIndex;

- (NSString*)attrValue:(int)attrIndex;

Default Value

""

Remarks

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

This property is read-only.

XChildren Property (OfficeDoc Module)

Collection of child elements of the current element.

Syntax

public var xChildren: Array<XMLElement> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=XChildCount) int XChildCount;

- (int)XChildCount;

- (NSString*)XChildName:(int)xChildIndex;

- (NSString*)XChildNamespace:(int)xChildIndex;

- (NSString*)XChildPrefix:(int)xChildIndex;

- (NSString*)XChildXText:(int)xChildIndex;

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.

XElement Property (OfficeDoc Module)

The name of the current element.

Syntax

public var xElement: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=XElement) NSString* XElement;

- (NSString*)XElement;

Default Value

""

Remarks

The current element is specified via the XPath property.

This property is read-only.

XNamespace Property (OfficeDoc Module)

The namespace of the current element.

Syntax

public var xNamespace: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=XNamespace) NSString* XNamespace;

- (NSString*)XNamespace;

Default Value

""

Remarks

The current element is specified via the XPath property.

This property is read-only.

XParent Property (OfficeDoc Module)

The parent of the current element.

Syntax

public var xParent: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=XParent) NSString* XParent;

- (NSString*)XParent;

Default Value

""

Remarks

The current element is specified via the XPath property.

This property is read-only.

XPath Property (OfficeDoc Module)

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

Syntax

public var xPath: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=XPath,setter=setXPath:) NSString* XPath;

- (NSString*)XPath;
- (void)setXPath :(NSString*)newXPath;

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, XChildrenName, XChildrenNamespace, XChildrenPrefix, XChildrenXText, and XText providing other properties of the element. The attributes of the current element are provided in the XAttributesName, XAttributesNamespace, XAttributesPrefix, and XAttributesValue 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]"

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setXPath(xPath: String) throws

XPrefix Property (OfficeDoc Module)

The prefix of the current element.

Syntax

public var xPrefix: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=XPrefix) NSString* XPrefix;

- (NSString*)XPrefix;

Default Value

""

Remarks

The current element is specified via the XPath property.

This property is read-only.

XSubTree Property (OfficeDoc Module)

A snapshot of the current element in the document.

Syntax

public var xSubTree: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=XSubTree) NSString* XSubTree;

- (NSString*)XSubTree;

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.

XText Property (OfficeDoc Module)

The text of the current element.

Syntax

public var xText: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=XText) NSString* XText;

- (NSString*)XText;

Default Value

""

Remarks

The current element is specified via the XPath property.

This property is read-only.

Close Method (OfficeDoc Module)

Closes the Open XML package archive.

Syntax

public func close() throws -> Void
- (void)close;

Remarks

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

Config Method (OfficeDoc Module)

Sets or retrieves a configuration setting.

Syntax

public func config(configurationString: String) throws -> String
- (NSString*)config:(NSString*)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 Module)

Reads the contents of the currently selected part.

Syntax

public func extractPart() throws -> Void
- (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 Module)

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

Syntax

public func findPartByType(typeURI: String) throws -> String
- (NSString*)findPartByType:(NSString*)typeURI;

Remarks

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

GetPropertyValue Method (OfficeDoc Module)

Returns the value of the specified package property.

Syntax

public func getPropertyValue(propName: String, propNamespace: String) throws -> String
- (NSString*)getPropertyValue:(NSString*)propName :(NSString*)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 Module)

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

Syntax

public func listParts() throws -> Void
- (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 Module)

Opens the Open XML package archive.

Syntax

public func open() throws -> Void
- (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 Module)

Parses the specified part as XML.

Syntax

public func parsePart() throws -> Void
- (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 Module)

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

Syntax

public func readRelationships() throws -> Void
- (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 Module)

Replaces the contents of the specified part in the package.

Syntax

public func replacePart() throws -> Void
- (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 Module)

Resets the component.

Syntax

public func reset() throws -> Void
- (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 Module)

Returns the content type of the specified part.

Syntax

public func resolveContentType() throws -> String
- (NSString*)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 Module)

Fired before each file is processed.

Syntax

func onBeginFile(index: Int32, skip: inout Bool)
- (void)onBeginFile:(int)index :(int*)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 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 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. 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.

Characters Event (OfficeDoc Module)

Fired for plain text segments of the input stream.

Syntax

func onCharacters(text: String)
- (void)onCharacters:(NSString*)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 (OfficeDoc Module)

Fired when a comment section is encountered.

Syntax

func onComment(text: String)
- (void)onComment:(NSString*)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 Module)

Fired when an end-element tag is encountered.

Syntax

func onEndElement(namespace: String, element: String, qName: String, isEmpty: Bool)
- (void)onEndElement:(NSString*)namespace :(NSString*)element :(NSString*)QName :(BOOL)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 (OfficeDoc Module)

Fired after each file is processed.

Syntax

func onEndFile(index: Int32)
- (void)onEndFile:(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 FilesCompressedName, FilesDecompressedName, FilesCompressedSize, and FilesDecompressedSize fields in the Files collection for this index contain more detailed information about the file processed.

EndPrefixMapping Event (OfficeDoc Module)

Fired when leaving the scope of a namespace declaration.

Syntax

func onEndPrefixMapping(prefix: String)
- (void)onEndPrefixMapping:(NSString*)prefix;

Remarks

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

Error Event (OfficeDoc Module)

Information about errors during data delivery.

Syntax

func onError(errorCode: Int32, description: String)
- (void)onError:(int)errorCode :(NSString*)description;

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

EvalEntity Event (OfficeDoc Module)

Fired every time an entity needs to be evaluated.

Syntax

func onEvalEntity(entity: String, value: inout String)
- (void)onEvalEntity:(NSString*)entity :(NSString**)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 (OfficeDoc Module)

Fired when a section of ignorable whitespace is encountered.

Syntax

func onIgnorableWhitespace(text: String)
- (void)onIgnorableWhitespace:(NSString*)text;

Remarks

The ignorable whitespace section is provided by the Text parameter.

Meta Event (OfficeDoc Module)

Fired when a meta section is encountered.

Syntax

func onMeta(text: String)
- (void)onMeta:(NSString*)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 Module)

Fired whenever a file exists and may be overwritten.

Syntax

func onOverwrite(filename: inout String, overwrite: inout Bool)
- (void)onOverwrite:(NSString**)filename :(int*)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 (OfficeDoc Module)

Fired when a processing instruction section is encountered.

Syntax

func onPI(text: String)
- (void)onPI:(NSString*)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 Module)

Fired as progress is made.

Syntax

func onProgress(data: Data, filename: String, bytesProcessed: Int64, percentProcessed: Int32)
- (void)onProgress:(NSData*)data :(NSString*)filename :(long long)bytesProcessed :(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 Module)

Fired when a special section is encountered.

Syntax

func onSpecialSection(sectionId: String, text: String)
- (void)onSpecialSection:(NSString*)sectionId :(NSString*)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 (OfficeDoc Module)

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

Syntax

func onStartElement(namespace: String, element: String, qName: String, isEmpty: Bool)
- (void)onStartElement:(NSString*)namespace :(NSString*)element :(NSString*)QName :(BOOL)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 XAttributesName, XAttributesNamespace, XAttributesPrefix, and XAttributesValue properties.

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

StartPrefixMapping Event (OfficeDoc Module)

Fired when entering the scope of a namespace declaration.

Syntax

func onStartPrefixMapping(prefix: String, uri: String)
- (void)onStartPrefixMapping:(NSString*)prefix :(NSString*)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

isOverride
Bool (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

public init()

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

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

public init()

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

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

public init()

XMLAttribute Type

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

name
String (read-only)

Default Value: ""

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

namespace
String (read-only)

Default Value: ""

Attribute namespace.

prefix
String (read-only)

Default Value: ""

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

value
String (read-only)

Default Value: ""

Attribute value.

Constructors

public init()

XMLElement Type

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.

Fields

name
String (read-only)

Default Value: ""

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

namespace
String (read-only)

Default Value: ""

Namespace of the element.

prefix
String (read-only)

Default Value: ""

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

xText
String (read-only)

Default Value: ""

The inner text of the element.

Constructors

public init()

XMLNamespace Type

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.

Fields

prefix
String

Default Value: ""

The for the .

uri
String

Default Value: ""

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

Constructors

public init()
public init(name: , prefix: )

Config Settings (OfficeDoc Module)

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

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 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:

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.
MaskSensitive:   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 to mask sensitive data. The default is .

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseInternalSecurityAPI:   Whether or not to use the system security libraries or an internal implementation.

When set to , the class will use the system security libraries by default to perform cryptographic functions where applicable.

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

This setting is set to by default on all platforms.

Trappable Errors (OfficeDoc Module)

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.