OfficeDoc Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

ipworkszip.OfficeDoc

Remarks

The struct 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.

Method List

---

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

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.

Config Settings

---

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

ContentTypeCount Property (OfficeDoc Component)

The number of records in the ContentType arrays.

Syntax

func (obj *OfficeDoc) ContentTypeCount() (int32, error)

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.

Data Type

int32

ContentTypeIsOverride Property (OfficeDoc Component)

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

Syntax

func (obj *OfficeDoc) ContentTypeIsOverride(ContentTypeIndex int32) (bool, error)

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.

Data Type

bool

ContentTypeMediaType Property (OfficeDoc Component)

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

Syntax

func (obj *OfficeDoc) ContentTypeMediaType(ContentTypeIndex int32) (string, error)

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.

Data Type

string

ContentTypeTarget Property (OfficeDoc Component)

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

Syntax

func (obj *OfficeDoc) ContentTypeTarget(ContentTypeIndex int32) (string, error)

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.

Data Type

string

NamespaceCount Property (OfficeDoc Component)

The number of records in the Namespace arrays.

Syntax

func (obj *OfficeDoc) NamespaceCount() (int32, error)

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.

Data Type

int32

NamespacePrefix Property (OfficeDoc Component)

This property contains the Prefix for the namespace.

Syntax

func (obj *OfficeDoc) NamespacePrefix(NamespaceIndex int32) (string, error)

Default Value

""

Remarks

This property contains 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.

Data Type

string

NamespaceURI Property (OfficeDoc Component)

This property contains the namespace URI associated with the corresponding Prefix .

Syntax

func (obj *OfficeDoc) NamespaceURI(NamespaceIndex int32) (string, error)

Default Value

""

Remarks

This property contains the namespace URI associated with the corresponding NamespacePrefix. This URL is usually 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.

Data Type

string

PackagePath Property (OfficeDoc Component)

The path to the Open XML package file.

Syntax

func (obj *OfficeDoc) PackagePath() (string, error)
func (obj *OfficeDoc) SetPackagePath(value string) error

Default Value

""

Remarks

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

Data Type

string

PackagePropertyCount Property (OfficeDoc Component)

The number of records in the PackageProperty arrays.

Syntax

func (obj *OfficeDoc) PackagePropertyCount() (int32, error)

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.

Data Type

int32

PackagePropertyDataType Property (OfficeDoc Component)

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

Syntax

func (obj *OfficeDoc) PackagePropertyDataType(PackagePropertyIndex int32) (string, error)

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.

Data Type

string

PackagePropertyName Property (OfficeDoc Component)

The name of this property.

Syntax

func (obj *OfficeDoc) PackagePropertyName(PackagePropertyIndex int32) (string, error)

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.

Data Type

string

PackagePropertyNamespace Property (OfficeDoc Component)

The XML Namespace URI associated with this property.

Syntax

func (obj *OfficeDoc) PackagePropertyNamespace(PackagePropertyIndex int32) (string, error)

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.

Data Type

string

PackagePropertyPropId Property (OfficeDoc Component)

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

Syntax

func (obj *OfficeDoc) PackagePropertyPropId(PackagePropertyIndex int32) (string, error)

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.

Data Type

string

PackagePropertyPropSet Property (OfficeDoc Component)

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

Syntax

func (obj *OfficeDoc) PackagePropertyPropSet(PackagePropertyIndex int32) (string, error)

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.

Data Type

string

PackagePropertyValue Property (OfficeDoc Component)

The value of this property.

Syntax

func (obj *OfficeDoc) PackagePropertyValue(PackagePropertyIndex int32) (string, error)

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.

Data Type

string

PartData Property (OfficeDoc Component)

The contents of the currently selected part.

Syntax

func (obj *OfficeDoc) PartData() ([]byte, error)
func (obj *OfficeDoc) SetPartData(value []byte) error

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.

Data Type

[]byte

PartName Property (OfficeDoc Component)

The name of the currently selected part.

Syntax

func (obj *OfficeDoc) PartName() (string, error)
func (obj *OfficeDoc) SetPartName(value string) error

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

The number of records in the Relationship arrays.

Syntax

func (obj *OfficeDoc) RelationshipCount() (int32, error)

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.

Data Type

int32

RelationshipContentType Property (OfficeDoc Component)

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

Syntax

func (obj *OfficeDoc) RelationshipContentType(RelationshipIndex int32) (string, error)

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.

Data Type

string

RelationshipId Property (OfficeDoc Component)

The unique ID of this relationship within this .

Syntax

func (obj *OfficeDoc) RelationshipId(RelationshipIndex int32) (string, error)

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.

Data Type

string

RelationshipPartName Property (OfficeDoc Component)

The name of the part this relationship entry applies to.

Syntax

func (obj *OfficeDoc) RelationshipPartName(RelationshipIndex int32) (string, error)

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.

Data Type

string

RelationshipTypeURI Property (OfficeDoc Component)

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

Syntax

func (obj *OfficeDoc) RelationshipTypeURI(RelationshipIndex int32) (string, error)

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.

Data Type

string

Validate Property (OfficeDoc Component)

This property controls whether documents are validated during parsing.

Syntax

func (obj *OfficeDoc) Validate() (bool, error)
func (obj *OfficeDoc) SetValidate(value bool) error

Default Value

true

Remarks

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

Data Type

bool

AttrCount Property (OfficeDoc Component)

The number of records in the Attr arrays.

Syntax

func (obj *OfficeDoc) AttrCount() (int32, error)

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.

Data Type

int32

AttrName Property (OfficeDoc Component)

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

Syntax

func (obj *OfficeDoc) AttrName(AttrIndex int32) (string, error)

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.

Data Type

string

AttrNamespace Property (OfficeDoc Component)

This property contains the attribute namespace.

Syntax

func (obj *OfficeDoc) AttrNamespace(AttrIndex int32) (string, error)

Default Value

""

Remarks

This property contains the 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.

Data Type

string

AttrPrefix Property (OfficeDoc Component)

This property contains the attribute prefix (if any).

Syntax

func (obj *OfficeDoc) AttrPrefix(AttrIndex int32) (string, error)

Default Value

""

Remarks

This property contains the 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.

Data Type

string

AttrValue Property (OfficeDoc Component)

This property contains the attribute value.

Syntax

func (obj *OfficeDoc) AttrValue(AttrIndex int32) (string, error)

Default Value

""

Remarks

This property contains the 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.

Data Type

string

XChildCount Property (OfficeDoc Component)

The number of records in the XChild arrays.

Syntax

func (obj *OfficeDoc) XChildCount() (int32, error)

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.

Data Type

int32

XChildName Property (OfficeDoc Component)

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

Syntax

func (obj *OfficeDoc) XChildName(XChildIndex int32) (string, error)

Default Value

""

Remarks

The XChildName property provides the local name (without a 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.

Data Type

string

XChildNamespace Property (OfficeDoc Component)

This property contains the namespace of the element.

Syntax

func (obj *OfficeDoc) XChildNamespace(XChildIndex int32) (string, error)

Default Value

""

Remarks

This property contains the 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.

Data Type

string

XChildPrefix Property (OfficeDoc Component)

This property contains the prefix of the element (if any).

Syntax

func (obj *OfficeDoc) XChildPrefix(XChildIndex int32) (string, error)

Default Value

""

Remarks

This property contains the 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.

Data Type

string

XChildXText Property (OfficeDoc Component)

This property contains the inner text of the element.

Syntax

func (obj *OfficeDoc) XChildXText(XChildIndex int32) (string, error)

Default Value

""

Remarks

This property contains 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.

Data Type

string

XElement Property (OfficeDoc Component)

The name of the current element.

Syntax

func (obj *OfficeDoc) XElement() (string, error)

Default Value

""

Remarks

The current element is specified via the XPath property.

This property is read-only.

Data Type

string

XNamespace Property (OfficeDoc Component)

The namespace of the current element.

Syntax

func (obj *OfficeDoc) XNamespace() (string, error)

Default Value

""

Remarks

The current element is specified via the XPath property.

This property is read-only.

Data Type

string

XParent Property (OfficeDoc Component)

This property includes the parent of the current element.

Syntax

func (obj *OfficeDoc) XParent() (string, error)

Default Value

""

Remarks

The current element is specified through the XPath property.

This property is read-only.

Data Type

string

XPath Property (OfficeDoc Component)

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

Syntax

func (obj *OfficeDoc) XPath() (string, error)
func (obj *OfficeDoc) SetXPath(value string) error

Default Value

""

Remarks

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

The path is a series of one or more element accessors separated by /. The path can be absolute (starting with /) or relative to the current XPath location.

The following are possible values for an element accessor:

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 before parsing the document for the XPath functionality to be available.

Example. Setting XPath:

Data Type

string

XPrefix Property (OfficeDoc Component)

The prefix of the current element.

Syntax

func (obj *OfficeDoc) XPrefix() (string, error)

Default Value

""

Remarks

The current element is specified via the XPath property.

This property is read-only.

Data Type

string

XSubTree Property (OfficeDoc Component)

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

Syntax

func (obj *OfficeDoc) XSubTree() (string, error)

Default Value

""

Remarks

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

This property is read-only.

Data Type

string

XText Property (OfficeDoc Component)

The text of the current element.

Syntax

func (obj *OfficeDoc) XText() (string, error)

Default Value

""

Remarks

The current element is specified via the XPath property.

This property is read-only.

Data Type

string

Close Method (OfficeDoc Component)

Closes the Open XML package archive.

Syntax

func (obj *OfficeDoc) Close() error

Remarks

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

Config Method (OfficeDoc Component)

Sets or retrieves a configuration setting.

Syntax

func (obj *OfficeDoc) Config(ConfigurationString string) (string, error)

Remarks

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

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

func (obj *OfficeDoc) ExtractPart() error

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

func (obj *OfficeDoc) FindPartByType(TypeURI string) (string, error)

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

func (obj *OfficeDoc) GetPropertyValue(PropName string, PropNamespace string) (string, error)

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

func (obj *OfficeDoc) ListParts() error

Remarks

When this method is called, the struct 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

func (obj *OfficeDoc) Open() error

Remarks

When this method is called, the struct 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

func (obj *OfficeDoc) ParsePart() error

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

func (obj *OfficeDoc) ReadRelationships() error

Remarks

When this method is called, the struct 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

func (obj *OfficeDoc) ReplacePart() error

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

Syntax

func (obj *OfficeDoc) Reset() error

Remarks

Reset resets the state of the struct. 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

func (obj *OfficeDoc) ResolveContentType() (string, error)

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

// OfficeDocBeginFileEventArgs carries the OfficeDoc BeginFile event's parameters.
type OfficeDocBeginFileEventArgs struct {...}

func (args *OfficeDocBeginFileEventArgs) Index() int32
func (args *OfficeDocBeginFileEventArgs) Skip() bool
func (args *OfficeDocBeginFileEventArgs) SetSkip(value bool)

// OfficeDocBeginFileEvent defines the signature of the OfficeDoc BeginFile event's handler function.
type OfficeDocBeginFileEvent func(sender *OfficeDoc, args *OfficeDocBeginFileEventArgs)

func (obj *OfficeDoc) GetOnBeginFileHandler() OfficeDocBeginFileEvent
func (obj *OfficeDoc) SetOnBeginFileHandler(handlerFunc OfficeDocBeginFileEvent)

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

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

Syntax

// OfficeDocCharactersEventArgs carries the OfficeDoc Characters event's parameters.
type OfficeDocCharactersEventArgs struct {...}

func (args *OfficeDocCharactersEventArgs) Text() string
// OfficeDocCharactersEvent defines the signature of the OfficeDoc Characters event's handler function.
type OfficeDocCharactersEvent func(sender *OfficeDoc, args *OfficeDocCharactersEventArgs)

func (obj *OfficeDoc) GetOnCharactersHandler() OfficeDocCharactersEvent
func (obj *OfficeDoc) SetOnCharactersHandler(handlerFunc OfficeDocCharactersEvent)

Remarks

The Characters event provides the plaintext content of the XML document (i.e., the text inside the tags). The text is provided through the Text parameter.

The text includes whitespace as well as end-of-line characters, except for ignorable whitespace, which is fired through the IgnorableWhitespace event.

Comment Event (OfficeDoc Component)

This event is fired when a comment section is encountered.

Syntax

// OfficeDocCommentEventArgs carries the OfficeDoc Comment event's parameters.
type OfficeDocCommentEventArgs struct {...}

func (args *OfficeDocCommentEventArgs) Text() string
// OfficeDocCommentEvent defines the signature of the OfficeDoc Comment event's handler function.
type OfficeDocCommentEvent func(sender *OfficeDoc, args *OfficeDocCommentEventArgs)

func (obj *OfficeDoc) GetOnCommentHandler() OfficeDocCommentEvent
func (obj *OfficeDoc) SetOnCommentHandler(handlerFunc OfficeDocCommentEvent)

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)

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

Syntax

// OfficeDocEndElementEventArgs carries the OfficeDoc EndElement event's parameters.
type OfficeDocEndElementEventArgs struct {...}

func (args *OfficeDocEndElementEventArgs) Namespace() string
func (args *OfficeDocEndElementEventArgs) Element() string
func (args *OfficeDocEndElementEventArgs) QName() string
func (args *OfficeDocEndElementEventArgs) IsEmpty() bool
// OfficeDocEndElementEvent defines the signature of the OfficeDoc EndElement event's handler function.
type OfficeDocEndElementEvent func(sender *OfficeDoc, args *OfficeDocEndElementEventArgs)

func (obj *OfficeDoc) GetOnEndElementHandler() OfficeDocEndElementEvent
func (obj *OfficeDoc) SetOnEndElementHandler(handlerFunc OfficeDocEndElementEvent)

Remarks

The EndElement event is fired when an end-element tag is found in the document.

The element name is provided by the Element parameter.

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

EndFile Event (OfficeDoc Component)

Fired after each file is processed.

Syntax

// OfficeDocEndFileEventArgs carries the OfficeDoc EndFile event's parameters.
type OfficeDocEndFileEventArgs struct {...}

func (args *OfficeDocEndFileEventArgs) Index() int32
// OfficeDocEndFileEvent defines the signature of the OfficeDoc EndFile event's handler function.
type OfficeDocEndFileEvent func(sender *OfficeDoc, args *OfficeDocEndFileEventArgs)

func (obj *OfficeDoc) GetOnEndFileHandler() OfficeDocEndFileEvent
func (obj *OfficeDoc) SetOnEndFileHandler(handlerFunc OfficeDocEndFileEvent)

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

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

Syntax

// OfficeDocEndPrefixMappingEventArgs carries the OfficeDoc EndPrefixMapping event's parameters.
type OfficeDocEndPrefixMappingEventArgs struct {...}

func (args *OfficeDocEndPrefixMappingEventArgs) Prefix() string
// OfficeDocEndPrefixMappingEvent defines the signature of the OfficeDoc EndPrefixMapping event's handler function.
type OfficeDocEndPrefixMappingEvent func(sender *OfficeDoc, args *OfficeDocEndPrefixMappingEventArgs)

func (obj *OfficeDoc) GetOnEndPrefixMappingHandler() OfficeDocEndPrefixMappingEvent
func (obj *OfficeDoc) SetOnEndPrefixMappingHandler(handlerFunc OfficeDocEndPrefixMappingEvent)

Remarks

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

Error Event (OfficeDoc Component)

Fired when information is available about errors during data delivery.

Syntax

// OfficeDocErrorEventArgs carries the OfficeDoc Error event's parameters.
type OfficeDocErrorEventArgs struct {...}

func (args *OfficeDocErrorEventArgs) ErrorCode() int32
func (args *OfficeDocErrorEventArgs) Description() string
// OfficeDocErrorEvent defines the signature of the OfficeDoc Error event's handler function.
type OfficeDocErrorEvent func(sender *OfficeDoc, args *OfficeDocErrorEventArgs)

func (obj *OfficeDoc) GetOnErrorHandler() OfficeDocErrorEvent
func (obj *OfficeDoc) SetOnErrorHandler(handlerFunc OfficeDocErrorEvent)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the struct 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 Component)

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

Syntax

// OfficeDocEvalEntityEventArgs carries the OfficeDoc EvalEntity event's parameters.
type OfficeDocEvalEntityEventArgs struct {...}

func (args *OfficeDocEvalEntityEventArgs) Entity() string
func (args *OfficeDocEvalEntityEventArgs) Value() string
func (args *OfficeDocEvalEntityEventArgs) SetValue(value string)

// OfficeDocEvalEntityEvent defines the signature of the OfficeDoc EvalEntity event's handler function.
type OfficeDocEvalEntityEvent func(sender *OfficeDoc, args *OfficeDocEvalEntityEventArgs)

func (obj *OfficeDoc) GetOnEvalEntityHandler() OfficeDocEvalEntityEvent
func (obj *OfficeDoc) SetOnEvalEntityHandler(handlerFunc OfficeDocEvalEntityEvent)

Remarks

The Value parameter contains a suggested value for the entity (normally the entity name itself). You may set Value to a value of your choice, which will later be passed into the text stream.

IgnorableWhitespace Event (OfficeDoc Component)

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

Syntax

// OfficeDocIgnorableWhitespaceEventArgs carries the OfficeDoc IgnorableWhitespace event's parameters.
type OfficeDocIgnorableWhitespaceEventArgs struct {...}

func (args *OfficeDocIgnorableWhitespaceEventArgs) Text() string
// OfficeDocIgnorableWhitespaceEvent defines the signature of the OfficeDoc IgnorableWhitespace event's handler function.
type OfficeDocIgnorableWhitespaceEvent func(sender *OfficeDoc, args *OfficeDocIgnorableWhitespaceEventArgs)

func (obj *OfficeDoc) GetOnIgnorableWhitespaceHandler() OfficeDocIgnorableWhitespaceEvent
func (obj *OfficeDoc) SetOnIgnorableWhitespaceHandler(handlerFunc OfficeDocIgnorableWhitespaceEvent)

Remarks

The ignorable whitespace section is provided by the Text parameter.

Meta Event (OfficeDoc Component)

This event fires when a meta section is encountered.

Syntax

// OfficeDocMetaEventArgs carries the OfficeDoc Meta event's parameters.
type OfficeDocMetaEventArgs struct {...}

func (args *OfficeDocMetaEventArgs) Text() string
// OfficeDocMetaEvent defines the signature of the OfficeDoc Meta event's handler function.
type OfficeDocMetaEvent func(sender *OfficeDoc, args *OfficeDocMetaEventArgs)

func (obj *OfficeDoc) GetOnMetaHandler() OfficeDocMetaEvent
func (obj *OfficeDoc) SetOnMetaHandler(handlerFunc OfficeDocMetaEvent)

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

// OfficeDocOverwriteEventArgs carries the OfficeDoc Overwrite event's parameters.
type OfficeDocOverwriteEventArgs struct {...}

func (args *OfficeDocOverwriteEventArgs) FileName() string
func (args *OfficeDocOverwriteEventArgs) SetFileName(value string)

func (args *OfficeDocOverwriteEventArgs) Overwrite() bool
func (args *OfficeDocOverwriteEventArgs) SetOverwrite(value bool)

// OfficeDocOverwriteEvent defines the signature of the OfficeDoc Overwrite event's handler function.
type OfficeDocOverwriteEvent func(sender *OfficeDoc, args *OfficeDocOverwriteEventArgs)

func (obj *OfficeDoc) GetOnOverwriteHandler() OfficeDocOverwriteEvent
func (obj *OfficeDoc) SetOnOverwriteHandler(handlerFunc OfficeDocOverwriteEvent)

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 struct, 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)

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

Syntax

// OfficeDocPIEventArgs carries the OfficeDoc PI event's parameters.
type OfficeDocPIEventArgs struct {...}

func (args *OfficeDocPIEventArgs) Text() string
// OfficeDocPIEvent defines the signature of the OfficeDoc PI event's handler function.
type OfficeDocPIEvent func(sender *OfficeDoc, args *OfficeDocPIEventArgs)

func (obj *OfficeDoc) GetOnPIHandler() OfficeDocPIEvent
func (obj *OfficeDoc) SetOnPIHandler(handlerFunc OfficeDocPIEvent)

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

// OfficeDocProgressEventArgs carries the OfficeDoc Progress event's parameters.
type OfficeDocProgressEventArgs struct {...}

func (args *OfficeDocProgressEventArgs) Data() []byte
func (args *OfficeDocProgressEventArgs) FileName() string
func (args *OfficeDocProgressEventArgs) BytesProcessed() int64
func (args *OfficeDocProgressEventArgs) PercentProcessed() int32
// OfficeDocProgressEvent defines the signature of the OfficeDoc Progress event's handler function.
type OfficeDocProgressEvent func(sender *OfficeDoc, args *OfficeDocProgressEventArgs)

func (obj *OfficeDoc) GetOnProgressHandler() OfficeDocProgressEvent
func (obj *OfficeDoc) SetOnProgressHandler(handlerFunc OfficeDocProgressEvent)

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)

This event is fired when a special section is encountered.

Syntax

// OfficeDocSpecialSectionEventArgs carries the OfficeDoc SpecialSection event's parameters.
type OfficeDocSpecialSectionEventArgs struct {...}

func (args *OfficeDocSpecialSectionEventArgs) SectionId() string
func (args *OfficeDocSpecialSectionEventArgs) Text() string
// OfficeDocSpecialSectionEvent defines the signature of the OfficeDoc SpecialSection event's handler function.
type OfficeDocSpecialSectionEvent func(sender *OfficeDoc, args *OfficeDocSpecialSectionEventArgs)

func (obj *OfficeDoc) GetOnSpecialSectionHandler() OfficeDocSpecialSectionEvent
func (obj *OfficeDoc) SetOnSpecialSectionHandler(handlerFunc OfficeDocSpecialSectionEvent)

Remarks

The SpecialSection event is fired whenever a special section (such as <![ CDATA [ ...text... ]]>) is found in the document.

The full text of the special section is provided by the Text parameter, and the SectionId parameter provides the section identifier (e.g., CDATA).

StartElement Event (OfficeDoc Component)

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

Syntax

// OfficeDocStartElementEventArgs carries the OfficeDoc StartElement event's parameters.
type OfficeDocStartElementEventArgs struct {...}

func (args *OfficeDocStartElementEventArgs) Namespace() string
func (args *OfficeDocStartElementEventArgs) Element() string
func (args *OfficeDocStartElementEventArgs) QName() string
func (args *OfficeDocStartElementEventArgs) IsEmpty() bool
// OfficeDocStartElementEvent defines the signature of the OfficeDoc StartElement event's handler function.
type OfficeDocStartElementEvent func(sender *OfficeDoc, args *OfficeDocStartElementEventArgs)

func (obj *OfficeDoc) GetOnStartElementHandler() OfficeDocStartElementEvent
func (obj *OfficeDoc) SetOnStartElementHandler(handlerFunc OfficeDocStartElementEvent)

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 to an empty element declaration.

StartPrefixMapping Event (OfficeDoc Component)

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

Syntax

// OfficeDocStartPrefixMappingEventArgs carries the OfficeDoc StartPrefixMapping event's parameters.
type OfficeDocStartPrefixMappingEventArgs struct {...}

func (args *OfficeDocStartPrefixMappingEventArgs) Prefix() string
func (args *OfficeDocStartPrefixMappingEventArgs) URI() string
// OfficeDocStartPrefixMappingEvent defines the signature of the OfficeDoc StartPrefixMapping event's handler function.
type OfficeDocStartPrefixMappingEvent func(sender *OfficeDoc, args *OfficeDocStartPrefixMappingEventArgs)

func (obj *OfficeDoc) GetOnStartPrefixMappingHandler() OfficeDocStartPrefixMappingEvent
func (obj *OfficeDoc) SetOnStartPrefixMappingHandler(handlerFunc OfficeDocStartPrefixMappingEvent)

Remarks

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

Config Settings (OfficeDoc Component)

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

OfficeDoc Config Settings

Base Config Settings

Trappable Errors (OfficeDoc Component)

Errors

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

OfficeDoc Errors