OfficeDoc Control

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

OfficeDoc

Remarks

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

Method List

---

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

Event List

---

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

Config Settings

---

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

ContentTypeCount Property (OfficeDoc Control)

The number of records in the ContentType arrays.

Syntax

officedoccontrol.ContentTypeCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• ContentTypeIsOverride
• ContentTypeMediaType
• ContentTypeTarget

The array indices start at 0 and end at ContentTypeCount - 1.

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

Data Type

Integer

ContentTypeIsOverride Property (OfficeDoc Control)

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

Syntax

officedoccontrol.ContentTypeIsOverride(ContentTypeIndex)

Default Value

True

Remarks

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

The ContentTypeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContentTypeCount property.

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

Data Type

Boolean

ContentTypeMediaType Property (OfficeDoc Control)

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

Syntax

officedoccontrol.ContentTypeMediaType(ContentTypeIndex)

Default Value

""

Remarks

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

The ContentTypeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContentTypeCount property.

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

Data Type

String

ContentTypeTarget Property (OfficeDoc Control)

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

Syntax

officedoccontrol.ContentTypeTarget(ContentTypeIndex)

Default Value

""

Remarks

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

The ContentTypeIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ContentTypeCount property.

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

Data Type

String

NamespaceCount Property (OfficeDoc Control)

The number of records in the Namespace arrays.

Syntax

officedoccontrol.NamespaceCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• NamespacePrefix
• NamespaceURI

The array indices start at 0 and end at NamespaceCount - 1.

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

Data Type

Integer

NamespacePrefix Property (OfficeDoc Control)

The Prefix for the Namespace .

Syntax

officedoccontrol.NamespacePrefix(NamespaceIndex)

Default Value

""

Remarks

The NamespacePrefix for the Namespace.

The NamespaceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the NamespaceCount property.

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

Data Type

String

NamespaceURI Property (OfficeDoc Control)

Namespace URI associated with the corresponding Prefix .

Syntax

officedoccontrol.NamespaceURI(NamespaceIndex)

Default Value

""

Remarks

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

The NamespaceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the NamespaceCount property.

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

Data Type

String

PackagePath Property (OfficeDoc Control)

The path to the Open XML package file.

Syntax

officedoccontrol.PackagePath[=string]

Default Value

""

Remarks

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

Data Type

String

PackagePropertyCount Property (OfficeDoc Control)

The number of records in the PackageProperty arrays.

Syntax

officedoccontrol.PackagePropertyCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• PackagePropertyDataType
• PackagePropertyName
• PackagePropertyNamespace
• PackagePropertyPropId
• PackagePropertyPropSet
• PackagePropertyValue

The array indices start at 0 and end at PackagePropertyCount - 1.

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

Data Type

Integer

PackagePropertyDataType Property (OfficeDoc Control)

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

Syntax

officedoccontrol.PackagePropertyDataType(PackagePropertyIndex)

Default Value

""

Remarks

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

The PackagePropertyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PackagePropertyCount property.

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

Data Type

String

PackagePropertyName Property (OfficeDoc Control)

The name of this property.

Syntax

officedoccontrol.PackagePropertyName(PackagePropertyIndex)

Default Value

""

Remarks

The name of this property

The PackagePropertyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PackagePropertyCount property.

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

Data Type

String

PackagePropertyNamespace Property (OfficeDoc Control)

The XML Namespace URI associated with this property.

Syntax

officedoccontrol.PackagePropertyNamespace(PackagePropertyIndex)

Default Value

""

Remarks

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

The PackagePropertyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PackagePropertyCount property.

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

Data Type

String

PackagePropertyPropId Property (OfficeDoc Control)

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

Syntax

officedoccontrol.PackagePropertyPropId(PackagePropertyIndex)

Default Value

""

Remarks

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

The PackagePropertyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PackagePropertyCount property.

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

Data Type

String

PackagePropertyPropSet Property (OfficeDoc Control)

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

Syntax

officedoccontrol.PackagePropertyPropSet(PackagePropertyIndex)

Default Value

""

Remarks

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

The PackagePropertyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PackagePropertyCount property.

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

Data Type

String

PackagePropertyValue Property (OfficeDoc Control)

The value of this property.

Syntax

officedoccontrol.PackagePropertyValue(PackagePropertyIndex)

Default Value

""

Remarks

The value of this property

The PackagePropertyIndex parameter specifies the index of the item in the array. The size of the array is controlled by the PackagePropertyCount property.

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

Data Type

String

PartData Property (OfficeDoc Control)

The contents of the currently selected part.

Syntax

officedoccontrol.PartData[=string]

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.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .PartDataB.

Data Type

Binary String

PartName Property (OfficeDoc Control)

The name of the currently selected part.

Syntax

officedoccontrol.PartName[=string]

Default Value

""

Remarks

This property specifies the name of the currently selected part in the document. If null or empty, no part is currently selected.

Data Type

String

RelationshipCount Property (OfficeDoc Control)

The number of records in the Relationship arrays.

Syntax

officedoccontrol.RelationshipCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• RelationshipContentType
• RelationshipId
• RelationshipPartName
• RelationshipTypeURI

The array indices start at 0 and end at RelationshipCount - 1.

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

Data Type

Integer

RelationshipContentType Property (OfficeDoc Control)

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

Syntax

officedoccontrol.RelationshipContentType(RelationshipIndex)

Default Value

""

Remarks

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

The RelationshipIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RelationshipCount property.

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

Data Type

String

RelationshipId Property (OfficeDoc Control)

The unique ID of this relationship within this .

Syntax

officedoccontrol.RelationshipId(RelationshipIndex)

Default Value

""

Remarks

The unique ID of this relationship within this .rels file

The RelationshipIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RelationshipCount property.

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

Data Type

String

RelationshipPartName Property (OfficeDoc Control)

The name of the part this relationship entry applies to.

Syntax

officedoccontrol.RelationshipPartName(RelationshipIndex)

Default Value

""

Remarks

The name of the part this relationship entry applies to.

The RelationshipIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RelationshipCount property.

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

Data Type

String

RelationshipTypeURI Property (OfficeDoc Control)

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

Syntax

officedoccontrol.RelationshipTypeURI(RelationshipIndex)

Default Value

""

Remarks

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

The RelationshipIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RelationshipCount property.

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

Data Type

String

Validate Property (OfficeDoc Control)

This property controls whether documents are validated during parsing.

Syntax

officedoccontrol.Validate[=boolean]

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.

Data Type

Boolean

AttrCount Property (OfficeDoc Control)

The number of records in the Attr arrays.

Syntax

officedoccontrol.AttrCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• AttrName
• AttrNamespace
• AttrPrefix
• AttrValue

The array indices start at 0 and end at AttrCount - 1.

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

Data Type

Integer

AttrName Property (OfficeDoc Control)

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

Syntax

officedoccontrol.AttrName(AttrIndex)

Default Value

""

Remarks

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

The AttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrCount property.

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

Data Type

String

AttrNamespace Property (OfficeDoc Control)

Attribute namespace.

Syntax

officedoccontrol.AttrNamespace(AttrIndex)

Default Value

""

Remarks

Attribute namespace.

The AttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrCount property.

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

Data Type

String

AttrPrefix Property (OfficeDoc Control)

Attribute prefix (if any).

Syntax

officedoccontrol.AttrPrefix(AttrIndex)

Default Value

""

Remarks

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

The AttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrCount property.

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

Data Type

String

AttrValue Property (OfficeDoc Control)

Attribute value.

Syntax

officedoccontrol.AttrValue(AttrIndex)

Default Value

""

Remarks

Attribute value.

The AttrIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrCount property.

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

Data Type

String

XChildCount Property (OfficeDoc Control)

The number of records in the XChild arrays.

Syntax

officedoccontrol.XChildCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• XChildName
• XChildNamespace
• XChildPrefix
• XChildXText

The array indices start at 0 and end at XChildCount - 1.

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

Data Type

Integer

XChildName Property (OfficeDoc Control)

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

Syntax

officedoccontrol.XChildName(XChildIndex)

Default Value

""

Remarks

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

The XChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the XChildCount property.

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

Data Type

String

XChildNamespace Property (OfficeDoc Control)

Namespace of the element.

Syntax

officedoccontrol.XChildNamespace(XChildIndex)

Default Value

""

Remarks

Namespace of the element.

The XChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the XChildCount property.

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

Data Type

String

XChildPrefix Property (OfficeDoc Control)

Prefix of the element (if any).

Syntax

officedoccontrol.XChildPrefix(XChildIndex)

Default Value

""

Remarks

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

The XChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the XChildCount property.

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

Data Type

String

XChildXText Property (OfficeDoc Control)

The inner text of the element.

Syntax

officedoccontrol.XChildXText(XChildIndex)

Default Value

""

Remarks

The inner text of the element.

The XChildIndex parameter specifies the index of the item in the array. The size of the array is controlled by the XChildCount property.

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

Data Type

String

XElement Property (OfficeDoc Control)

The name of the current element.

Syntax

officedoccontrol.XElement

Default Value

""

Remarks

The current element is specified via the XPath property.

This property is read-only.

Data Type

String

XNamespace Property (OfficeDoc Control)

The namespace of the current element.

Syntax

officedoccontrol.XNamespace

Default Value

""

Remarks

The current element is specified via the XPath property.

This property is read-only.

Data Type

String

XParent Property (OfficeDoc Control)

The parent of the current element.

Syntax

officedoccontrol.XParent

Default Value

""

Remarks

The current element is specified via the XPath property.

This property is read-only.

Data Type

String

XPath Property (OfficeDoc Control)

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

Syntax

officedoccontrol.XPath[=string]

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, XChildName, XChildNamespace, XChildPrefix, XChildXText, and XText providing other properties of the element. The attributes of the current element are provided in the AttrName, AttrNamespace, AttrPrefix, and AttrValue properties.

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

Example (Setting XPath):

Data Type

String

XPrefix Property (OfficeDoc Control)

The prefix of the current element.

Syntax

officedoccontrol.XPrefix

Default Value

""

Remarks

The current element is specified via the XPath property.

This property is read-only.

Data Type

String

XSubTree Property (OfficeDoc Control)

A snapshot of the current element in the document.

Syntax

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

Data Type

String

XText Property (OfficeDoc Control)

The text of the current element.

Syntax

officedoccontrol.XText

Default Value

""

Remarks

The current element is specified via the XPath property.

This property is read-only.

Data Type

String

Close Method (OfficeDoc Control)

Closes the Open XML package archive.

Syntax

officedoccontrol.Close 

Remarks

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

Config Method (OfficeDoc Control)

Sets or retrieves a configuration setting.

Syntax

officedoccontrol.Config ConfigurationString

Remarks

Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, 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 Control)

Reads the contents of the currently selected part.

Syntax

officedoccontrol.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 Control)

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

Syntax

officedoccontrol.FindPartByType TypeURI

Remarks

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

GetPropertyValue Method (OfficeDoc Control)

Returns the value of the specified package property.

Syntax

officedoccontrol.GetPropertyValue PropName, PropNamespace

Remarks

Looks up a package property named PropName in namespace PropNamespace in the core and app properties tables and returns it's value, if found.

If the property doesn't exists, an empty string is returned.

For custom properties. use an empty string ("") as the value of the PropNamespace parameter.

ListParts Method (OfficeDoc Control)

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

Syntax

officedoccontrol.ListParts 

Remarks

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

Open Method (OfficeDoc Control)

Opens the Open XML package archive.

Syntax

officedoccontrol.Open 

Remarks

When this method is called, the control 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 Control)

Parses the specified part as XML.

Syntax

officedoccontrol.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 Control)

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

Syntax

officedoccontrol.ReadRelationships 

Remarks

When this method is called, the control 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 Control)

Replaces the contents of the specified part in the package.

Syntax

officedoccontrol.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 Control)

Resets the control.

Syntax

officedoccontrol.Reset 

Remarks

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

ResolveContentType Method (OfficeDoc Control)

Returns the content type of the specified part.

Syntax

officedoccontrol.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 Control)

Fired before each file is processed.

Syntax

Sub officedoccontrol_BeginFile(Index As Integer, Skip As Boolean)

Remarks

BeginFile is fired before each file is processed by the compressor or decompressor, as appropriate. Index contains the array index of the file about to be processed, and the FileCompressedName, FileDecompressedName, FileCompressedSize (decompression only), and FileDecompressedSize fields of the Files collection for this index contain more detailed information about the file about to be processed.

When extracting, an alternate location may be specified by trapping the event, and modifying FileDecompressedName and/or ExtractToPath. If FileDecompressedName is set to an empty string, the file will not be written to disk. If WriteToProgressEvent is true, the file will still be decompressed, and the data may be extracted through the Progress event.

This event may also be trapped while compressing. FileCompressedName and FileDecompressedName may be changed.

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

Characters Event (OfficeDoc Control)

Fired for plain text segments of the input stream.

Syntax

Sub officedoccontrol_Characters(Text As String)

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

Fired when a comment section is encountered.

Syntax

Sub officedoccontrol_Comment(Text As String)

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

Fired when an end-element tag is encountered.

Syntax

Sub officedoccontrol_EndElement(Namespace As String, Element As String, QName As String, IsEmpty As Boolean)

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

Fired after each file is processed.

Syntax

Sub officedoccontrol_EndFile(Index As Integer)

Remarks

EndFile is fired after each file is processed by the compressor or decompressor, as appropriate. Index contains the array index of the file processed, and the FileCompressedName, FileDecompressedName, FileCompressedSize, and FileDecompressedSize fields in the Files collection for this index contain more detailed information about the file processed.

EndPrefixMapping Event (OfficeDoc Control)

Fired when leaving the scope of a namespace declaration.

Syntax

Sub officedoccontrol_EndPrefixMapping(Prefix As String)

Remarks

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

Error Event (OfficeDoc Control)

Information about errors during data delivery.

Syntax

Sub officedoccontrol_Error(ErrorCode As Integer, Description As String)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the control fails with an error.

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

Fired every time an entity needs to be evaluated.

Syntax

Sub officedoccontrol_EvalEntity(Entity As String, Value As String)

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

Fired when a section of ignorable whitespace is encountered.

Syntax

Sub officedoccontrol_IgnorableWhitespace(Text As String)

Remarks

The ignorable whitespace section is provided by the Text parameter.

Meta Event (OfficeDoc Control)

Fired when a meta section is encountered.

Syntax

Sub officedoccontrol_Meta(Text As String)

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

Fired whenever a file exists and may be overwritten.

Syntax

Sub officedoccontrol_Overwrite(Filename As String, Overwrite As Boolean)

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 control, 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 Control)

Fired when a processing instruction section is encountered.

Syntax

Sub officedoccontrol_PI(Text As String)

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

Fired as progress is made.

Syntax

Sub officedoccontrol_Progress(Data As String, Filename As String, BytesProcessed As Long64, PercentProcessed As Integer)

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

Fired when a special section is encountered.

Syntax

Sub officedoccontrol_SpecialSection(SectionId As String, Text As String)

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

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

Syntax

Sub officedoccontrol_StartElement(Namespace As String, Element As String, QName As String, IsEmpty As Boolean)

Remarks

The StartElement event is fired when a begin-element tag is found in the document.

The element name is provided through the Element parameter. The attribute names and values (if any) are provided through the AttrName, AttrNamespace, AttrPrefix, and AttrValue properties.

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

StartPrefixMapping Event (OfficeDoc Control)

Fired when entering the scope of a namespace declaration.

Syntax

Sub officedoccontrol_StartPrefixMapping(Prefix As String, URI As String)

Remarks

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

Config Settings (OfficeDoc Control)

The control 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 control, access to these internal properties is provided through the Config method.

OfficeDoc Config Settings

Base Config Settings

Trappable Errors (OfficeDoc Control)

Errors

The following errors may be generated by the control. 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 control to continue operation even in case of error.

OfficeDoc Errors

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