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
TipzOfficeDoc
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.
ContentTypeCount | The number of records in the ContentType arrays. |
ContentTypeIsOverride | Specifies if this is a default content type or an override. |
ContentTypeMediaType | The media type for this entry, as defined by RFC2616. |
ContentTypeTarget | If it's a default content type, this will be the file extension it applies to. |
NamespaceCount | The number of records in the Namespace arrays. |
NamespacePrefix | The Prefix for the Namespace . |
NamespaceURI | Namespace URI associated with the corresponding Prefix . |
PackagePath | The path to the Open XML package file. |
PackagePropertyCount | The number of records in the PackageProperty arrays. |
PackagePropertyDataType | The data type associated with this property, if the information is available. |
PackagePropertyName | The name of this property. |
PackagePropertyNamespace | The XML Namespace URI associated with this property. |
PackagePropertyPropId | If this is a custom property, this will be the pid assigned to it. |
PackagePropertyPropSet | If this is a custom property, this will be the GUID of the property set it belongs to. |
PackagePropertyValue | The value of this property. |
PartData | The contents of the currently selected part. |
PartName | The name of the currently selected part. |
RelationshipCount | The number of records in the Relationship arrays. |
RelationshipContentType | The content type for the part referenced by this relationship, resolved from [Content_Types]. |
RelationshipId | The unique ID of this relationship within this . |
RelationshipPartName | The name of the part this relationship entry applies to. |
RelationshipTypeURI | The XML namespace URI that specifies the meaning of this relationship. |
Validate | This property controls whether documents are validated during parsing. |
AttrCount | The number of records in the Attr arrays. |
AttrName | The Name provides the local name (without prefix) of the attribute. |
AttrNamespace | Attribute namespace. |
AttrPrefix | Attribute prefix (if any). |
AttrValue | Attribute value. |
XChildCount | The number of records in the XChild arrays. |
XChildName | The Name property provides the local name (without prefix) of the element. |
XChildNamespace | Namespace of the element. |
XChildPrefix | Prefix of the element (if any). |
XChildXText | The inner text of the element. |
XElement | The name of the current element. |
XNamespace | The namespace of the current element. |
XParent | The parent of the current element. |
XPath | Provides a way to point to a specific element in the document. |
XPrefix | The prefix of the current element. |
XSubTree | A snapshot of the current element in the document. |
XText | The 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.
Close | Closes the Open XML package archive. |
Config | Sets or retrieves a configuration setting. |
ExtractPart | Reads the contents of the currently selected part. |
FindPartByType | Looks up a part in the current relationships file by it's type namespace URI. |
GetPropertyValue | Returns the value of the specified package property. |
ListParts | List all the parts contained in the document and their relationships. |
Open | Opens the Open XML package archive. |
ParsePart | Parses the specified part as XML. |
ReadRelationships | Reads the relationships file in the archive associated with the specified part. |
ReplacePart | Replaces the contents of the specified part in the package. |
Reset | Resets the component. |
ResolveContentType | Returns 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.
BeginFile | Fired before each file is processed. |
Characters | Fired for plain text segments of the input stream. |
Comment | Fired when a comment section is encountered. |
EndElement | Fired when an end-element tag is encountered. |
EndFile | Fired after each file is processed. |
EndPrefixMapping | Fired when leaving the scope of a namespace declaration. |
Error | Information about errors during data delivery. |
EvalEntity | Fired every time an entity needs to be evaluated. |
IgnorableWhitespace | Fired when a section of ignorable whitespace is encountered. |
Meta | Fired when a meta section is encountered. |
Overwrite | Fired whenever a file exists and may be overwritten. |
PI | Fired when a processing instruction section is encountered. |
Progress | Fired as progress is made. |
SpecialSection | Fired when a special section is encountered. |
StartElement | Fired when a begin-element tag is encountered in the document. |
StartPrefixMapping | Fired 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.
NormalizePartName | Whether to normalize Part Names. |
RelationshipIsExternal[x] | Whether the relationship part is internal or external. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitive | Whether sensitive data is masked in log messages. |
UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |
ContentTypeCount Property (OfficeDoc Component)
The number of records in the ContentType arrays.
Syntax
__property int ContentTypeCount = { read=FContentTypeCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
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 Component)
Specifies if this is a default content type or an override.
Syntax
__property bool ContentTypeIsOverride[int ContentTypeIndex] = { read=FContentTypeIsOverride };
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 Component)
The media type for this entry, as defined by RFC2616.
Syntax
__property String ContentTypeMediaType[int ContentTypeIndex] = { read=FContentTypeMediaType };
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 Component)
If it's a default content type, this will be the file extension it applies to.
Syntax
__property String ContentTypeTarget[int ContentTypeIndex] = { read=FContentTypeTarget };
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 Component)
The number of records in the Namespace arrays.
Syntax
__property int NamespaceCount = { read=FNamespaceCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
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 Component)
The Prefix for the Namespace .
Syntax
__property String NamespacePrefix[int NamespaceIndex] = { read=FNamespacePrefix };
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 Component)
Namespace URI associated with the corresponding Prefix .
Syntax
__property String NamespaceURI[int NamespaceIndex] = { read=FNamespaceURI };
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 Component)
The path to the Open XML package file.
Syntax
__property String PackagePath = { read=FPackagePath, write=FSetPackagePath };
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
__property int PackagePropertyCount = { read=FPackagePropertyCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
- PackagePropertyDataType
- PackagePropertyName
- PackagePropertyNamespace
- PackagePropertyPropId
- PackagePropertyPropSet
- PackagePropertyValue
This property is read-only and not available at design time.
Data Type
Integer
PackagePropertyDataType Property (OfficeDoc Component)
The data type associated with this property, if the information is available.
Syntax
__property String PackagePropertyDataType[int PackagePropertyIndex] = { read=FPackagePropertyDataType };
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 Component)
The name of this property.
Syntax
__property String PackagePropertyName[int PackagePropertyIndex] = { read=FPackagePropertyName };
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 Component)
The XML Namespace URI associated with this property.
Syntax
__property String PackagePropertyNamespace[int PackagePropertyIndex] = { read=FPackagePropertyNamespace };
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 Component)
If this is a custom property, this will be the pid assigned to it.
Syntax
__property String PackagePropertyPropId[int PackagePropertyIndex] = { read=FPackagePropertyPropId };
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 Component)
If this is a custom property, this will be the GUID of the property set it belongs to.
Syntax
__property String PackagePropertyPropSet[int PackagePropertyIndex] = { read=FPackagePropertyPropSet };
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 Component)
The value of this property.
Syntax
__property String PackagePropertyValue[int PackagePropertyIndex] = { read=FPackagePropertyValue };
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 Component)
The contents of the currently selected part.
Syntax
__property String PartData = { read=FPartData, write=FSetPartData }; __property DynamicArray<Byte> PartDataB = { read=FPartDataB, write=FSetPartDataB };
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 Array
PartName Property (OfficeDoc Component)
The name of the currently selected part.
Syntax
__property String PartName = { read=FPartName, write=FSetPartName };
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
__property int RelationshipCount = { read=FRelationshipCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
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 Component)
The content type for the part referenced by this relationship, resolved from [Content_Types].
Syntax
__property String RelationshipContentType[int RelationshipIndex] = { read=FRelationshipContentType };
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 Component)
The unique ID of this relationship within this .
Syntax
__property String RelationshipId[int RelationshipIndex] = { read=FRelationshipId };
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 Component)
The name of the part this relationship entry applies to.
Syntax
__property String RelationshipPartName[int RelationshipIndex] = { read=FRelationshipPartName };
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 Component)
The XML namespace URI that specifies the meaning of this relationship.
Syntax
__property String RelationshipTypeURI[int RelationshipIndex] = { read=FRelationshipTypeURI };
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 Component)
This property controls whether documents are validated during parsing.
Syntax
__property bool Validate = { read=FValidate, write=FSetValidate };
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.
Data Type
Boolean
AttrCount Property (OfficeDoc Component)
The number of records in the Attr arrays.
Syntax
__property int AttrCount = { read=FAttrCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
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 Component)
The Name provides the local name (without prefix) of the attribute.
Syntax
__property String AttrName[int AttrIndex] = { read=FAttrName };
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 Component)
Attribute namespace.
Syntax
__property String AttrNamespace[int AttrIndex] = { read=FAttrNamespace };
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 Component)
Attribute prefix (if any).
Syntax
__property String AttrPrefix[int AttrIndex] = { read=FAttrPrefix };
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 Component)
Attribute value.
Syntax
__property String AttrValue[int AttrIndex] = { read=FAttrValue };
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 Component)
The number of records in the XChild arrays.
Syntax
__property int XChildCount = { read=FXChildCount };
Default Value
0
Remarks
This property controls the size of the following arrays:
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 Component)
The Name property provides the local name (without prefix) of the element.
Syntax
__property String XChildName[int XChildIndex] = { read=FXChildName };
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 Component)
Namespace of the element.
Syntax
__property String XChildNamespace[int XChildIndex] = { read=FXChildNamespace };
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 Component)
Prefix of the element (if any).
Syntax
__property String XChildPrefix[int XChildIndex] = { read=FXChildPrefix };
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 Component)
The inner text of the element.
Syntax
__property String XChildXText[int XChildIndex] = { read=FXChildXText };
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 Component)
The name of the current element.
Syntax
__property String XElement = { read=FXElement };
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
__property String XNamespace = { read=FXNamespace };
Default Value
""
Remarks
The current element is specified via the XPath property.
This property is read-only.
Data Type
String
XParent Property (OfficeDoc Component)
The parent of the current element.
Syntax
__property String XParent = { read=FXParent };
Default Value
""
Remarks
The current element is specified via the XPath property.
This property is read-only.
Data Type
String
XPath Property (OfficeDoc Component)
Provides a way to point to a specific element in the document.
Syntax
__property String XPath = { read=FXPath, write=FSetXPath };
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 |
BuildDOM must be set to True prior to parsing the document for the XPath functionality to be available.
Example (Setting XPath):
Document root | XML.XPath = "/" |
Specific Element | XML.XPath = "/root/SubElement1/SubElement2/" |
i-th Child | XML.XPath = "/root/SubElement1[i]" |
Data Type
String
XPrefix Property (OfficeDoc Component)
The prefix of the current element.
Syntax
__property String XPrefix = { read=FXPrefix };
Default Value
""
Remarks
The current element is specified via the XPath property.
This property is read-only.
Data Type
String
XSubTree Property (OfficeDoc Component)
A snapshot of the current element in the document.
Syntax
__property String XSubTree = { read=FXSubTree };
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 Component)
The text of the current element.
Syntax
__property String XText = { read=FXText };
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
void __fastcall Close();
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
String __fastcall Config(String ConfigurationString);
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
void __fastcall 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 Component)
Looks up a part in the current relationships file by it's type namespace URI.
Syntax
String __fastcall FindPartByType(String TypeURI);
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
String __fastcall GetPropertyValue(String PropName, String 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 Component)
List all the parts contained in the document and their relationships.
Syntax
void __fastcall ListParts();
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
void __fastcall Open();
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
void __fastcall 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 Component)
Reads the relationships file in the archive associated with the specified part.
Syntax
void __fastcall ReadRelationships();
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
void __fastcall 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 Component)
Resets the component.
Syntax
void __fastcall Reset();
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
String __fastcall 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 Component)
Fired before each file is processed.
Syntax
typedef struct { int Index; bool Skip; } TipzOfficeDocBeginFileEventParams; typedef void __fastcall (__closure *TipzOfficeDocBeginFileEvent)(System::TObject* Sender, TipzOfficeDocBeginFileEventParams *e); __property TipzOfficeDocBeginFileEvent OnBeginFile = { read=FOnBeginFile, write=FOnBeginFile };
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)
Fired for plain text segments of the input stream.
Syntax
typedef struct { String Text; } TipzOfficeDocCharactersEventParams; typedef void __fastcall (__closure *TipzOfficeDocCharactersEvent)(System::TObject* Sender, TipzOfficeDocCharactersEventParams *e); __property TipzOfficeDocCharactersEvent OnCharacters = { read=FOnCharacters, write=FOnCharacters };
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
typedef struct { String Text; } TipzOfficeDocCommentEventParams; typedef void __fastcall (__closure *TipzOfficeDocCommentEvent)(System::TObject* Sender, TipzOfficeDocCommentEventParams *e); __property TipzOfficeDocCommentEvent OnComment = { read=FOnComment, write=FOnComment };
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
typedef struct { String Namespace; String Element; String QName; bool IsEmpty; } TipzOfficeDocEndElementEventParams; typedef void __fastcall (__closure *TipzOfficeDocEndElementEvent)(System::TObject* Sender, TipzOfficeDocEndElementEventParams *e); __property TipzOfficeDocEndElementEvent OnEndElement = { read=FOnEndElement, write=FOnEndElement };
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
typedef struct { int Index; } TipzOfficeDocEndFileEventParams; typedef void __fastcall (__closure *TipzOfficeDocEndFileEvent)(System::TObject* Sender, TipzOfficeDocEndFileEventParams *e); __property TipzOfficeDocEndFileEvent OnEndFile = { read=FOnEndFile, write=FOnEndFile };
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)
Fired when leaving the scope of a namespace declaration.
Syntax
typedef struct { String Prefix; } TipzOfficeDocEndPrefixMappingEventParams; typedef void __fastcall (__closure *TipzOfficeDocEndPrefixMappingEvent)(System::TObject* Sender, TipzOfficeDocEndPrefixMappingEventParams *e); __property TipzOfficeDocEndPrefixMappingEvent OnEndPrefixMapping = { read=FOnEndPrefixMapping, write=FOnEndPrefixMapping };
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
typedef struct { int ErrorCode; String Description; } TipzOfficeDocErrorEventParams; typedef void __fastcall (__closure *TipzOfficeDocErrorEvent)(System::TObject* Sender, TipzOfficeDocErrorEventParams *e); __property TipzOfficeDocErrorEvent OnError = { read=FOnError, write=FOnError };
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the component raises 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
typedef struct { String Entity; String Value; } TipzOfficeDocEvalEntityEventParams; typedef void __fastcall (__closure *TipzOfficeDocEvalEntityEvent)(System::TObject* Sender, TipzOfficeDocEvalEntityEventParams *e); __property TipzOfficeDocEvalEntityEvent OnEvalEntity = { read=FOnEvalEntity, write=FOnEvalEntity };
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
typedef struct { String Text; } TipzOfficeDocIgnorableWhitespaceEventParams; typedef void __fastcall (__closure *TipzOfficeDocIgnorableWhitespaceEvent)(System::TObject* Sender, TipzOfficeDocIgnorableWhitespaceEventParams *e); __property TipzOfficeDocIgnorableWhitespaceEvent OnIgnorableWhitespace = { read=FOnIgnorableWhitespace, write=FOnIgnorableWhitespace };
Remarks
The ignorable whitespace section is provided by the Text parameter.
Meta Event (OfficeDoc Component)
Fired when a meta section is encountered.
Syntax
typedef struct { String Text; } TipzOfficeDocMetaEventParams; typedef void __fastcall (__closure *TipzOfficeDocMetaEvent)(System::TObject* Sender, TipzOfficeDocMetaEventParams *e); __property TipzOfficeDocMetaEvent OnMeta = { read=FOnMeta, write=FOnMeta };
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
typedef struct { String Filename; bool Overwrite; } TipzOfficeDocOverwriteEventParams; typedef void __fastcall (__closure *TipzOfficeDocOverwriteEvent)(System::TObject* Sender, TipzOfficeDocOverwriteEventParams *e); __property TipzOfficeDocOverwriteEvent OnOverwrite = { read=FOnOverwrite, write=FOnOverwrite };
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
typedef struct { String Text; } TipzOfficeDocPIEventParams; typedef void __fastcall (__closure *TipzOfficeDocPIEvent)(System::TObject* Sender, TipzOfficeDocPIEventParams *e); __property TipzOfficeDocPIEvent OnPI = { read=FOnPI, write=FOnPI };
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
typedef struct { String Data; DynamicArray<Byte> DataB; String Filename; __int64 BytesProcessed; int PercentProcessed; } TipzOfficeDocProgressEventParams; typedef void __fastcall (__closure *TipzOfficeDocProgressEvent)(System::TObject* Sender, TipzOfficeDocProgressEventParams *e); __property TipzOfficeDocProgressEvent OnProgress = { read=FOnProgress, write=FOnProgress };
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
typedef struct { String SectionId; String Text; } TipzOfficeDocSpecialSectionEventParams; typedef void __fastcall (__closure *TipzOfficeDocSpecialSectionEvent)(System::TObject* Sender, TipzOfficeDocSpecialSectionEventParams *e); __property TipzOfficeDocSpecialSectionEvent OnSpecialSection = { read=FOnSpecialSection, write=FOnSpecialSection };
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
typedef struct { String Namespace; String Element; String QName; bool IsEmpty; } TipzOfficeDocStartElementEventParams; typedef void __fastcall (__closure *TipzOfficeDocStartElementEvent)(System::TObject* Sender, TipzOfficeDocStartElementEventParams *e); __property TipzOfficeDocStartElementEvent OnStartElement = { read=FOnStartElement, write=FOnStartElement };
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 Component)
Fired when entering the scope of a namespace declaration.
Syntax
typedef struct { String Prefix; String URI; } TipzOfficeDocStartPrefixMappingEventParams; typedef void __fastcall (__closure *TipzOfficeDocStartPrefixMappingEvent)(System::TObject* Sender, TipzOfficeDocStartPrefixMappingEventParams *e); __property TipzOfficeDocStartPrefixMappingEvent OnStartPrefixMapping = { read=FOnStartPrefixMapping, write=FOnStartPrefixMapping };
Remarks
The EndPrefixMapping event is fired when leaving the scope of a namespace declaration.
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
/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.
Base Config Settings
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
- 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.
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.
Setting this configuration setting to true tells the component to use the internal implementation instead of using the system security libraries.
This setting is set to false by default on all platforms.
Trappable Errors (OfficeDoc Component)
ErrorsThe 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. |