TChilkatXml Delphi ActiveX Reference Documentation

TChilkatXml

Current Version: 9.5.0.73

A free non-validating XML parser component with encryption and compression features.

Importing the Chilkat ActiveX into Delphi

Important: When upgrading to a new version of Chilkat, make sure to re-imported ActiveX DLL into Delphi to regenerate the files described below.

Two things are required to use an ActiveX in Delphi:

  1. The ActiveX DLL needs to be registered via regsvr32 on the system where the Delphi application runs. See How To Register ActiveX DLLs for detailed information.
  2. See also: ActiveX Registration Tutorial
  3. The ActiveX component needs to be "imported". Use the Delphi Import Component Wizard to import the Chilkat type library. This creates the following files: Chilkat_v9_5_0_TLB.pas and Chilkat_v9_5_0_TLB.dcr. The Chilkat_v9_5_0_TLB.pas should be added to your project.

To import the Chilkat type library, do the following:

  1. In the Delphi RAD Studio, select the menu item "Component" --> "Import a Type Library".
  2. Find "Chilkat ActiveX v9.5.0" in the list and select it. This will only appear in the list if the ChilkatAx-9.5.0-win32.dll (or ChilkatAx-9.5.0-x64.dll) has been registered w/ regsvr32.
  3. Check the "Generate Component Wrappers" checkbox.
  4. Select a directory where the unit files (.pas and .dcr) should be generated.
  5. Select "Create Unit" and then "Finish".
  6. Add the .pas to your Delphi project.

To use a Chilkat ActiveX object in your Delphi code, add "Chilkat_v9_5_0_TLB" to the "uses" statement. For example:

uses
  Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
  Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Chilkat_v9_5_0_TLB;

Object Creation

var
obj: TChilkatXml;
...
begin
obj := TChilkatXml.Create(Self);
...
// When finished, free the object instance.
obj.Free();

Properties

Cdata
property Cdata: Integer

When True, causes an XML node's content to be encapsulated in a CDATA section.

More Information and Examples
top
Content
property Content: WideString

The content of the XML node. It is the text between the open and close tags, not including child nodes. For example:

<tag1>This is the content</tag1>

<tag2><child1>abc</child1><child2>abc</child2>This is the content</tag2>
Because the child nodes are not included, the content of "tag1" and "tag2" are both equal to "This is the content".

top
ContentInt
property ContentInt: Integer

Set/get the content as an integer.

top
DebugLogFilePath
property DebugLogFilePath: WideString

If set to a file path, causes each Chilkat method or property call to automatically append it's LastErrorText to the specified log file. The information is appended such that if a hang or crash occurs, it is possible to see the context in which the problem occurred, as well as a history of all Chilkat calls up to the point of the problem. The VerboseLogging property can be set to provide more detailed information.

This property is typically used for debugging the rare cases where a Chilkat method call hangs or generates an exception that halts program execution (i.e. crashes). A hang or crash should generally never happen. The typical causes of a hang are:

  1. a timeout related property was set to 0 to explicitly indicate that an infinite timeout is desired,
  2. the hang is actually a hang within an event callback (i.e. it is a hang within the application code), or
  3. there is an internal problem (bug) in the Chilkat code that causes the hang.

top
DocType
property DocType: WideString

The DOCTYPE declaration (if any) for the XML document.

More Information and Examples
top
EmitBom
property EmitBom: Integer
Introduced in version 9.5.0.44

If 1, then emit the BOM (byte order mark, also known as a preamble) for encodings such as utf-8, utf-16, etc. The defautl value is 0. This only applies when writing XML files. It does not apply when getting the XML as a string via the GetXml method.

top
EmitCompact
property EmitCompact: Integer
Introduced in version 9.5.0.64

If 1, then GetXml and GetXmlSb emit compact XML. The XML emitted has no unnecessary whitespace, incuding no end-of-lines (CR's and/or LF's). The default value is 0, which maintains backward compatibility.

More Information and Examples
top
EmitXmlDecl
property EmitXmlDecl: Integer

If 1, then the XML declaration is emitted for methods (such as GetXml or SaveXml) where the XML is written to a file or string. The default value of this property is 1. If set to 0, the XML declaration is not emitted. (The XML declaration is the 1st line of an XML document starting with "<?xml ...".

top
Encoding
property Encoding: WideString

This is the encoding attribute in the XML declaration, such as "utf-8" or "iso-8859-1". The default is "utf-8". This property can be set from any node in the XML document and when set, causes the encoding property to be added to the XML declaration. Setting this property does not cause the document to be converted to a different encoding.

Calling any of the LoadXml* methods causes this property to be set to the charset found within the XML, if any. If no charset is specified within the loaded XML, then the LoadXml method resets this property to its default value of "utf-8".

top
I
property I: Integer
Introduced in version 9.5.0.64

Used in tagPaths (and ChilkatPath). The value of this property is substituted for "i" in "[i]". See the example below..

top
J
property J: Integer
Introduced in version 9.5.0.64

Used in tagPaths (and ChilkatPath). The value of this property is substituted for "j" in "[j]". See the example below..

More Information and Examples
top
K
property K: Integer
Introduced in version 9.5.0.64

Used in tagPaths (and ChilkatPath). The value of this property is substituted for "k" in "[k]". See the example below..

top
LastBinaryResult
property LastBinaryResult: OleVariant readonly
Introduced in version 9.5.0.52

The binary data returned by the last (binary data returning) method called. Only available if Chilkat.Global.KeepBinaryResult is set to 1. This provides a means for obtaining large varbinary results in the SQL Server environment (where limitations exist in getting large amounts of data returned by method calls, but where temp tables can be used for binary properties).

top
LastErrorHtml
property LastErrorHtml: WideString readonly

Provides information in HTML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorText
property LastErrorText: WideString readonly

Provides information in plain-text format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastErrorXml
property LastErrorXml: WideString readonly

Provides information in XML format about the last method/property called. If a method call returns a value indicating failure, or behaves unexpectedly, examine this property to get more information.

top
LastMethodSuccess
property LastMethodSuccess: Integer
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of 1 indicates success, a value of 0 indicates failure. This property is automatically set for method calls. It is not modified by property accesses. The property is automatically set to indicate success for the following types of method calls:

  • Any method that returns a string.
  • Any method returning a Chilkat object, binary bytes, or a date/time.
  • Any method returning a standard boolean status value where success = 1 and failure = 0.
  • Any method returning an integer where failure is defined by a return value less than zero.

Note: Methods that do not fit the above requirements will always set this property equal to 1. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
LastStringResult
property LastStringResult: WideString readonly
Introduced in version 9.5.0.52

The string return value of the last (string returning) method called. Only available if Chilkat.Global.KeepStringResult is set to 1. This provides a means for obtaining large string results in the SQL Server environment (where limitations exist in getting long strings returned by method calls, but where temp tables can be used for string properties).

top
LastStringResultLen
property LastStringResultLen: Integer readonly
Introduced in version 9.5.0.53

The length, in characters, of the string contained in the LastStringResult property.

top
NumAttributes
property NumAttributes: Integer readonly

The number of attributes. For example, the following node has 2 attributes:

<tag attr1="value1" attr2="value2"> This is the content</tag>

More Information and Examples
top
NumChildren
property NumChildren: Integer readonly

The number of direct child nodes contained under this XML node.

top
SortCaseInsensitive
property SortCaseInsensitive: Integer

If true (or 1 for ActiveX), then all Sort* methods use case insensitive sorting.

top
Standalone
property Standalone: Integer

This is the standalone attribute in the XML declaration. This property can be set from any node in the XML document. A value of 1 adds a standalone="yes" to the XML declaration:

<?xml ... standalone="yes">

top
Tag
property Tag: WideString

The XML node's tag.

More Information and Examples
top
TreeId
property TreeId: Integer readonly

Each tree (or XML document) has a unique TreeId. This is the ID of the tree, and can be used to determine if two Xml objects belong to the same tree.

top
VerboseLogging
property VerboseLogging: Integer

If set to 1, then the contents of LastErrorText (or LastErrorXml, or LastErrorHtml) may contain more verbose information. The default value is 0. Verbose logging should only be used for debugging. The potentially large quantity of logged information may adversely affect peformance.

top
Version
property Version: WideString readonly

Version of the component/library, such as "9.5.0.63"

top

Methods

AccumulateTagContent
function AccumulateTagContent(tag: WideString; skipTags: WideString): WideString;

Accumulates the content of all nodes having a specific tag into a single result string. SkipTags specifies a set of subtrees to be avoided. The skipTags are formatted as a string of tags delimited by vertical bar characters. All nodes in sub-trees rooted with a tag appearing in skipTags are not included in the result.

Returns a zero-length WideString on failure

More Information and Examples
top
AddAttribute
function AddAttribute(name: WideString; value: WideString): Integer;

Adds an attribute to the calling node in the XML document. Returns True for success, and False for failure.

Returns 1 for success, 0 for failure.

top
AddAttributeInt
function AddAttributeInt(name: WideString; value: Integer): Integer;

Adds an integer attribute to a node.

Returns 1 for success, 0 for failure.

top
AddChildTree
function AddChildTree(tree: TChilkatXml): Integer;

Adds an entire subtree as a child. If the child was a subtree within another Xml document then the subtree is effectively transferred from one XML document to another.

Returns 1 for success, 0 for failure.

top
AddOrUpdateAttribute
procedure AddOrUpdateAttribute(name: WideString; value: WideString);

Adds an attribute to an XML node. If an attribute having the specified name already exists, the value is updated.

More Information and Examples
top
AddOrUpdateAttributeI
procedure AddOrUpdateAttributeI(name: WideString; value: Integer);

Adds an integer attribute to an XML node. If an attribute having the specified name already exists, the value is updated.

top
AddStyleSheet
procedure AddStyleSheet(styleSheet: WideString);

Adds a style sheet declaration to the XML document. The styleSheet should be a string such as:

<?xml-stylesheet href="mystyle.css" title="Compact" type="text/css"?>

top
AddToAttribute
procedure AddToAttribute(name: WideString; amount: Integer);

Adds an integer amount to an integer attribute's value. If the attribute does not yet exist, this method behaves the same as AddOrUpdateAttributeI.

More Information and Examples
top
AddToChildContent
procedure AddToChildContent(tag: WideString; amount: Integer);

Adds an integer value to the content of a child node.

top
AddToContent
procedure AddToContent(amount: Integer);

Adds an integer amount to the node's content.

top
AppendToContent
function AppendToContent(str: WideString): Integer;

Appends text to the content of an XML node

Returns 1 for success, 0 for failure.

top
BEncodeContent
function BEncodeContent(charset: WideString; inData: OleVariant): Integer;

Sets the node's content with 8bit data that is in a specified multibyte character encoding such as utf-8, shift-jis, big5, etc. The data is first B-encoded and the content is set to be the B-encoded string. For example, if called with "Big5"for the charset, you would get a string that looks something like this: "=?Big5?B?pHCtsw==?=". The data is Base64-encoded and stored between the last pair of "?" delimiters. Use the DecodeContent method to retrieve the byte data from a B encoded string.

Returns 1 for success, 0 for failure.

top
ChildContentMatches
function ChildContentMatches(tagPath: WideString; pattern: WideString; caseSensitive: Integer): Integer;

Return 1 if a child at the specified tagPath contains content that matches a wildcarded pattern. Otherwise returns 0.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "tagA|tagB|tagC".

top
ChilkatPath
function ChilkatPath(pathCmd: WideString): WideString;

Follows a series of commands to navigate through an XML document to return a piece of data or update the caller's reference to a new XML document node.

Note: This method not related to the XPath (XML Path) standard in any way.

The pathCmd is formatted as a series of commands separated by vertical bar characters, and terminated with a return-command:

    <i>command</i>|<i>command</i>|<i>command</i>|...|<i>returnCommand</i>

A command can be any of the following:

  1. TagName -- Navigate to the 1st direct child with the given tag.
  2. TagName[n] -- Navigate to the Nth direct child with the given tag.
  3. .. -- Navigate up to the parent
  4. TagName{Content} -- Navigate to the 1st direct child with the given tag having the exact content.
  5. /T/TagName -- Traverse the XML DOM tree (rooted at the caller) and navigate to the 1st node having the given tag.
  6. /C/TagName,ContentPattern -- Traverse the XML DOM tree (rooted at the caller) and navigate to the 1st node having the given tag with content that matches the ContentPattern. ContentPattern may use one or more asterisk ('*") characters to represent 0 or more of any character.
  7. /C/ContentPattern -- Traverse the XML DOM tree (rooted at the caller) and navigate to the 1st node having any tag with content that matches the ContentPattern. ContentPattern may use one or more asterisk ('*") characters to represent 0 or more of any character.
  8. /A/TagName,AttrName,AttrValuePattern -- Traverse the XML DOM tree (rooted at the caller) and navigate to the 1st node having the given tag, and attribute, with the attribute value that matches the AttrValuePattern. AttrValuePattern may use one or more asterisk ('*") characters to represent 0 or more of any character.
The returnCommand can be any of the following:
  1. * -- Return the Content of the node.
  2. (AttrName) -- Return the value of the given attribute.
  3. $ -- Update the caller's internal reference to be the node (arrived at by following the series of commands). Returns an empty string.

Returns a zero-length WideString on failure

top
Clear
procedure Clear();

Removes all children, attributes, and content from the XML node. Resets the tag name to "unnamed".

top
ContentMatches
function ContentMatches(pattern: WideString; caseSensitive: Integer): Integer;

Return true if the node's content matches a wildcarded pattern.

top
Copy
procedure Copy(node: TChilkatXml);

Copies the tag, content, and attributes to the calling node.

top
CopyRef
procedure CopyRef(copyFromNode: TChilkatXml);

Discards the caller's current internal reference and copies the internal reference from copyFromNode. Effectively updates the caller node to point to the same node in the XML document as copyFromNode.

top
DecodeContent
function DecodeContent(): OleVariant;

Decodes a node's Q or B-encoded content string and returns the byte data.

Returns a zero-length byte array (as an OleVariant) on failure.
An empty array will have a VarArrayHighBound of -1 meaning 0 elements.

top
DecodeEntities
function DecodeEntities(str: WideString): WideString;

Utility method to decode HTML entities. It accepts a string containing (potentially) HTML entities and returns a string with the entities decoded.

Returns a zero-length WideString on failure

top
DecryptContent
function DecryptContent(password: WideString): Integer;

Decrypts the content of an XML node that was previously 128-bit AES encrypted with the EncryptContent method.

Returns 1 for success, 0 for failure.

More Information and Examples
top
EncryptContent
function EncryptContent(password: WideString): Integer;

Encrypts the content of the calling XML node using 128-bit CBC AES encryption. The base64-encoded encrypted content replaces the original content.

Returns 1 for success, 0 for failure.

More Information and Examples
top
ExtractChildByIndex
function ExtractChildByIndex(index: Integer): TChilkatXml;

Removes and returns the Nth child of an XML node. The first child is at index 0.

Returns nil on failure

top
ExtractChildByName
function ExtractChildByName(tagPath: WideString; attrName: WideString; attrValue: WideString): TChilkatXml;

Removes and returns the first child node at the specified tag or tag path. The attrName and attrValue may be empty, in which case the first child matching the tag is removed and returned. If attrName is specified, then the first child having a tag equal to tagPath, and an attribute with attrName is returned. If attrValue is also specified, then only a child having a tag equal to tagPath, and an attribute named attrName, with a value equal to attrValue is returned.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "tagA|tagB|tagC".

Returns nil on failure

More Information and Examples
top
FindChild
function FindChild(tagPath: WideString): TChilkatXml;

Returns the child with the given tag or at the specified tag path.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "tagA|tagB|tagC".

Returns nil on failure

top
FindChild2
function FindChild2(tagPath: WideString): Integer;

Updates the Xml object's internal reference to point to a child at the specified tag or tagPath.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "tagA|tagB|tagC".

Returns 1 for success, 0 for failure.

top
FindNextRecord
function FindNextRecord(tagPath: WideString; contentPattern: WideString): TChilkatXml;

Returns the next record node where the child with a specific tag matches a wildcarded pattern. This method makes it easy to iterate over high-level records.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "tagA|tagB|tagC".

Returns nil on failure

More Information and Examples
top
FindOrAddNewChild
function FindOrAddNewChild(tagPath: WideString): TChilkatXml;

First checks for a child at tagPath, and if found, returns it. Otherwise creates a new child with empty content.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "tagA|tagB|tagC".

Returns nil on failure

top
FirstChild
function FirstChild(): TChilkatXml;

Returns the first child. A program can step through the children by calling FirstChild, and then NextSibling repeatedly.

Returns nil on failure

top
FirstChild2
function FirstChild2(): Integer;

Updates the internal reference of the caller to point to its first child.

Returns 1 for success, 0 for failure.

top
GetAttributeName
function GetAttributeName(index: Integer): WideString;

Returns the name of the Nth attribute of an XML node. The first attribute is at index 0.

Returns a zero-length WideString on failure

More Information and Examples
top
GetAttributeValue
function GetAttributeValue(index: Integer): WideString;

Returns the value of the Nth attribute of an XML node. The first attribute is at index 0.

Returns a zero-length WideString on failure

More Information and Examples
top
GetAttributeValueInt
function GetAttributeValueInt(index: Integer): Integer;

Returns an attribute as an integer. Returns 0 if the attribute does not exist.

top
GetAttrValue
function GetAttrValue(name: WideString): WideString;

Find and return the value of an attribute having a specified name.

Returns a zero-length WideString on failure

More Information and Examples
top
GetAttrValueInt
function GetAttrValueInt(name: WideString): Integer;

Returns an attribute as an integer. Returns 0 if the attribute does not exist.

More Information and Examples
top
GetBinaryContent
function GetBinaryContent(unzipFlag: Integer; decryptFlag: Integer; password: WideString): OleVariant;

Returns binary content of an XML node as a byte array. The content may have been Zip compressed, AES encrypted, or both. Unzip compression and AES decryption flags should be set appropriately.

Returns a zero-length byte array (as an OleVariant) on failure.
An empty array will have a VarArrayHighBound of -1 meaning 0 elements.

top
GetChild
function GetChild(index: Integer): TChilkatXml;

Returns the Nth child of an XML node

Returns nil on failure

More Information and Examples
top
GetChild2
function GetChild2(index: Integer): Integer;

Updates the calling object's internal reference to the Nth child node.

Returns 1 for success, 0 for failure.

top
GetChildBoolValue
function GetChildBoolValue(tagPath: WideString): Integer;

Returns 0 if the node's content is "0", otherwise returns 1 if the node contains a non-zero integer. The tagPath can be a tag or a tag path.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "colors|primary|red".

More Information and Examples
top
GetChildContent
function GetChildContent(tagPath: WideString): WideString;

Returns the content of a child having a specified tag. The tagPath can be a tag or a tag path.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "colors|primary|red".

Returns a zero-length WideString on failure

More Information and Examples
top
GetChildContentByIndex
function GetChildContentByIndex(index: Integer): WideString;

Returns the content of the Nth child node.

Returns a zero-length WideString on failure

top
GetChildExact
function GetChildExact(tag: WideString; content: WideString): TChilkatXml;

Returns the child having the exact tag and content.

Returns nil on failure

top
GetChildIntValue
function GetChildIntValue(tagPath: WideString): Integer;

Returns the child integer content for a given tag. The tagPath can be a tag or a tag path.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "colors|primary|red".

More Information and Examples
top
GetChildTag
function GetChildTag(index: Integer): WideString;

Returns the tag name of the Nth child node.

Returns a zero-length WideString on failure

top
GetChildTagByIndex
function GetChildTagByIndex(index: Integer): WideString;

Returns the tag name of the Nth child node.

Returns a zero-length WideString on failure

More Information and Examples
top
GetChildWithAttr
function GetChildWithAttr(tagPath: WideString; attrName: WideString; attrValue: WideString): TChilkatXml;

Finds and returns the XML child node having both a given tag and an attribute with a given name and value.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "tagA|tagB|tagC".

Returns nil on failure

More Information and Examples
top
GetChildWithContent
function GetChildWithContent(content: WideString): TChilkatXml;

Returns the first child found having the exact content specified.

Returns nil on failure

top
GetChildWithTag
function GetChildWithTag(tagPath: WideString): TChilkatXml;

Returns the child at the specified tag or tag path.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "tagA|tagB|tagC".

Returns nil on failure

top
GetNthChildWithTag
function GetNthChildWithTag(tag: WideString; n: Integer): TChilkatXml;

Returns the Nth child having a tag that matches exactly with the tagName. Use the NumChildrenHavingTag method to determine how many children have a particular tag.

Returns nil on failure

top
GetNthChildWithTag2
function GetNthChildWithTag2(tag: WideString; n: Integer): Integer;

Updates the calling object's internal reference to the Nth child node having a specific tag.

Returns 1 for success, 0 for failure.

top
GetParent
function GetParent(): TChilkatXml;

Returns the parent of this XML node, or NULL if the node is the root of the tree.

Returns nil on failure

top
GetParent2
function GetParent2(): Integer;

Updates the internal reference of the caller to its parent.

Returns 1 for success, 0 for failure.

top
GetRoot
function GetRoot(): TChilkatXml;

Returns the root node of the XML document

Returns nil on failure

top
GetRoot2
procedure GetRoot2();

Updates the internal reference of the caller to the document root.

top
GetSelf
function GetSelf(): TChilkatXml;

Returns a new XML object instance that references the same XML node.

Returns nil on failure

top
GetXml
function GetXml(): WideString;

Generate the XML text document for the XML tree rooted at this node. If called from the root node of the XML document, then the XML declarator ("<?xml version="1.0" encoding="utf-8" ?>") is included at the beginning of the XML. Otherwise, it is not included.

Returns a zero-length WideString on failure

top
GetXmlSb
function GetXmlSb(sb: TChilkatStringBuilder): Integer;
Introduced in version 9.5.0.62

Emits the XML to a StringBuilder object. (Appends to the existing contents of sb.)

Returns 1 for success, 0 for failure.

top
HasAttribute
function HasAttribute(name: WideString): Integer;

Returns true if the node contains an attribute with the specified name.

top
HasAttrWithValue
function HasAttrWithValue(name: WideString; value: WideString): Integer;

Returns true if the node contains attribute with the name and value.

top
HasChildWithContent
function HasChildWithContent(content: WideString): Integer;

Returns true if the node has a direct child node containing the exact content string specified.

top
HasChildWithTag
function HasChildWithTag(tagPath: WideString): Integer;

Returns 1 if the node has a child with the given tag (or tag path). Otherwise returns 0.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "tagA|tagB|tagC".

More Information and Examples
top
HasChildWithTagAndContent
function HasChildWithTagAndContent(tagPath: WideString; content: WideString): Integer;

Returns 1 if the node contains child with the given tag (or tag path) and content specified.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "tagA|tagB|tagC".

top
InsertChildTreeAfter
procedure InsertChildTreeAfter(index: Integer; tree: TChilkatXml);

Adds an entire subtree as a child. If the child was a subtree within another Xml document then the subtree is effectively transferred from one XML document to another. The child tree is inserted in a position after the Nth child (of the calling node).

top
InsertChildTreeBefore
procedure InsertChildTreeBefore(index: Integer; tree: TChilkatXml);

Adds an entire subtree as a child. If the child was a subtree within another Xml document then the subtree is effectively transferred from one XML document to another. The child tree is inserted in a position before the Nth child (of the calling node).

top
LastChild
function LastChild(): TChilkatXml;

Returns the last Xml child node. A node's children can be enumerated by calling LastChild and then repeatedly calling PreviousSibling, until a NULL is returned.

Returns nil on failure

top
LastChild2
function LastChild2(): Integer;

Updates the internal reference of the caller to its last child.

Returns 1 for success, 0 for failure.

top
LoadSb
function LoadSb(sb: TChilkatStringBuilder; autoTrim: Integer): Integer;
Introduced in version 9.5.0.62

Loads XML from the contents of a StringBuilder object.

Returns 1 for success, 0 for failure.

top
LoadXml
function LoadXml(xmlData: WideString): Integer;

Loads an XML document from a memory buffer and returns 1 if successful. The contents of the calling node are replaced with the root node of the XML document loaded.

Returns 1 for success, 0 for failure.

top
LoadXml2
function LoadXml2(xmlData: WideString; autoTrim: Integer): Integer;

Same as LoadXml, but an additional argument controls whether or not leading/trailing whitespace is auto-trimmed from each leaf node's content.

Returns 1 for success, 0 for failure.

More Information and Examples
top
LoadXmlFile
function LoadXmlFile(fileName: WideString): Integer;

Loads an XML document from a file and returns 1 if successful. The contents of the calling node are replaced with the root node of the XML document loaded.

Returns 1 for success, 0 for failure.

top
LoadXmlFile2
function LoadXmlFile2(fileName: WideString; autoTrim: Integer): Integer;

Same as LoadXmlFile, but an additional argument controls whether or not leading/trailing whitespace is auto-trimmed from each leaf node's content.

Returns 1 for success, 0 for failure.

More Information and Examples
top
NewChild
function NewChild(tagPath: WideString; content: WideString): TChilkatXml;

Creates a new child having tag and content. The new child is created even if a child with a tag equal to tagPath already exists. (Use FindOrAddNewChild to prevent creating children having the same tags.)

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "colors|primary|red". See the example below for details.

Returns nil on failure

top
NewChild2
procedure NewChild2(tagPath: WideString; content: WideString);

Creates a new child node, but does not return the node that is created. The tagPath can be a tag or a tag path.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "colors|primary|red". See the example below for details.

top
NewChildAfter
function NewChildAfter(index: Integer; tag: WideString; content: WideString): TChilkatXml;

Inserts a new child in a position after the Nth child node.

Returns nil on failure

top
NewChildBefore
function NewChildBefore(index: Integer; tag: WideString; content: WideString): TChilkatXml;

Inserts a new child in a position before the Nth child node.

Returns nil on failure

top
NewChildInt2
procedure NewChildInt2(tagPath: WideString; value: Integer);

Inserts a new child having an integer for content. The tagPath can be a tag or a tag path.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "colors|primary|red". See the example below for details.

More Information and Examples
top
NextSibling
function NextSibling(): TChilkatXml;

Returns the nodes next sibling, or NULL if there are no more.

Returns nil on failure

top
NextSibling2
function NextSibling2(): Integer;

Updates the internal reference of the caller to its next sibling.

Returns 1 for success, 0 for failure.

top
NumChildrenAt
function NumChildrenAt(tagPath: WideString): Integer;
Introduced in version 9.5.0.64

Returns the number of children for the node indicated by tagPath. Returns -1 if the node at tagPath does not exist.

top
NumChildrenHavingTag
function NumChildrenHavingTag(tag: WideString): Integer;

Returns the number of children having a specific tag name.

top
PreviousSibling
function PreviousSibling(): TChilkatXml;

Returns the Xml object that is the node's previous sibling, or NULL if there are no more.

Returns nil on failure

top
PreviousSibling2
function PreviousSibling2(): Integer;

Updates the internal reference of the caller to its previous sibling.

Returns 1 for success, 0 for failure.

top
QEncodeContent
function QEncodeContent(charset: WideString; inData: OleVariant): Integer;

Sets the node's content with 8bit data that is in a specified multibyte character encoding such as utf-8, shift-jis, big5, etc. The data is first Q-encoded and the content is set to be the Q-encoded string. For example, if called with "gb2312"for the charset, you would get a string that looks something like this: "=?gb2312?Q?=C5=B5=BB=F9?=". Character that are not 7bit are represented as "=XX" where XX is the hexidecimal value of the byte. Use the DecodeContent method to retrieve the byte data from a Q encoded string.

Returns 1 for success, 0 for failure.

top
RemoveAllAttributes
function RemoveAllAttributes(): Integer;

Removes all attributes from an XML node. Should always return True.

Returns 1 for success, 0 for failure.

top
RemoveAllChildren
procedure RemoveAllChildren();

Removes all children from the calling node.

top
RemoveAttribute
function RemoveAttribute(name: WideString): Integer;

Removes an attribute by name from and XML node.

Returns 1 for success, 0 for failure.

top
RemoveChild
procedure RemoveChild(tagPath: WideString);

Removes all children with a given tag or tag path.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "tagA|tagB|tagC".

top
RemoveChildByIndex
procedure RemoveChildByIndex(index: Integer);

Removes the Nth child from the calling node.

More Information and Examples
top
RemoveChildWithContent
procedure RemoveChildWithContent(content: WideString);

Removes all children having the exact content specified.

More Information and Examples
top
RemoveFromTree
procedure RemoveFromTree();

Removes the calling object and its sub-tree from the XML document making it the root of its own tree.

More Information and Examples
top
SaveBinaryContent
function SaveBinaryContent(filename: WideString; unzipFlag: Integer; decryptFlag: Integer; password: WideString): Integer;

Saves a node's binary content to a file.

Returns 1 for success, 0 for failure.

top
SaveXml
function SaveXml(fileName: WideString): Integer;

Generates XML representing the tree or subtree rooted at this node and writes it to a file.

Returns 1 for success, 0 for failure.

top
SearchAllForContent
function SearchAllForContent(afterPtr: TChilkatXml; contentPattern: WideString): TChilkatXml;

Returns the first node having content matching the contentPattern. The contentPattern is a case-sensitive string that may contain any number of '*'s, each representing 0 or more occurrences of any character. The search is breadth-first over the sub-tree rooted at the caller. A match is returned only after the search has traversed past the node indicated by afterPtr. To find the 1st occurrence, set afterPtr equal to nil. (For the ActiveX implementation, the afterPtr should never be nil. A reference to the caller's node should be passed instead.)

To iterate over matching nodes, the returned node can be passed in afterPtr for the next call to SearchAllForContent, until the method returns nil.

Returns nil on failure

More Information and Examples
top
SearchAllForContent2
function SearchAllForContent2(afterPtr: TChilkatXml; contentPattern: WideString): Integer;

Same as SearchAllForContent except the internal reference of the caller is updated to point to the search result (instead of returning a new object).

Returns 1 for success, 0 for failure.

top
SearchForAttribute
function SearchForAttribute(afterPtr: TChilkatXml; tag: WideString; attr: WideString; valuePattern: WideString): TChilkatXml;

Returns the first node having a tag equal to tag, an attribute named attr, whose value matches valuePattern. The valuePattern is a case-sensitive string that may contain any number of '*'s, each representing 0 or more occurrences of any character. The search is breadth-first over the sub-tree rooted at the caller. A match is returned only after the search has traversed past the node indicated by afterPtr. To find the 1st occurrence, set afterPtr equal to nil. (For the ActiveX implementation, the afterPtr should never be nil. A reference to the caller's node should be passed instead.)

To iterate over matching nodes, the returned node can be passed in afterPtr for the next call to SearchForAttribute, until the method returns nil.

Returns nil on failure

top
SearchForAttribute2
function SearchForAttribute2(afterPtr: TChilkatXml; tag: WideString; attr: WideString; valuePattern: WideString): Integer;

Same as SearchForAttribute except the internal reference of the caller is updated to point to the search result (instead of returning a new object).

Returns 1 for success, 0 for failure.

top
SearchForContent
function SearchForContent(afterPtr: TChilkatXml; tag: WideString; contentPattern: WideString): TChilkatXml;

Returns the first node having a tag equal to tag, whose content matches contentPattern. The contentPattern is a case-sensitive string that may contain any number of '*'s, each representing 0 or more occurrences of any character. The search is breadth-first over the sub-tree rooted at the caller. A match is returned only after the search has traversed past the node indicated by afterPtr. To find the 1st occurrence, set afterPtr equal to nil. (For the ActiveX implementation, the afterPtr should never be nil. A reference to the caller's node should be passed instead.)

To iterate over matching nodes, the returned node can be passed in afterPtr for the next call to SearchForContent, until the method returns nil.

Returns nil on failure

More Information and Examples
top
SearchForContent2
function SearchForContent2(afterPtr: TChilkatXml; tag: WideString; contentPattern: WideString): Integer;

Same as SearchForContent except the internal reference of the caller is updated to point to the search result (instead of returning a new object).

Returns 1 for success, 0 for failure.

More Information and Examples
top
SearchForTag
function SearchForTag(afterPtr: TChilkatXml; tag: WideString): TChilkatXml;

Returns the first node having a tag equal to tag. The search is breadth-first over the sub-tree rooted at the caller. A match is returned only after the search has traversed past the node indicated by afterPtr. To find the 1st occurrence, set afterPtr equal to nil. (For the ActiveX implementation, the afterPtr should never be nil. A reference to the caller's node should be passed instead.)

To iterate over matching nodes, the returned node can be passed in afterPtr for the next call to SearchForTag, until the method returns nil.

Returns nil on failure

top
SearchForTag2
function SearchForTag2(afterPtr: TChilkatXml; tag: WideString): Integer;

Same as SearchForTag except the internal reference of the caller is updated to point to the search result (instead of returning a new object).

Returns 1 for success, 0 for failure.

top
SetBinaryContent
function SetBinaryContent(inData: OleVariant; zipFlag: Integer; encryptFlag: Integer; password: WideString): Integer;

Sets the node's content to a block of binary data with optional Zip compression and/or AES encryption. The binary data is automatically converted to base64 format whenever XML text is generated. If the zipFlag is True, the data is first compressed. If the encryptFlag is True, the data is AES encrypted using the Rijndael 128-bit symmetric-encryption algorithm.

Returns 1 for success, 0 for failure.

top
SetBinaryContentFromFile
function SetBinaryContentFromFile(filename: WideString; zipFlag: Integer; encryptFlag: Integer; password: WideString): Integer;

Sets the node's content with binary (or text) data from a file. The file contents can be Zip compressed and/or encrypted, and the result is base-64 encoded.

Returns 1 for success, 0 for failure.

top
SortByAttribute
procedure SortByAttribute(attrName: WideString; ascending: Integer);

Sorts the direct child nodes by the value of a specified attribute.

top
SortByAttributeInt
procedure SortByAttributeInt(attrName: WideString; ascending: Integer);

Sorts the direct child nodes by the value of a specified attribute interpreted as an integer (not lexicographically as strings).

top
SortByContent
procedure SortByContent(ascending: Integer);

Sorts the direct child nodes by content.

More Information and Examples
top
SortByTag
procedure SortByTag(ascending: Integer);

Sorts the direct child nodes by tag.

More Information and Examples
top
SortRecordsByAttribute
procedure SortRecordsByAttribute(sortTag: WideString; attrName: WideString; ascending: Integer);

Sorts the direct child nodes by the content of an attribute in the grandchild nodes.

top
SortRecordsByContent
procedure SortRecordsByContent(sortTag: WideString; ascending: Integer);

Sorts the direct child nodes by the content of the grandchild nodes.

More Information and Examples
top
SortRecordsByContentInt
procedure SortRecordsByContentInt(sortTag: WideString; ascending: Integer);

Sorts the direct child nodes by the content of the grandchild nodes. For sorting purposes, the content is interpreted as an integer (not lexicographically as for strings).

top
SwapNode
function SwapNode(node: TChilkatXml): Integer;

Swaps another node's tag, content, and attributes with this one.

Returns 1 for success, 0 for failure.

top
SwapTree
function SwapTree(tree: TChilkatXml): Integer;

Swaps another node's tag, content, attributes, and children with this one.

Returns 1 for success, 0 for failure.

top
TagContent
function TagContent(tagName: WideString): WideString;

Returns the content of the 1st node found in the sub-tree rooted at the caller that has a given tag. (Note: The search for the node having tag ARG is not limited to the direct children of the caller.)

Returns a zero-length WideString on failure

top
TagEquals
function TagEquals(tag: WideString): Integer;

Returns 1 if the node's tag equals the specified string.

top
UnzipContent
function UnzipContent(): Integer;

Unzip the content of the XML node replacing it's content with the decompressed data.

Returns 1 for success, 0 for failure.

More Information and Examples
top
UnzipTree
function UnzipTree(): Integer;

Unzips and recreates the XML node and the entire subtree, restoring it to the state before it was zip compressed.

Returns 1 for success, 0 for failure.

More Information and Examples
top
UpdateAt
function UpdateAt(tagPath: WideString; autoCreate: Integer; value: WideString): Integer;
Introduced in version 9.5.0.64

Updates the content for the node indicated by tagPath. If autoCreate is 1, then nodes along tagPath are auto-created as needed.

More Information and Examples
top
UpdateAttrAt
function UpdateAttrAt(tagPath: WideString; autoCreate: Integer; attrName: WideString; attrValue: WideString): Integer;
Introduced in version 9.5.0.64

Updates or adds the attribute value for the node indicated by tagPath. If autoCreate is 1, then nodes along tagPath are auto-created as needed.

top
UpdateAttribute
function UpdateAttribute(attrName: WideString; attrValue: WideString): Integer;

Adds an attribute to the node if it doesn't already exist. Otherwise it updates the existing attribute with the new value.

Returns 1 for success, 0 for failure.

More Information and Examples
top
UpdateAttributeInt
function UpdateAttributeInt(attrName: WideString; value: Integer): Integer;

Updates an attribute value. (Call UpdateAttribute if the attribute value is a string.)

Returns 1 for success, 0 for failure.

top
UpdateChildContent
procedure UpdateChildContent(tagPath: WideString; value: WideString);

Replaces the content of a child node. The tagPath can be a tag or tag path.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "tagA|tagB|tagC".

top
UpdateChildContentInt
procedure UpdateChildContentInt(tagPath: WideString; value: Integer);

Replaces the content of a child node where the content is an integer. The tagPath can be a tag or tag path.

Beginning in version 9.5.0.64, the tagPath can be a tag path. A tag path is a series of tags separated by vertical bar characters. For example: "tagA|tagB|tagC".

top
ZipContent
function ZipContent(): Integer;

Applies Zip compression to the content of an XML node and replaces the content with base64-encoded compressed data.

Returns 1 for success, 0 for failure.

More Information and Examples
top
ZipTree
function ZipTree(): Integer;

Zip compresses the content and entire subtree rooted at the calling XML node and replaces the current content with base64-encoded Zip compressed data. The node and subtree can be restored by calling UnzipTree. Note that the node name and attributes are unaffected.

Returns 1 for success, 0 for failure.

More Information and Examples
top