ChilkatXml ActiveX Reference
ChilkatXml
A free non-validating XML parser component with encryption and compression features.
Object Creation
(Visual Basic 6.0)
Dim obj As New ChilkatXml
(ASP)
set obj = Server.CreateObject("Chilkat.Xml")
(VBScript)
set obj = CreateObject("Chilkat.Xml")
(Delphi)
obj := TChilkatXml.Create(Self);
(FoxPro)
loObject = CreateObject('Chilkat.Xml')
(SQL Server)
EXEC @hr = sp_OACreate 'Chilkat.Xml', @obj OUT
(Javascript)
var obj = new ActiveXObject("Chilkat.Xml");
Properties
Cdata As Long
When True, causes an XML node's content to be encapsulated in a CDATA section.
Content As String
This is the content of the XML node. It is the text between the open and close tags, such as:This is the content Content vs. Children: A common misconception explained.
ContentInt As Long
Set/get the content as an integer.
Encoding As String
This is the encoding attribute in the XML declaration, such as "utf-8" or "iso-8859-1". If not present, this property returns an empty string. 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.
LastErrorHtml As String (read-only)
To be documented soon.Error information in HTML format for the last method called.
LastErrorText As String (read-only)
To be documented soon.Error information in plain-text format for the last method called.
LastErrorXml As String (read-only)
To be documented soon.Error information in XML format for the last method called.
NumAttributes As Long (read-only)
The number of attributes. For example, the following node has 2 attributes: This is the content
NumChildren As Long (read-only)
The number of child nodes contained under this XML node.
SortCaseInsensitive As Long
If true (or 1 for ActiveX), then all Sort* methods use case insensitive sorting.
Standalone As Long
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">
Tag As String
The XML node's tag.
TreeId As Long (read-only)
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.
Version As String (read-only)
The version of the XML component, such as "2.0.0".
Methods
AccumulateTagContent(tag As String, skipTags As String) As String
Accumulates the content of all nodes having a specific tag into a single result string. SkipTags specifies a set of tags whose are 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 null on failure
AddAttribute(name As String, value As String) As Long
Adds an attribute to the calling node in the XML document. Returns True for success, and False for failure.
AddAttributeInt(name As String, value As Long) As Long
Adds an integer attribute to a node.
AddChildTree(tree As ChilkatXml) As Long
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.
AddOrUpdateAttribute(name As String, value As String)
Adds an attribute to an XML node. If an attribute having the specified name already exists, the value is updated.
AddOrUpdateAttributeI(name As String, value As Long)
Adds an integer attribute to an XML node. If an attribute having the specified name already exists, the value is updated.
AddStyleSheet(styleSheet As String)
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"?>
AddToAttribute(name As String, amount As Long)
Adds an integer amount to an integer attribute's value. If the attribute does not yet exist, this method behaves the same as AddOrUpdateAttributeI.
AddToChildContent(tag As String, amount As Long)
Adds an integer value to the content of a child node.
AddToContent(amount As Long)
Adds an integer amount to the node's content.
AppendToContent(str As String) As Long
Appends text to the content of an XML node
BEncodeContent(charset As String, inData As Variant) As Long
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.
ChildContentMatches(tag As String, pattern As String, caseSensitive As Long) As Long
Return true if a child having a specific tag contains content that matches a wildcarded pattern.
Clear()
Removes all children, attributes, and content from the XML node. Resets the tag name to "unnamed".
CompressNode() As Long
Applies Zip compression to the content of an XML node and replaces the content with base64-encoded compressed data.
CompressSubtree() As Long
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.
ContentMatches(pattern As String, caseSensitive As Long) As Long
Return true if the node's content matches a wildcarded pattern.
Copy(node As ChilkatXml)
Copies the tag, content, and attributes to the calling node.
DecodeContent() As Variant
Decodes a node's Q or B-encoded content string and returns the byte data. Returns a zero-length byte array (as a Variant) on failure
DecodeEntities(str As String) As String
Utility method to decode HTML entities. It accepts a string containing (potentially) HTML entities and returns a string with the entities decoded. Returns a null on failure
DecompressNode() As Long
Unzip the content of the XML node replacing it's content with the decompressed data.
DecompressSubtree() As Long
Unzips and recreates the XML node and the entire subtree, restoring it to the state before it was zip compressed.
DecryptContent(password As String) As Long
Decrypts the content of an XML node that was previously 128-bit AES encrypted with the EncryptContent method.
DecryptNode(password As String) As Long
Decrypts the content of an XML node that was previously 128-bit AES encrypted with the EncryptContent method.
EncryptContent(password As String) As Long
AES encrypts the content of the calling XML node using 128-bit Rijndael encryption.
EncryptNode(password As String) As Long
AES encrypts the content of the calling XML node using 128-bit Rijndael encryption.
ExtractChildByIndex(index As Long) As ChilkatXml
Removes and returns the Nth child of an XML node. The first child is at index 0.
ExtractChildByName(tag As String, attrName As String, attrValue As String) As ChilkatXml
Removes and returns the first child node having a tag equal to the tagName. The attributeName and attrValue may be empty or NULL, in which case the first child matching the tag is removed and returned. If attributeName is specified, then the first child having a tag equal to tagName, and an attribute with attributeName is returned. If attrValue is also specified, then only a child having a tag equal to tagName, and an attribute named attributeName, with a value equal to attrValue is returned.
FindChild(tag As String) As ChilkatXml
Returns the child having a specified tag.
FindChild2(tag As String) As Long
Updates the Xml object's internal reference to point to a child with a specified tag.
FindNextRecord(tag As String, contentPattern As String) As ChilkatXml
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.
FindOrAddNewChild(tag As String) As ChilkatXml
First searches for a child having a tag equal to tagName, and if found, returns it. Otherwise creates a new child, sets the tag equal to tagName, and initializes the Content to empty.
FirstChild() As ChilkatXml
Returns the first child. A program can step through the children by calling FirstChild, and then NextSibling repeatedly.
FirstChild2() As Long
Updates the internal reference of the caller to point to its first child. More information about XML methods ending in "2"
GetAttrValue(name As String) As String
Find and return the value of an attribute having a specified name. Returns a null on failure
GetAttrValueInt(name As String) As Long
Returns an attribute as an integer.
GetAttributeName(index As Long) As String
Returns the name of the Nth attribute of an XML node. The first attribute is at index 0. Returns a null on failure
GetAttributeValue(index As Long) As String
Returns the value of the Nth attribute of an XML node. The first attribute is at index 0. Returns a null on failure
GetAttributeValueInt(index As Long) As Long
Returns an attribute as an integer.
GetBinaryContent(unzipFlag As Long, decryptFlag As Long, password As String) As Variant
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 a Variant) on failure
GetChild(index As Long) As ChilkatXml
Returns the Nth child of an XML node
GetChild2(index As Long) As Long
Updates the calling object's internal reference to the Nth child node. Returns 1 for success, 0 for failure. More information about XML methods ending in "2"
GetChildBoolValue(tag As String) As Long
Returns 0 if the node's content is "0", otherwise returns 1 if the node contains a non-zero integer.
GetChildContent(tag As String) As String
Returns the content of a child having a specified tag. Returns a null on failure
GetChildContentByIndex(index As Long) As String
Returns the content of the Nth child node. Returns a null on failure
GetChildExact(tag As String, content As String) As ChilkatXml
Returns the child having the exact tag and content.
GetChildIntValue(tag As String) As Long
Returns the child integer content for a given tag.
GetChildTag(index As Long) As String
Returns the tag name of the Nth child node. Returns a null on failure
GetChildTagByIndex(index As Long) As String
Returns the tag name of the Nth child node. Returns a null on failure
GetChildWithTag(tag As String) As ChilkatXml
Returns the Xml child object having a tag matching tagName.
GetNthChildWithTag(tag As String, n As Long) As ChilkatXml
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.
GetNthChildWithTag2(tag As String, n As Long) As Long
Updates the calling object's internal reference to the Nth child node having a specific tag. Returns 1 for success, 0 for failure.
GetParent() As ChilkatXml
Returns the parent of this XML node, or NULL if the node is the root of the tree.
GetParent2() As Long
Updates the internal reference of the caller to its parent. More information about XML methods ending in "2"
GetRoot() As ChilkatXml
Returns the root node of the XML document
GetRoot2()
Updates the internal reference of the caller to the document root. More information about XML methods ending in "2"
GetXml() As String
Generate the XML text document for the XML tree rooted at this node. Returns a null on failure
HasAttrWithValue(name As String, value As String) As Long
Returns true if the node contains attribute with the name and value.
HasAttribute(name As String) As Long
Returns true if the node contains an attribute with the specified name.
HasChildWithContent(content As String) As Long
Returns true if the node has a child node containing the exact content string specified.
HasChildWithTag(tag As String) As Long
Returns true (1 for ActiveX) if the node has a child with a given tag.
HasChildWithTagAndContent(tag As String, content As String) As Long
Returns true if the node contains a child having the exact tag and content specified.
HttpGet(url As String) As ChilkatXml
Gets an XML document from a URL. This can be tested with the following URL: http://www.chilkatsoft.com/test.xml
HttpPost(url As String) As ChilkatXml
Provides client-side protocol support for communication with HTTP servers. A client can use this method to send an arbitrary HTTP request, receive the response, and have Chilkat XML.NET parse that response.The request body is sent directly from the Chilkat XML object and the response is parsed directly into the returned Chilkat XML object. When combined with the support for Extensible Stylesheet Language (XSL), this provides an easy way to send structured queries to HTTP servers and efficiently display the results with a variety of presentations.
InsertChildTreeAfter(index As Long, tree As ChilkatXml)
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).
InsertChildTreeBefore(index As Long, tree As ChilkatXml)
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).
LastChild() As ChilkatXml
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.
LastChild2() As Long
Updates the internal reference of the caller to its last child.
LoadXml(xmlData As String) As Long
Loads an XML document from a memory buffer and returns True if successful. The contents of the calling node are replaced with the root node of the XML document loaded.
LoadXml2(xmlData As String, autoTrim As Long) As Long
Same as LoadXml, but an additional argument controls whether or not leading/trailing whitespace is auto-trimmed from each node's content. Returns 1 for success, 0 for failure.
LoadXmlFile(fileName As String) As Long
Loads an XML document from a file and returns True if successful. The contents of the calling node are replaced with the root node of the XML document loaded.
LoadXmlFile2(fileName As String, autoTrim As Long) As Long
Same as LoadXmlFile, but an additional argument controls whether or not leading/trailing whitespace is auto-trimmed from each node's content. Returns 1 for success, 0 for failure.
LoadXmlV(xmlDoc As Variant) As Long
Loads XML from a byte array containing the XML document.
NewChild(tag As String, content As String) As ChilkatXml
Creates a new child having tag and content. The new child is created even if a child with a tag equal to tagName already exists. (Use FindOrAddNewChild to prevent creating children having the same tags.)
NewChild2(tag As String, content As String)
Creates a new child but does not return the node that is created.
NewChildAfter(index As Long, tag As String, content As String) As ChilkatXml
Inserts a new child in a position after the Nth child node.
NewChildBefore(index As Long, tag As String, content As String) As ChilkatXml
Inserts a new child in a position before the Nth child node.
NewChildInt2(tag As String, value As Long)
Inserts a new child having an integer for content.
NextSibling() As ChilkatXml
Returns the nodes next sibling, or NULL if there are no more.
NextSibling2() As Long
Updates the internal reference of the caller to its next sibling. More information about XML methods ending in "2"
NumChildrenHavingTag(tag As String) As Long
Returns the number of children having a specific tag name.
PreviousSibling() As ChilkatXml
Returns the Xml object that is the node's previous sibling, or NULL if there are no more.
PreviousSibling2() As Long
Updates the internal reference of the caller to its previous sibling. More information about XML methods ending in "2"
QEncodeContent(charset As String, inData As Variant) As Long
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.
RemoveAllAttributes() As Long
Removes all attributes from an XML node. Should always return True.
RemoveAllChildren()
Removes all children from the calling node.
RemoveAttribute(name As String) As Long
Removes an attribute by name from and XML node.
RemoveChild(tag As String)
Removes a child with a given tag.
RemoveChildByIndex(index As Long)
Removes the Nth child from the calling node.
RemoveChildWithContent(content As String)
Removes all children having the exact content specified.
RemoveFromTree()
Removes the calling object and its sub-tree from the XML document making it the root of its own tree.
SaveBinaryContent(filename As String, unzipFlag As Long, decryptFlag As Long, password As String) As Long
Saves a node's binary content to a file.
SaveLastError(filename As String) As Long
Saves the last error information to an XML formatted file.
SaveXml(fileName As String) As Long
Generates XML representing the tree or subtree rooted at this node and writes it to a file.
SearchAllForContent(after As ChilkatXml, contentPattern As String) As ChilkatXml
Returns the first node whose content matches the contentPattern, which is a case-sensitive string that can use any number of '*'s to represent 0 or more occurances of any character. The search is breadth-first over the tree, and the previous node returned can be passed to the next call as afterNode to continue the search after that node.
SearchAllForContent2(after As ChilkatXml, contentPattern As String) As Long
Same as SearchAllForContent except the internal reference of the caller is updated to point to the search result (instead of returning a new object).
SearchForAttribute(after As ChilkatXml, tag As String, attr As String, valuePattern As String) As ChilkatXml
Returns the first node having a tag equal to tagName, and an attribute named attrName whose value matches valuePattern, which is a case-sensitive string that can use any number of '*'s to represent 0 or more occurances of any character. The search is breadth-first over the tree, and the previous node returned can be passed to the next call as afterNode to continue the search after that node.
SearchForAttribute2(after As ChilkatXml, tag As String, attr As String, valuePattern As String) As Long
Same as SearchForAttribute except the internal reference of the caller is updated to point to the search result (instead of returning a new object).
SearchForContent(after As ChilkatXml, tag As String, contentPattern As String) As ChilkatXml
Returns the first node having a tag equal to tagName whose content matches contentPattern, which is a case-sensitive string that can use any number of '*'s to represent 0 or more occurances of any character. The search is breadth-first over the tree, and the previous node returned can be passed to the next call as afterNode to continue the search after that node.
SearchForContent2(after As ChilkatXml, tag As String, contentPattern As String) As Long
Same as SearchForContent except the internal reference of the caller is updated to point to the search result (instead of returning a new object).
SearchForTag(after As ChilkatXml, tag As String) As ChilkatXml
Returns the first node having a tag equal to tagName. The search is breadth-first over the tree, and the previous node returned can be passed to the next call as afterNode to continue the search after that node.
SearchForTag2(after As ChilkatXml, tag As String) As Long
Same as SearchForTag except the internal reference of the caller is updated to point to the search result (instead of returning a new object).
SetBinaryContent(inData As Variant, zipFlag As Long, encryptFlag As Long, password As String) As Long
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.
SetBinaryContentFromFile(filename As String, zipFlag As Long, encryptFlag As Long, password As String) As Long
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.
SortByAttribute(attrName As String, ascending As Long)
Sorts the child nodes by the value of a specified attribute.
SortByAttributeInt(attrName As String, ascending As Long)
Sorts the child nodes by the value of a specified attribute interpreted as an integer (not lexicographically as strings).
SortByContent(ascending As Long)
Sorts the child nodes by content.
SortByTag(ascending As Long)
Sorts the child nodes by tag.
SortRecordsByAttribute(sortTag As String, attrName As String, ascending As Long)
Sorts the child nodes by the content of an attribute in the grandchild nodes.
SortRecordsByContent(sortTag As String, ascending As Long)
Sorts the child nodes by the content of the grandchild nodes.
SwapNode(node As ChilkatXml) As Long
Swaps another node's tag, content, and attributes with this one.
SwapTree(tree As ChilkatXml) As Long
Swaps another node's tag, content, attributes, and children with this one.
TagEquals(tag As String) As Long
Returns 1 if the node's tag equals the specified string.
UnzipContent() As Long
Unzip the content of the XML node replacing it's content with the decompressed data.
UnzipTree() As Long
Unzips and recreates the XML node and the entire subtree, restoring it to the state before it was zip compressed.
UpdateAttribute(attrName As String, attrValue As String) As Long
Adds an attribute to the node if it doesn't already exist. Otherwise it updates the existing attribute with the new value.
UpdateAttributeInt(attrName As String, value As Long) As Long
Updates an attribute value. (Call UpdateAttribute if the attribute value is a string.)
UpdateChildContent(tag As String, value As String)
Replaces the content of a child node.
UpdateChildContentInt(tag As String, value As Long)
Replaces the content of a child node where the content is an integer.
ZipContent() As Long
Applies Zip compression to the content of an XML node and replaces the content with base64-encoded compressed data.
ZipTree() As Long
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.
|