OfficeDoc Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

nsoftware.IPWorksZip.Officedoc

Remarks

The component 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 component 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 component 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 component.
ResolveContentTypeReturns the content type of the specified part.

Event List

The following is the full list of the events fired by the component 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 component 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.
GUIAvailableTells the component whether or not a message loop is available for processing events.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
UseInternalSecurityAPITells the component whether or not to use the system security libraries or an internal implementation.

ContentTypes Property (OfficeDoc Component)

Collection of content type entries

Syntax

public ContentTypeList ContentTypes { get; }

Public ReadOnly Property ContentTypes As ContentTypeList

Remarks

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

This property is read-only.

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

Namespaces Property (OfficeDoc Component)

Collection of namespaces in the current namespace stack.

Syntax

public XMLNamespaceList Namespaces { get; }

Public ReadOnly Property Namespaces As XMLNamespaceList

Remarks

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

This collection is indexed from 0 to count -1.

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

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

PackagePath Property (OfficeDoc Component)

The path to the Open XML package file

Syntax

public string PackagePath { get; set; }

Public Property PackagePath As String

Default Value

""

Remarks

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

PackageProperties Property (OfficeDoc Component)

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

Syntax

public PackagePropertyList PackageProperties { get; }

Public ReadOnly Property PackageProperties As PackagePropertyList

Remarks

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

This property is read-only.

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

PartData Property (OfficeDoc Component)

The contents of the currently selected part.

Syntax

public string PartData { get; set; }
public byte[] PartDataB { get; set; }

Public Property PartData As String
Public Property PartDataB As Byte()

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

The name of the currently selected part

Syntax

public string PartName { get; set; }

Public Property PartName As 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.

Relationships Property (OfficeDoc Component)

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

Syntax

public RelationshipList Relationships { get; }

Public ReadOnly Property Relationships As RelationshipList

Remarks

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

This property is read-only.

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

Validate Property (OfficeDoc Component)

This property controls whether documents are validated during parsing.

Syntax

public bool Validate { get; set; }

Public Property Validate As Boolean

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 where data can still be parsed even if the document is not well-formed.

XAttributes Property (OfficeDoc Component)

A collection of attributes of the current element.

Syntax

public XMLAttributeList XAttributes { get; }

Public ReadOnly Property XAttributes As XMLAttributeList

Remarks

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

This collection is indexed from 0 to count -1.

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

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

XChildren Property (OfficeDoc Component)

Collection of child elements of the current element.

Syntax

public XMLElementList XChildren { get; }

Public ReadOnly Property XChildren As XMLElementList

Remarks

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

This collection is indexed from 0 to count -1.

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

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

XElement Property (OfficeDoc Component)

The name of the current element.

Syntax

public string XElement { get; }

Public ReadOnly Property XElement As String

Default Value

""

Remarks

The current element is specified via the XPath property.

This property is read-only.

XNamespace Property (OfficeDoc Component)

The namespace of the current element.

Syntax

public string XNamespace { get; }

Public ReadOnly Property XNamespace As String

Default Value

""

Remarks

The current element is specified via the XPath property.

This property is read-only.

XParent Property (OfficeDoc Component)

The parent of the current element.

Syntax

public string XParent { get; }

Public ReadOnly Property XParent As String

Default Value

""

Remarks

The current element is specified via the XPath property.

This property is read-only.

XPath Property (OfficeDoc Component)

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

Syntax

public string XPath { get; set; }

Public Property XPath As 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:

'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, XChildren , and XText providing other properties of the element. The attributes of the current element are provided in the XAttributes collection.

BuildDOM must be set to True 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]"

XPrefix Property (OfficeDoc Component)

The prefix of the current element.

Syntax

public string XPrefix { get; }

Public ReadOnly Property XPrefix As String

Default Value

""

Remarks

The current element is specified via the XPath property.

This property is read-only.

XSubTree Property (OfficeDoc Component)

A snapshot of the current element in the document.

Syntax

public string XSubTree { get; }

Public ReadOnly Property XSubTree As String

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

The text of the current element.

Syntax

public string XText { get; }

Public ReadOnly Property XText As String

Default Value

""

Remarks

The current element is specified via the XPath property.

This property is read-only.

Close Method (OfficeDoc Component)

Closes the Open XML package archive

Syntax

public void Close();

Async Version
public async Task Close();
public async Task Close(CancellationToken cancellationToken);

Public Sub Close()

Async Version
Public Sub Close() As Task
Public Sub Close(cancellationToken As CancellationToken) As Task

Remarks

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

Config Method (OfficeDoc Component)

Sets or retrieves a configuration setting.

Syntax

public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);

Public Function Config(ByVal ConfigurationString As String) As String

Async Version
Public Function Config(ByVal ConfigurationString As String) As Task(Of String)
Public Function Config(ByVal ConfigurationString As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

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

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

Reads the contents of the currently selected part.

Syntax

public void ExtractPart();

Async Version
public async Task ExtractPart();
public async Task ExtractPart(CancellationToken cancellationToken);

Public Sub ExtractPart()

Async Version
Public Sub ExtractPart() As Task
Public Sub ExtractPart(cancellationToken As CancellationToken) As Task

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

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

Syntax

public string FindPartByType(string typeURI);

Async Version
public async Task<string> FindPartByType(string typeURI);
public async Task<string> FindPartByType(string typeURI, CancellationToken cancellationToken);

Public Function FindPartByType(ByVal TypeURI As String) As String

Async Version
Public Function FindPartByType(ByVal TypeURI As String) As Task(Of String)
Public Function FindPartByType(ByVal TypeURI As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

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

GetPropertyValue Method (OfficeDoc Component)

Returns the value of the specified package property.

Syntax

public string GetPropertyValue(string propName, string propNamespace);

Async Version
public async Task<string> GetPropertyValue(string propName, string propNamespace);
public async Task<string> GetPropertyValue(string propName, string propNamespace, CancellationToken cancellationToken);

Public Function GetPropertyValue(ByVal PropName As String, ByVal PropNamespace As String) As String

Async Version
Public Function GetPropertyValue(ByVal PropName As String, ByVal PropNamespace As String) As Task(Of String)
Public Function GetPropertyValue(ByVal PropName As String, ByVal PropNamespace As String, cancellationToken As CancellationToken) As Task(Of 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.

ListParts Method (OfficeDoc Component)

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

Syntax

public void ListParts();

Async Version
public async Task ListParts();
public async Task ListParts(CancellationToken cancellationToken);

Public Sub ListParts()

Async Version
Public Sub ListParts() As Task
Public Sub ListParts(cancellationToken As CancellationToken) As Task

Remarks

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

Open Method (OfficeDoc Component)

Opens the Open XML package archive

Syntax

public void Open();

Async Version
public async Task Open();
public async Task Open(CancellationToken cancellationToken);

Public Sub Open()

Async Version
Public Sub Open() As Task
Public Sub Open(cancellationToken As CancellationToken) As Task

Remarks

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

Parses the specified part as XML.

Syntax

public void ParsePart();

Async Version
public async Task ParsePart();
public async Task ParsePart(CancellationToken cancellationToken);

Public Sub ParsePart()

Async Version
Public Sub ParsePart() As Task
Public Sub ParsePart(cancellationToken As CancellationToken) As Task

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

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

Syntax

public void ReadRelationships();

Async Version
public async Task ReadRelationships();
public async Task ReadRelationships(CancellationToken cancellationToken);

Public Sub ReadRelationships()

Async Version
Public Sub ReadRelationships() As Task
Public Sub ReadRelationships(cancellationToken As CancellationToken) As Task

Remarks

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

Replaces the contents of the specified part in the package.

Syntax

public void ReplacePart();

Async Version
public async Task ReplacePart();
public async Task ReplacePart(CancellationToken cancellationToken);

Public Sub ReplacePart()

Async Version
Public Sub ReplacePart() As Task
Public Sub ReplacePart(cancellationToken As CancellationToken) As Task

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

Resets the component.

Syntax

public void Reset();

Async Version
public async Task Reset();
public async Task Reset(CancellationToken cancellationToken);

Public Sub Reset()

Async Version
Public Sub Reset() As Task
Public Sub Reset(cancellationToken As CancellationToken) As Task

Remarks

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

ResolveContentType Method (OfficeDoc Component)

Returns the content type of the specified part.

Syntax

public string ResolveContentType();

Async Version
public async Task<string> ResolveContentType();
public async Task<string> ResolveContentType(CancellationToken cancellationToken);

Public Function ResolveContentType() As String

Async Version
Public Function ResolveContentType() As Task(Of String)
Public Function ResolveContentType(cancellationToken As CancellationToken) As Task(Of String)

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

Fired before each file is processed.

Syntax

public event OnBeginFileHandler OnBeginFile;

public delegate void OnBeginFileHandler(object sender, OfficedocBeginFileEventArgs e);

public class OfficedocBeginFileEventArgs : EventArgs {
  public int Index { get; }
  public bool Skip { get; set; }
}

Public Event OnBeginFile As OnBeginFileHandler

Public Delegate Sub OnBeginFileHandler(sender As Object, e As OfficedocBeginFileEventArgs)

Public Class OfficedocBeginFileEventArgs Inherits EventArgs
  Public ReadOnly Property Index As Integer
  Public Property Skip As Boolean
End Class

Remarks

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

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

This event may also be trapped while compressing. CompressedName and DecompressedName may be changed.

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

Characters Event (OfficeDoc Component)

Fired for plain text segments of the input stream.

Syntax

public event OnCharactersHandler OnCharacters;

public delegate void OnCharactersHandler(object sender, OfficedocCharactersEventArgs e);

public class OfficedocCharactersEventArgs : EventArgs {
  public string Text { get; }
}

Public Event OnCharacters As OnCharactersHandler

Public Delegate Sub OnCharactersHandler(sender As Object, e As OfficedocCharactersEventArgs)

Public Class OfficedocCharactersEventArgs Inherits EventArgs
  Public ReadOnly Property Text As String
End Class

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

Fired when a comment section is encountered.

Syntax

public event OnCommentHandler OnComment;

public delegate void OnCommentHandler(object sender, OfficedocCommentEventArgs e);

public class OfficedocCommentEventArgs : EventArgs {
  public string Text { get; }
}

Public Event OnComment As OnCommentHandler

Public Delegate Sub OnCommentHandler(sender As Object, e As OfficedocCommentEventArgs)

Public Class OfficedocCommentEventArgs Inherits EventArgs
  Public ReadOnly Property Text As String
End Class

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

Fired when an end-element tag is encountered.

Syntax

public event OnEndElementHandler OnEndElement;

public delegate void OnEndElementHandler(object sender, OfficedocEndElementEventArgs e);

public class OfficedocEndElementEventArgs : EventArgs {
  public string Namespace { get; }
  public string Element { get; }
  public string QName { get; }
  public bool IsEmpty { get; }
}

Public Event OnEndElement As OnEndElementHandler

Public Delegate Sub OnEndElementHandler(sender As Object, e As OfficedocEndElementEventArgs)

Public Class OfficedocEndElementEventArgs Inherits EventArgs
  Public ReadOnly Property Namespace As String
  Public ReadOnly Property Element As String
  Public ReadOnly Property QName As String
  Public ReadOnly Property IsEmpty As Boolean
End Class

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

Fired after each file is processed.

Syntax

public event OnEndFileHandler OnEndFile;

public delegate void OnEndFileHandler(object sender, OfficedocEndFileEventArgs e);

public class OfficedocEndFileEventArgs : EventArgs {
  public int Index { get; }
}

Public Event OnEndFile As OnEndFileHandler

Public Delegate Sub OnEndFileHandler(sender As Object, e As OfficedocEndFileEventArgs)

Public Class OfficedocEndFileEventArgs Inherits EventArgs
  Public ReadOnly Property Index As Integer
End Class

Remarks

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

EndPrefixMapping Event (OfficeDoc Component)

Fired when leaving the scope of a namespace declaration.

Syntax

public event OnEndPrefixMappingHandler OnEndPrefixMapping;

public delegate void OnEndPrefixMappingHandler(object sender, OfficedocEndPrefixMappingEventArgs e);

public class OfficedocEndPrefixMappingEventArgs : EventArgs {
  public string Prefix { get; }
}

Public Event OnEndPrefixMapping As OnEndPrefixMappingHandler

Public Delegate Sub OnEndPrefixMappingHandler(sender As Object, e As OfficedocEndPrefixMappingEventArgs)

Public Class OfficedocEndPrefixMappingEventArgs Inherits EventArgs
  Public ReadOnly Property Prefix As String
End Class

Remarks

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

Error Event (OfficeDoc Component)

Information about errors during data delivery.

Syntax

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, OfficedocErrorEventArgs e);

public class OfficedocErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As OfficedocErrorEventArgs)

Public Class OfficedocErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

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

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

EvalEntity Event (OfficeDoc Component)

Fired every time an entity needs to be evaluated.

Syntax

public event OnEvalEntityHandler OnEvalEntity;

public delegate void OnEvalEntityHandler(object sender, OfficedocEvalEntityEventArgs e);

public class OfficedocEvalEntityEventArgs : EventArgs {
  public string Entity { get; }
  public string Value { get; set; }
}

Public Event OnEvalEntity As OnEvalEntityHandler

Public Delegate Sub OnEvalEntityHandler(sender As Object, e As OfficedocEvalEntityEventArgs)

Public Class OfficedocEvalEntityEventArgs Inherits EventArgs
  Public ReadOnly Property Entity As String
  Public Property Value As String
End Class

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

Fired when a section of ignorable whitespace is encountered.

Syntax

public event OnIgnorableWhitespaceHandler OnIgnorableWhitespace;

public delegate void OnIgnorableWhitespaceHandler(object sender, OfficedocIgnorableWhitespaceEventArgs e);

public class OfficedocIgnorableWhitespaceEventArgs : EventArgs {
  public string Text { get; }
}

Public Event OnIgnorableWhitespace As OnIgnorableWhitespaceHandler

Public Delegate Sub OnIgnorableWhitespaceHandler(sender As Object, e As OfficedocIgnorableWhitespaceEventArgs)

Public Class OfficedocIgnorableWhitespaceEventArgs Inherits EventArgs
  Public ReadOnly Property Text As String
End Class

Remarks

The ignorable whitespace section is provided by the Text parameter.

Meta Event (OfficeDoc Component)

Fired when a meta section is encountered.

Syntax

public event OnMetaHandler OnMeta;

public delegate void OnMetaHandler(object sender, OfficedocMetaEventArgs e);

public class OfficedocMetaEventArgs : EventArgs {
  public string Text { get; }
}

Public Event OnMeta As OnMetaHandler

Public Delegate Sub OnMetaHandler(sender As Object, e As OfficedocMetaEventArgs)

Public Class OfficedocMetaEventArgs Inherits EventArgs
  Public ReadOnly Property Text As String
End Class

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

Fired whenever a file exists and may be overwritten.

Syntax

public event OnOverwriteHandler OnOverwrite;

public delegate void OnOverwriteHandler(object sender, OfficedocOverwriteEventArgs e);

public class OfficedocOverwriteEventArgs : EventArgs {
  public string Filename { get; set; }
  public bool Overwrite { get; set; }
}

Public Event OnOverwrite As OnOverwriteHandler

Public Delegate Sub OnOverwriteHandler(sender As Object, e As OfficedocOverwriteEventArgs)

Public Class OfficedocOverwriteEventArgs Inherits EventArgs
  Public Property Filename As String
  Public Property Overwrite As Boolean
End Class

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 component, 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 Component)

Fired when a processing instruction section is encountered.

Syntax

public event OnPIHandler OnPI;

public delegate void OnPIHandler(object sender, OfficedocPIEventArgs e);

public class OfficedocPIEventArgs : EventArgs {
  public string Text { get; }
}

Public Event OnPI As OnPIHandler

Public Delegate Sub OnPIHandler(sender As Object, e As OfficedocPIEventArgs)

Public Class OfficedocPIEventArgs Inherits EventArgs
  Public ReadOnly Property Text As String
End Class

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

Fired as progress is made.

Syntax

public event OnProgressHandler OnProgress;

public delegate void OnProgressHandler(object sender, OfficedocProgressEventArgs e);

public class OfficedocProgressEventArgs : EventArgs {
  public string Data { get; }
  public byte[] DataB { get; }
  public string Filename { get; }
  public long BytesProcessed { get; }
  public int PercentProcessed { get; }
}

Public Event OnProgress As OnProgressHandler

Public Delegate Sub OnProgressHandler(sender As Object, e As OfficedocProgressEventArgs)

Public Class OfficedocProgressEventArgs Inherits EventArgs
  Public ReadOnly Property Data As String
  Public ReadOnly Property DataB As Byte()
  Public ReadOnly Property Filename As String
  Public ReadOnly Property BytesProcessed As Long
  Public ReadOnly Property PercentProcessed As Integer
End Class

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

Fired when a special section is encountered.

Syntax

public event OnSpecialSectionHandler OnSpecialSection;

public delegate void OnSpecialSectionHandler(object sender, OfficedocSpecialSectionEventArgs e);

public class OfficedocSpecialSectionEventArgs : EventArgs {
  public string SectionId { get; }
  public string Text { get; }
}

Public Event OnSpecialSection As OnSpecialSectionHandler

Public Delegate Sub OnSpecialSectionHandler(sender As Object, e As OfficedocSpecialSectionEventArgs)

Public Class OfficedocSpecialSectionEventArgs Inherits EventArgs
  Public ReadOnly Property SectionId As String
  Public ReadOnly Property Text As String
End Class

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

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

Syntax

public event OnStartElementHandler OnStartElement;

public delegate void OnStartElementHandler(object sender, OfficedocStartElementEventArgs e);

public class OfficedocStartElementEventArgs : EventArgs {
  public string Namespace { get; }
  public string Element { get; }
  public string QName { get; }
  public bool IsEmpty { get; }
}

Public Event OnStartElement As OnStartElementHandler

Public Delegate Sub OnStartElementHandler(sender As Object, e As OfficedocStartElementEventArgs)

Public Class OfficedocStartElementEventArgs Inherits EventArgs
  Public ReadOnly Property Namespace As String
  Public ReadOnly Property Element As String
  Public ReadOnly Property QName As String
  Public ReadOnly Property IsEmpty As Boolean
End Class

Remarks

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

The element name is provided through the Element parameter. The attribute names and values (if any) are provided through the XAttributes collection.

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

StartPrefixMapping Event (OfficeDoc Component)

Fired when entering the scope of a namespace declaration.

Syntax

public event OnStartPrefixMappingHandler OnStartPrefixMapping;

public delegate void OnStartPrefixMappingHandler(object sender, OfficedocStartPrefixMappingEventArgs e);

public class OfficedocStartPrefixMappingEventArgs : EventArgs {
  public string Prefix { get; }
  public string URI { get; }
}

Public Event OnStartPrefixMapping As OnStartPrefixMappingHandler

Public Delegate Sub OnStartPrefixMappingHandler(sender As Object, e As OfficedocStartPrefixMappingEventArgs)

Public Class OfficedocStartPrefixMappingEventArgs Inherits EventArgs
  Public ReadOnly Property Prefix As String
  Public ReadOnly Property URI As String
End Class

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 ContentType();

Public ContentType()

PackageProperty Type

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

Remarks

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

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

Fields

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 PackageProperty();

Public PackageProperty()

Relationship Type

A relationship entry in a .rels file in the archive

Remarks

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

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

Fields

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 Relationship();

Public Relationship()

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 Name 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 XMLAttribute();

Public XMLAttribute()

XMLElement Type

An element contained within the XML document.

Remarks

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

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

Fields

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

The Name field 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 XMLElement();

Public XMLElement()

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 Prefix and the URI of the namespace being defined.

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

Fields

Prefix
string
Default Value: ""

The Prefix for the Namespace.

URI
string
Default Value: ""

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

Constructors

public XMLNamespace();

Public XMLNamespace()

public XMLNamespace(string name, string prefix);

Public XMLNamespace(ByVal Name As String, ByVal Prefix As String)

Config Settings (OfficeDoc Component)

The component 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 component, 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 "True" if the relationship at index "x" of Relationships is an external part. Otherwise it will return "False"

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.

GUIAvailable:   Whether or not a message loop is available for processing events.

In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The component will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting GUIAvailable to false will ensure that the component does not attempt to process external events.

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a component 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 true to mask sensitive data. The default is true.

This setting only works on these components: 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 false, the component will use the system security libraries by default to perform cryptographic functions where applicable. In this case, calls to unmanaged code will be made. In certain environments, this is not desirable. To use a completely managed security implementation, set this setting to true.

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

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

If using the .NET Standard Library, this setting will be true on all platforms. The .NET Standard library does not support using the system security libraries.

Note: This setting is static. The value set is applicable to all components used in the application.

When this value is set, the product's system dynamic link library (DLL) is no longer required as a reference, as all unmanaged code is stored in that file.

Trappable Errors (OfficeDoc Component)

Errors

The following errors may be generated by the component. 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 component 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.