Xml Excel Class Module Reference Documentation

Xml

Current Version: 9.5.0.78

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

Object Creation

Dim oXml As Chilkat.Xml
Set oXml = Chilkat.NewXml

Properties

Cdata
Cdata As Long

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

More Information and Examples
top
Content
Content As String

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
ContentInt As Long

Set/get the content as an integer.

top
DebugLogFilePath
DebugLogFilePath As String

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
DocType As String

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

More Information and Examples
top
EmitBom
EmitBom As Long
Introduced in version 9.5.0.44

If True, 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 False. This only applies when writing XML files. It does not apply when getting the XML as a string via the GetXml method.

top
EmitCompact
EmitCompact As Long
Introduced in version 9.5.0.64

If True, 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 False, which maintains backward compatibility.

More Information and Examples
top
EmitXmlDecl
EmitXmlDecl As Long

If True, 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 True. If set to False, the XML declaration is not emitted. (The XML declaration is the 1st line of an XML document starting with "<?xml ...".

top
Encoding
Encoding As String

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
I As Long
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
IsBase64
IsBase64 As Long (read only)
Introduced in version 9.5.0.76

Returns True if the content contains only those characters allowed in the base64 encoding. A base64 string is composed of characters 'A'..'Z', 'a'..'z', '0'..'9', '+', '/' and it is often padded at the end with up to two '=', to make the length a multiple of 4. Whitespace is ignored.

top
J
J As Long
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
K As Long
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
LastErrorHtml
LastErrorHtml As String (read only)

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
LastErrorText As String (read only)

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
LastErrorXml As String (read only)

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
LastMethodSuccess As Long
Introduced in version 9.5.0.52

Indicate whether the last method call succeeded or failed. A value of True indicates success, a value of False 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 = True and failure = False.
  • 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 True. For example, a method that returns no value (such as a "void" in C++) will technically always succeed.

top
NumAttributes
NumAttributes As Long (read only)

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
NumChildren As Long (read only)

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

top
SortCaseInsensitive
SortCaseInsensitive As Long

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

top
Standalone
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 True adds a standalone="yes" to the XML declaration:

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

top
Tag
Tag As String

The XML node's tag, including the namespace prefix.

More Information and Examples
top
TagNsPrefix
TagNsPrefix As String
Introduced in version 9.5.0.77

The node's namespace prefix, if present. For example, if the tag is "soapenv:Envelope", then this property will return "soapenv".

More Information and Examples
top
TagPath
TagPath As String (read only)
Introduced in version 9.5.0.77

Returns the path to reach this element from the XML document root. If the caller is the document root, then the empty string is returned.

More Information and Examples
top
TagUnprefixed
TagUnprefixed As String
Introduced in version 9.5.0.77

The node's tag without the namespace prefix. For example, if the tag is "soapenv:Envelope", then this property will return "Envelope".

More Information and Examples
top
TreeId
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.

top
VerboseLogging
VerboseLogging As Long

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

top
Version
Version As String (read only)

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

top

Methods

AccumulateTagContent
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 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 Nothing on failure

More Information and Examples
top
AddAttribute
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.

Returns True for success, False for failure.

top
AddAttributeInt
AddAttributeInt(name As String, value As Long) As Long

Adds an integer attribute to a node.

Returns True for success, False for failure.

top
AddChildTree
AddChildTree(tree As Xml) 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.

Returns True for success, False for failure.

top
AddOrUpdateAttribute
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.

More Information and Examples
top
AddOrUpdateAttributeI
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.

top
AddStyleSheet
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"?>

top
AddToAttribute
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.

More Information and Examples
top
AddToChildContent
AddToChildContent(tag As String, amount As Long)

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

top
AddToContent
AddToContent(amount As Long)

Adds an integer amount to the node's content.

top
AppendToContent
AppendToContent(str As String) As Long

Appends text to the content of an XML node

Returns True for success, False for failure.

top
ChildContentMatches
ChildContentMatches(tagPath As String, pattern As String, caseSensitive As Boolean) As Long

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

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
ChilkatPath(pathCmd As String) As String

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:

    command|command|command|...|returnCommand

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. "++" -- Navigate to the next sibling. (next/previous sibling feature added in v9.5.0.76)
  5. "--" -- Navigate to the previous sibling.
  6. TagName{Content} -- Navigate to the 1st direct child with the given tag having the exact content.
  7. /T/TagName -- Traverse the XML DOM tree (rooted at the caller) and navigate to the 1st node having the given tag.
  8. /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.
  9. /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.
  10. /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 Nothing on failure

top
Clear
Clear()

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

top
ContentMatches
ContentMatches(pattern As String, caseSensitive As Boolean) As Long

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

top
Copy
Copy(node As Xml)

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

top
CopyRef
CopyRef(copyFromNode As Xml)

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
DecodeEntities
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 Nothing on failure

top
DecryptContent
DecryptContent(password As String) As Long

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

Returns True for success, False for failure.

More Information and Examples
top
EncryptContent
EncryptContent(password As String) As Long

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

Returns True for success, False for failure.

More Information and Examples
top
ExtractChildByIndex
ExtractChildByIndex(index As Long) As Xml

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

Returns Nothing on failure

top
ExtractChildByName
ExtractChildByName(tagPath As String, attrName As String, attrValue As String) As Xml

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 Nothing on failure

More Information and Examples
top
FindChild
FindChild(tagPath As String) As Xml

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 Nothing on failure

top
FindChild2
FindChild2(tagPath As String) As Long

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 True for success, False for failure.

top
FindNextRecord
FindNextRecord(tagPath As String, contentPattern As String) As Xml

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 Nothing on failure

More Information and Examples
top
FindOrAddNewChild
FindOrAddNewChild(tagPath As String) As Xml

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 Nothing on failure

top
FirstChild
FirstChild() As Xml

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

Returns Nothing on failure

top
FirstChild2
FirstChild2() As Long

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

Returns True for success, False for failure.

top
GetAttributeName
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 Nothing on failure

More Information and Examples
top
GetAttributeValue
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 Nothing on failure

More Information and Examples
top
GetAttributeValueInt
GetAttributeValueInt(index As Long) As Long

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

top
GetAttrValue
GetAttrValue(name As String) As String

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

Returns Nothing on failure

More Information and Examples
top
GetAttrValueInt
GetAttrValueInt(name As String) As Long

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

More Information and Examples
top
GetChild
GetChild(index As Long) As Xml

Returns the Nth child of an XML node

Returns Nothing on failure

More Information and Examples
top
GetChild2
GetChild2(index As Long) As Long

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

Returns True for success, False for failure.

top
GetChildAttrValue
GetChildAttrValue(tagPath As String, attrName As String) As String
Introduced in version 9.5.0.77

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

Returns Nothing on failure

top
GetChildBoolValue
GetChildBoolValue(tagPath As String) As Long

Returns False if the node's content is "0", otherwise returns True 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
GetChildContent(tagPath As String) As String

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 Nothing on failure

More Information and Examples
top
GetChildContentByIndex
GetChildContentByIndex(index As Long) As String

Returns the content of the Nth child node.

Returns Nothing on failure

top
GetChildContentSb
GetChildContentSb(tagPath As String, sb As StringBuilder) As Long
Introduced in version 9.5.0.76

Returns the content of the XML element at the tagPath. The XML element's content is appended to the sb.

Returns True for success, False for failure.

top
GetChildExact
GetChildExact(tag As String, content As String) As Xml

Returns the child having the exact tag and content.

Returns Nothing on failure

top
GetChildIntValue
GetChildIntValue(tagPath As String) As Long

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
GetChildTag(index As Long) As String

Returns the tag name of the Nth child node.

Returns Nothing on failure

top
GetChildTagByIndex
GetChildTagByIndex(index As Long) As String

Returns the tag name of the Nth child node.

Returns Nothing on failure

More Information and Examples
top
GetChildWithAttr
GetChildWithAttr(tagPath As String, attrName As String, attrValue As String) As Xml

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 Nothing on failure

More Information and Examples
top
GetChildWithContent
GetChildWithContent(content As String) As Xml

Returns the first child found having the exact content specified.

Returns Nothing on failure

top
GetChildWithTag
GetChildWithTag(tagPath As String) As Xml

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 Nothing on failure

top
GetNthChildWithTag
GetNthChildWithTag(tag As String, n As Long) As Xml

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 Nothing on failure

top
GetNthChildWithTag2
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 True for success, False for failure.

top
GetParent
GetParent() As Xml

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

Returns Nothing on failure

top
GetParent2
GetParent2() As Long

Updates the internal reference of the caller to its parent.

Returns True for success, False for failure.

top
GetRoot
GetRoot() As Xml

Returns the root node of the XML document

Returns Nothing on failure

top
GetRoot2
GetRoot2()

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

top
GetSelf
GetSelf() As Xml

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

Returns Nothing on failure

top
GetXml
GetXml() As String

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 Nothing on failure

top
GetXmlBd
GetXmlBd(bd As BinData) As Long
Introduced in version 9.5.0.77

Emits (appends) the XML to the contents of bd.

Returns True for success, False for failure.

top
GetXmlSb
GetXmlSb(sb As StringBuilder) As Long
Introduced in version 9.5.0.62

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

Returns True for success, False for failure.

top
HasAttribute
HasAttribute(name As String) As Long

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

top
HasAttrWithValue
HasAttrWithValue(name As String, value As String) As Long

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

top
HasChildWithContent
HasChildWithContent(content As String) As Long

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

top
HasChildWithTag
HasChildWithTag(tagPath As String) As Long

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

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
HasChildWithTagAndContent(tagPath As String, content As String) As Long

Returns True 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
InsertChildTreeAfter(index As Long, tree As Xml)

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
InsertChildTreeBefore(index As Long, tree As Xml)

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
LastChild() As Xml

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 Nothing on failure

top
LastChild2
LastChild2() As Long

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

Returns True for success, False for failure.

top
LoadBd
LoadBd(bd As BinData, autoTrim As Boolean) As Long
Introduced in version 9.5.0.77

Loads XML from the contents of bd. If autoTrim is True, then each element's text content is trimmed of leading and trailing whitespace.

Returns True for success, False for failure.

top
LoadSb
LoadSb(sb As StringBuilder, autoTrim As Boolean) As Long
Introduced in version 9.5.0.62

Loads XML from the contents of a StringBuilder object.

Returns True for success, False for failure.

More Information and Examples
top
LoadXml
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.

Returns True for success, False for failure.

top
LoadXml2
LoadXml2(xmlData As String, autoTrim As Boolean) As Long

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

Returns True for success, False for failure.

More Information and Examples
top
LoadXmlFile
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.

Returns True for success, False for failure.

top
LoadXmlFile2
LoadXmlFile2(fileName As String, autoTrim As Boolean) As Long

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

Returns True for success, False for failure.

More Information and Examples
top
NewChild
NewChild(tagPath As String, content As String) As Xml

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 Nothing on failure

top
NewChild2
NewChild2(tagPath As String, content As String)

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
NewChildAfter(index As Long, tag As String, content As String) As Xml

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

Returns Nothing on failure

top
NewChildBefore
NewChildBefore(index As Long, tag As String, content As String) As Xml

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

Returns Nothing on failure

top
NewChildInt2
NewChildInt2(tagPath As String, value As Long)

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
NextInTraversal2
NextInTraversal2(sbState As StringBuilder) As Long
Introduced in version 9.5.0.77

Updates to Xml object's internal reference to the next node in a depth-first traversal. (This method name, NextInTraversal2, ends with "2" to signify that the internal reference is updated. There is no "NextInTraversal" method.)

The sbState contains the current state of the traversal. sbState should be empty when beginning a traversal.

More Information and Examples
top
NextSibling
NextSibling() As Xml

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

Returns Nothing on failure

top
NextSibling2
NextSibling2() As Long

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

Returns True for success, False for failure.

top
NumChildrenAt
NumChildrenAt(tagPath As String) As Long
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
NumChildrenHavingTag(tag As String) As Long

Returns the number of children having a specific tag name.

top
PreviousSibling
PreviousSibling() As Xml

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

Returns Nothing on failure

top
PreviousSibling2
PreviousSibling2() As Long

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

Returns True for success, False for failure.

top
PruneAttribute
PruneAttribute(attrName As String) As Long
Introduced in version 9.5.0.77

Recursively descends the XML from this node and removes all occurrences of the specified attribute. Returns the number of attribute occurrences removed.

top
PruneTag
PruneTag(tag As String) As Long
Introduced in version 9.5.0.77

Recursively descends the XML from this node and removes all occurrences of the specified tag, including all descendents of each removed node. Returns the number of tag occurrences removed.

More Information and Examples
top
RemoveAllAttributes
RemoveAllAttributes() As Long

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

Returns True for success, False for failure.

top
RemoveAllChildren
RemoveAllChildren()

Removes all children from the calling node.

top
RemoveAttribute
RemoveAttribute(name As String) As Long

Removes an attribute by name from and XML node.

Returns True for success, False for failure.

top
RemoveChild
RemoveChild(tagPath As String)

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
RemoveChildByIndex(index As Long)

Removes the Nth child from the calling node.

More Information and Examples
top
RemoveChildWithContent
RemoveChildWithContent(content As String)

Removes all children having the exact content specified.

More Information and Examples
top
RemoveFromTree
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
RemoveStyleSheet
RemoveStyleSheet(attrName As String, attrValue As String) As Long
Introduced in version 9.5.0.77

Removes all XML stylesheets having an attribute with attrName equal to attrValue. Returns the number of stylesheets removed, or -1 if there was an error.

top
SaveBinaryContent
SaveBinaryContent(filename As String, unzipFlag As Boolean, decryptFlag As Boolean, password As String) As Long

Saves a node's binary content to a file.

Returns True for success, False for failure.

top
SaveXml
SaveXml(fileName As String) As Long

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

Returns True for success, False for failure.

top
Scrub
Scrub(directives As String)
Introduced in version 9.5.0.77

Recursively traverses the XML rooted at the caller and scrubs according to the instructions in the comma separated directives. The currently defined directives are:

  • "AttrTrimEnds" - Leading and trailing whitespace removed from attribute values.
  • "AttrTrimInside" - Replace all tabs, CR's, and LF's with SPACE chars, and removes extra SPACE chars so that no more than one SPACE char in a row exists.
  • "ContentTrimEnds" - Same as AttrTrimEnds but for content.
  • "ContentTrimInside" - Same as AttrTrimInside but for content.
  • "LowercaseAttrs" - Convert all attribute names to lowercase.
  • "LowercaseTags" - Convert all tags to lowercase.
  • "RemoveCtrl" - Remove non-printable us-ascii control chars (us-ascii values <= 31 except for TAB,CR, and LF are removed)

If you have other ideas for useful XML scrubbing directives, send email to support@chilkatsoft.com. It must be general enough such that many developers will find it useful.

More Information and Examples
top
SearchAllForContent
SearchAllForContent(afterPtr As Xml, contentPattern As String) As Xml

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 Nothing. (For the ActiveX implementation, the afterPtr should never be Nothing. 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 Nothing.

Returns Nothing on failure

More Information and Examples
top
SearchAllForContent2
SearchAllForContent2(afterPtr As Xml, 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).

Returns True for success, False for failure.

top
SearchForAttribute
SearchForAttribute(afterPtr As Xml, tag As String, attr As String, valuePattern As String) As Xml

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 Nothing. (For the ActiveX implementation, the afterPtr should never be Nothing. 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 Nothing.

Returns Nothing on failure

top
SearchForAttribute2
SearchForAttribute2(afterPtr As Xml, 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).

Returns True for success, False for failure.

top
SearchForContent
SearchForContent(afterPtr As Xml, tag As String, contentPattern As String) As Xml

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 Nothing. (For the ActiveX implementation, the afterPtr should never be Nothing. 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 Nothing.

Returns Nothing on failure

More Information and Examples
top
SearchForContent2
SearchForContent2(afterPtr As Xml, 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).

Returns True for success, False for failure.

More Information and Examples
top
SearchForTag
SearchForTag(afterPtr As Xml, tag As String) As Xml

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 Nothing. (For the ActiveX implementation, the afterPtr should never be Nothing. 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 Nothing.

Returns Nothing on failure

top
SearchForTag2
SearchForTag2(afterPtr As Xml, 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).

Returns True for success, False for failure.

top
SetBinaryContentFromFile
SetBinaryContentFromFile(filename As String, zipFlag As Boolean, encryptFlag As Boolean, 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.

Returns True for success, False for failure.

top
SortByAttribute
SortByAttribute(attrName As String, ascending As Boolean)

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

top
SortByAttributeInt
SortByAttributeInt(attrName As String, ascending As Boolean)

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

top
SortByContent
SortByContent(ascending As Boolean)

Sorts the direct child nodes by content.

More Information and Examples
top
SortByTag
SortByTag(ascending As Boolean)

Sorts the direct child nodes by tag.

More Information and Examples
top
SortRecordsByAttribute
SortRecordsByAttribute(sortTag As String, attrName As String, ascending As Boolean)

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

top
SortRecordsByContent
SortRecordsByContent(sortTag As String, ascending As Boolean)

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

More Information and Examples
top
SortRecordsByContentInt
SortRecordsByContentInt(sortTag As String, ascending As Boolean)

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
SwapNode(node As Xml) As Long

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

Returns True for success, False for failure.

top
SwapTree
SwapTree(tree As Xml) As Long

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

Returns True for success, False for failure.

top
TagContent
TagContent(tagName As String) As String

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 Nothing on failure

top
TagEquals
TagEquals(tag As String) As Long

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

top
TagIndex
TagIndex(tagPath As String) As Long
Introduced in version 9.5.0.76

Returns the index of the XML node with the given tag. Returns -1 if no node having the specified tag is found at the tagPath.

More Information and Examples
top
TagNsEquals
TagNsEquals(ns As String) As Long
Introduced in version 9.5.0.77

Returns True if the node's tag namespace prefix equals the specified ns.

More Information and Examples
top
TagUnpEquals
TagUnpEquals(unprefixedTag As String) As Long
Introduced in version 9.5.0.77

Returns True if the node's unprefixed tag equals the specified string. For example, if the tag is "soapenv:Body", the unprefixed tag is "Body".

More Information and Examples
top
UnzipContent
UnzipContent() As Long

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

Returns True for success, False for failure.

More Information and Examples
top
UnzipTree
UnzipTree() As Long

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

Returns True for success, False for failure.

More Information and Examples
top
UpdateAt
UpdateAt(tagPath As String, autoCreate As Boolean, value As String) As Long
Introduced in version 9.5.0.64

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

More Information and Examples
top
UpdateAttrAt
UpdateAttrAt(tagPath As String, autoCreate As Boolean, attrName As String, attrValue As String) As Long
Introduced in version 9.5.0.64

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

top
UpdateAttribute
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.

Returns True for success, False for failure.

More Information and Examples
top
UpdateAttributeInt
UpdateAttributeInt(attrName As String, value As Long) As Long

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

Returns True for success, False for failure.

top
UpdateChildContent
UpdateChildContent(tagPath As String, value As String)

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
UpdateChildContentInt(tagPath As String, value As Long)

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
ZipContent() As Long

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

Returns True for success, False for failure.

More Information and Examples
top
ZipTree
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.

Returns True for success, False for failure.

More Information and Examples
top