CkXml Python Programming
Reference Documentation
CkXml
A free non-validating XML parser component with encryption and compression features.
Object Creation
obj = chilkat.CkXml()
Properties
# Returns a boolean value
get_Cdata( )
# newVal is a boolean (input)
# Returns a boolean value
put_Cdata( newVal )
When True, causes an XML node's content to be encapsulated in a CDATA section.
# str is a CkString object (output)
get_Content( str )
# newVal is a string (input)
put_Content( newVal )
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.
# Returns an integer value
get_ContentInt( )
# newVal is an integer (input)
put_ContentInt( newVal )
Set/get the content as an integer.
# str is a CkString object (output)
get_Encoding( str )
# newVal is a string (input)
put_Encoding( newVal )
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.
# str is a CkString object (output)
LastErrorHtml( str )
To be documented soon.Error information in HTML format for the last method called.
# str is a CkString object (output)
LastErrorText( str )
To be documented soon.Error information in plain-text format for the last method called.
# str is a CkString object (output)
LastErrorXml( str )
To be documented soon.Error information in XML format for the last method called.
# Returns an integer value
get_NumAttributes( )
The number of attributes. For example, the following node has 2 attributes: This is the content
# Returns an integer value
get_NumChildren( )
The number of child nodes contained under this XML node.
# Returns a boolean value
get_SortCaseInsensitive( )
# newVal is a boolean (input)
put_SortCaseInsensitive( newVal )
If true (or 1 for ActiveX), then all Sort* methods use case insensitive sorting.
# Returns a boolean value
get_Standalone( )
# newVal is a boolean (input)
put_Standalone( newVal )
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">
# str is a CkString object (output)
get_Tag( str )
# newVal is a string (input)
put_Tag( newVal )
The XML node's tag.
# Returns an integer value
get_TreeId( )
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.
# Returns a boolean value
get_Utf8( )
# b is a boolean (input)
put_Utf8( b )
When set to true, all "const char *" arguments are expected to be utf-8 strings. If set to false, the "const char *" arguments are expected to be ANSI strings.
# str is a CkString object (output)
# Returns a boolean value
get_Version( str )
The version of the XML component, such as "2.0.0".
Methods
# tag is a string (input)
# skipTags is a string (input)
# str is a CkString object (output)
AccumulateTagContent( tag, skipTags, str )
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 True for success, False for failure.
# name is a string (input)
# value is a string (input)
# Returns a boolean value
AddAttribute( name, value )
Adds an attribute to the calling node in the XML document. Returns True for success, and False for failure.
# name is a string (input)
# value is an integer (input)
# Returns a boolean value
AddAttributeInt( name, value )
Adds an integer attribute to a node.
# tree is a CkXml object (input)
# Returns a boolean value
AddChildTree( tree )
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.
# name is a string (input)
# value is a string (input)
AddOrUpdateAttribute( name, value )
Adds an attribute to an XML node. If an attribute having the specified name already exists, the value is updated.
# name is a string (input)
# value is an integer (input)
AddOrUpdateAttributeI( name, value )
Adds an integer attribute to an XML node. If an attribute having the specified name already exists, the value is updated.
# styleSheet is a string (input)
AddStyleSheet( styleSheet )
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"?>
# name is a string (input)
# amount is an integer (input)
AddToAttribute( name, amount )
Adds an integer amount to an integer attribute's value. If the attribute does not yet exist, this method behaves the same as AddOrUpdateAttributeI.
# tag is a string (input)
# amount is an integer (input)
AddToChildContent( tag, amount )
Adds an integer value to the content of a child node.
# amount is an integer (input)
AddToContent( amount )
Adds an integer amount to the node's content.
# str is a string (input)
# Returns a boolean value
AppendToContent( str )
Appends text to the content of an XML node
# charset is a string (input)
# db is a CkByteData object (input)
# Returns a boolean value
BEncodeContent( charset, db )
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.
# tag is a string (input)
# pattern is a string (input)
# caseSensitive is a boolean (input)
# Returns a boolean value
ChildContentMatches( tag, pattern, caseSensitive )
Return true if a child having a specific tag contains content that matches a wildcarded pattern.
# Returns a boolean value
Clear( )
Removes all children, attributes, and content from the XML node. Resets the tag name to "unnamed".
# pattern is a string (input)
# caseSensitive is a boolean (input)
# Returns a boolean value
ContentMatches( pattern, caseSensitive )
Return true if the node's content matches a wildcarded pattern.
# node is a CkXml object (output)
Copy( node )
Copies the tag, content, and attributes to the calling node.
# db is a CkByteData object (output)
# Returns a boolean value
DecodeContent( db )
Decodes a node's Q or B-encoded content string and returns the byte data.
# str is a string (input)
# outStr is a CkString object (output)
# Returns a boolean value
DecodeEntities( str, outStr )
Utility method to decode HTML entities. It accepts a string containing (potentially) HTML entities and returns a string with the entities decoded. Returns True for success, False for failure.
# password is a string (input)
# Returns a boolean value
DecryptContent( password )
Decrypts the content of an XML node that was previously 128-bit AES encrypted with the EncryptContent method.
# password is a string (input)
# Returns a boolean value
EncryptContent( password )
AES encrypts the content of the calling XML node using 128-bit Rijndael encryption.
# index is an integer (input)
# Returns a CkXml object
ExtractChildByIndex( index )
Removes and returns the Nth child of an XML node. The first child is at index 0.
# tag is a string (input)
# attrName is a string (input)
# attrValue is a string (input)
# Returns a CkXml object
ExtractChildByName( tag, attrName, attrValue )
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.
# tag is a string (input)
# Returns a CkXml object
FindChild( tag )
Returns the child having a specified tag.
# tag is a string (input)
# Returns a boolean value
FindChild2( tag )
Updates the Xml object's internal reference to point to a child with a specified tag.
# tag is a string (input)
# contentPattern is a string (input)
# Returns a CkXml object
FindNextRecord( tag, contentPattern )
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.
# tag is a string (input)
# Returns a CkXml object
FindOrAddNewChild( tag )
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.
# Returns a CkXml object
FirstChild( )
Returns the first child. A program can step through the children by calling FirstChild, and then NextSibling repeatedly.
# Returns a boolean value
FirstChild2( )
Updates the internal reference of the caller to point to its first child. More information about XML methods ending in "2"
# name is a string (input)
# str is a CkString object (output)
# Returns a boolean value
GetAttrValue( name, str )
Find and return the value of an attribute having a specified name. Returns True for success, False for failure.
# name is a string (input)
# Returns an integer value
GetAttrValueInt( name )
Returns an attribute as an integer.
# index is an integer (input)
# str is a CkString object (output)
# Returns a boolean value
GetAttributeName( index, str )
Returns the name of the Nth attribute of an XML node. The first attribute is at index 0. Returns True for success, False for failure.
# index is an integer (input)
# str is a CkString object (output)
# Returns a boolean value
GetAttributeValue( index, str )
Returns the value of the Nth attribute of an XML node. The first attribute is at index 0. Returns True for success, False for failure.
# index is an integer (input)
# Returns an integer value
GetAttributeValueInt( index )
Returns an attribute as an integer.
# data is a CkByteData object (output)
# unzipFlag is a boolean (input)
# decryptFlag is a boolean (input)
# password is a string (input)
# Returns a boolean value
GetBinaryContent( data, unzipFlag, decryptFlag, password )
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.
# index is an integer (input)
# Returns a CkXml object
GetChild( index )
Returns the Nth child of an XML node
# index is an integer (input)
# Returns a boolean value
GetChild2( index )
Updates the calling object's internal reference to the Nth child node. Returns True for success, False for failure. More information about XML methods ending in "2"
# tag is a string (input)
# Returns a boolean value
GetChildBoolValue( tag )
Returns False if the node's content is "0", otherwise returns True if the node contains a non-zero integer.
# tag is a string (input)
# str is a CkString object (output)
# Returns a boolean value
GetChildContent( tag, str )
Returns the content of a child having a specified tag. Returns True for success, False for failure.
# index is an integer (input)
# str is a CkString object (output)
# Returns a boolean value
GetChildContentByIndex( index, str )
Returns the content of the Nth child node. Returns True for success, False for failure.
# tag is a string (input)
# content is a string (input)
# Returns a CkXml object
GetChildExact( tag, content )
Returns the child having the exact tag and content.
# tag is a string (input)
# value is an integer (output)
# Returns a boolean value
GetChildIntValue( tag, value )
Returns the child integer content for a given tag.
# index is an integer (input)
# str is a CkString object (output)
# Returns a boolean value
GetChildTag( index, str )
Returns the tag name of the Nth child node. Returns True for success, False for failure.
# index is an integer (input)
# outStr is a CkString object (output)
# Returns a boolean value
GetChildTagByIndex( index, outStr )
Returns the tag name of the Nth child node. Returns True for success, False for failure.
# content is a string (input)
# Returns a CkXml object
GetChildWithContent( content )
Returns the first child found having the exact content specified.
# tag is a string (input)
# Returns a CkXml object
GetChildWithTag( tag )
Returns the Xml child object having a tag matching tagName.
# tag is a string (input)
# n is an integer (input)
# Returns a CkXml object
GetNthChildWithTag( tag, n )
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.
# tag is a string (input)
# n is an integer (input)
# Returns a boolean value
GetNthChildWithTag2( tag, n )
Updates the calling object's internal reference to the Nth child node having a specific tag. Returns True for success, False for failure.
# Returns a CkXml object
GetParent( )
Returns the parent of this XML node, or NULL if the node is the root of the tree.
# Returns a boolean value
GetParent2( )
Updates the internal reference of the caller to its parent. More information about XML methods ending in "2"
# Returns a CkXml object
GetRoot( )
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"
# str is a CkString object (output)
# Returns a boolean value
GetXml( str )
Generate the XML text document for the XML tree rooted at this node. Returns True for success, False for failure.
# name is a string (input)
# value is a string (input)
# Returns a boolean value
HasAttrWithValue( name, value )
Returns true if the node contains attribute with the name and value.
# name is a string (input)
# Returns a boolean value
HasAttribute( name )
Returns true if the node contains an attribute with the specified name.
# content is a string (input)
# Returns a boolean value
HasChildWithContent( content )
Returns true if the node has a child node containing the exact content string specified.
# tag is a string (input)
# Returns a boolean value
HasChildWithTag( tag )
Returns true (1 for ActiveX) if the node has a child with a given tag.
# tag is a string (input)
# content is a string (input)
# Returns a boolean value
HasChildWithTagAndContent( tag, content )
Returns true if the node contains a child having the exact tag and content specified.
# url is a string (input)
# Returns a CkXml object
HttpGet( url )
Gets an XML document from a URL. This can be tested with the following URL: http://www.chilkatsoft.com/test.xml
# url is a string (input)
# Returns a CkXml object
HttpPost( url )
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.
# Returns a CkXml object
LastChild( )
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 a boolean value
LastChild2( )
Updates the internal reference of the caller to its last child.
# xmlData is a string (input)
# Returns a boolean value
LoadXml( xmlData )
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.
# xmlData is a string (input)
# autoTrim is a boolean (input)
# Returns a boolean value
LoadXml2( xmlData, autoTrim )
Same as LoadXml, but an additional argument controls whether or not leading/trailing whitespace is auto-trimmed from each node's content. Returns True for success, False for failure.
# fileName is a string (input)
# Returns a boolean value
LoadXmlFile( fileName )
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.
# fileName is a string (input)
# autoTrim is a boolean (input)
# Returns a boolean value
LoadXmlFile2( fileName, autoTrim )
Same as LoadXmlFile, but an additional argument controls whether or not leading/trailing whitespace is auto-trimmed from each node's content. Returns True for success, False for failure.
# tag is a string (input)
# content is a string (input)
# Returns a CkXml object
NewChild( tag, content )
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.)
# tag is a string (input)
# content is a string (input)
NewChild2( tag, content )
Creates a new child but does not return the node that is created.
# tag is a string (input)
# value is an integer (input)
NewChildInt2( tag, value )
Inserts a new child having an integer for content.
# Returns a CkXml object
NextSibling( )
Returns the nodes next sibling, or NULL if there are no more.
# Returns a boolean value
NextSibling2( )
Updates the internal reference of the caller to its next sibling. More information about XML methods ending in "2"
# tag is a string (input)
# Returns an integer value
NumChildrenHavingTag( tag )
Returns the number of children having a specific tag name.
# Returns a CkXml object
PreviousSibling( )
Returns the Xml object that is the node's previous sibling, or NULL if there are no more.
# Returns a boolean value
PreviousSibling2( )
Updates the internal reference of the caller to its previous sibling. More information about XML methods ending in "2"
# charset is a string (input)
# db is a CkByteData object (input)
# Returns a boolean value
QEncodeContent( charset, db )
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 a boolean value
RemoveAllAttributes( )
Removes all attributes from an XML node. Should always return True.
RemoveAllChildren( )
Removes all children from the calling node.
# name is a string (input)
# Returns a boolean value
RemoveAttribute( name )
Removes an attribute by name from and XML node.
# tag is a string (input)
RemoveChild( tag )
Removes a child with a given tag.
# index is an integer (input)
RemoveChildByIndex( index )
Removes the Nth child from the calling node.
# content is a string (input)
RemoveChildWithContent( content )
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.
# filename is a string (input)
# unzipFlag is a boolean (input)
# decryptFlag is a boolean (input)
# password is a string (input)
# Returns a boolean value
SaveBinaryContent( filename, unzipFlag, decryptFlag, password )
Saves a node's binary content to a file.
# filename is a string (input)
# Returns a boolean value
SaveLastError( filename )
Saves the last error information to an XML formatted file.
# fileName is a string (input)
# Returns a boolean value
SaveXml( fileName )
Generates XML representing the tree or subtree rooted at this node and writes it to a file.
# after is a CkXml object (input)
# contentPattern is a string (input)
# Returns a CkXml object
SearchAllForContent( after, contentPattern )
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.
# after is a CkXml object (input)
# contentPattern is a string (input)
# Returns a boolean value
SearchAllForContent2( after, contentPattern )
Same as SearchAllForContent except the internal reference of the caller is updated to point to the search result (instead of returning a new object).
# after is a CkXml object (input)
# tag is a string (input)
# attr is a string (input)
# valuePattern is a string (input)
# Returns a CkXml object
SearchForAttribute( after, tag, attr, valuePattern )
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.
# after is a CkXml object (input)
# tag is a string (input)
# attr is a string (input)
# valuePattern is a string (input)
# Returns a boolean value
SearchForAttribute2( after, tag, attr, valuePattern )
Same as SearchForAttribute except the internal reference of the caller is updated to point to the search result (instead of returning a new object).
# after is a CkXml object (input)
# tag is a string (input)
# contentPattern is a string (input)
# Returns a CkXml object
SearchForContent( after, tag, contentPattern )
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.
# after is a CkXml object (input)
# tag is a string (input)
# contentPattern is a string (input)
# Returns a boolean value
SearchForContent2( after, tag, contentPattern )
Same as SearchForContent except the internal reference of the caller is updated to point to the search result (instead of returning a new object).
# after is a CkXml object (input)
# tag is a string (input)
# Returns a CkXml object
SearchForTag( after, tag )
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.
# after is a CkXml object (input)
# tag is a string (input)
# Returns a boolean value
SearchForTag2( after, tag )
Same as SearchForTag except the internal reference of the caller is updated to point to the search result (instead of returning a new object).
# bData is a CkByteData object (input)
# zipFlag is a boolean (input)
# encryptFlag is a boolean (input)
# password is a string (input)
# Returns a boolean value
SetBinaryContent( bData, zipFlag, encryptFlag, password )
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.
# filename is a string (input)
# zipFlag is a boolean (input)
# encryptFlag is a boolean (input)
# password is a string (input)
# Returns a boolean value
SetBinaryContentFromFile( filename, zipFlag, encryptFlag, password )
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.
# attrName is a string (input)
# ascending is an integer (input)
SortByAttribute( attrName, ascending )
Sorts the child nodes by the value of a specified attribute.
# attrName is a string (input)
# ascending is a boolean (input)
SortByAttributeInt( attrName, ascending )
Sorts the child nodes by the value of a specified attribute interpreted as an integer (not lexicographically as strings).
# ascending is an integer (input)
SortByContent( ascending )
Sorts the child nodes by content.
# ascending is an integer (input)
SortByTag( ascending )
Sorts the child nodes by tag.
# sortTag is a string (input)
# attrName is a string (input)
# ascending is an integer (input)
SortRecordsByAttribute( sortTag, attrName, ascending )
Sorts the child nodes by the content of an attribute in the grandchild nodes.
# sortTag is a string (input)
# ascending is an integer (input)
SortRecordsByContent( sortTag, ascending )
Sorts the child nodes by the content of the grandchild nodes.
# node is a CkXml object (input)
# Returns a boolean value
SwapNode( node )
Swaps another node's tag, content, and attributes with this one.
# tree is a CkXml object (input)
# Returns a boolean value
SwapTree( tree )
Swaps another node's tag, content, attributes, and children with this one.
# tag is a string (input)
# Returns a boolean value
TagEquals( tag )
Returns True if the node's tag equals the specified string.
# Returns a boolean value
UnzipContent( )
Unzip the content of the XML node replacing it's content with the decompressed data.
# Returns a boolean value
UnzipTree( )
Unzips and recreates the XML node and the entire subtree, restoring it to the state before it was zip compressed.
# attrName is a string (input)
# attrValue is a string (input)
# Returns a boolean value
UpdateAttribute( attrName, attrValue )
Adds an attribute to the node if it doesn't already exist. Otherwise it updates the existing attribute with the new value.
# attrName is a string (input)
# value is an integer (input)
# Returns a boolean value
UpdateAttributeInt( attrName, value )
Updates an attribute value. (Call UpdateAttribute if the attribute value is a string.)
# tag is a string (input)
# value is a string (input)
UpdateChildContent( tag, value )
Replaces the content of a child node.
# tag is a string (input)
# value is an integer (input)
UpdateChildContentInt( tag, value )
Replaces the content of a child node where the content is an integer.
# Returns a boolean value
ZipContent( )
Applies Zip compression to the content of an XML node and replaces the content with base64-encoded compressed data.
# Returns a boolean value
ZipTree( )
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.
# tag is a string (input)
# skipTags is a string (input)
# Returns a string
accumulateTagContent( tag, skipTags )
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.
# name is a string (input)
# Returns a string
attr( name )
Find and return the value of an attribute having a specified name.
# index is an integer (input)
# Returns a string
attrName( index )
Returns the name of the Nth attribute of an XML node. The first attribute is at index 0.
# index is an integer (input)
# Returns a string
attrValue( index )
Returns the value of the Nth attribute of an XML node. The first attribute is at index 0.
# tag is a string (input)
# Returns a string
childContent( tag )
Returns the content of a child having a specified tag.
# Returns a string
content( )
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.
# str is a string (input)
# Returns a string
decodeEntities( str )
Utility method to decode HTML entities. It accepts a string containing (potentially) HTML entities and returns a string with the entities decoded.
# Returns a string
encoding( )
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.
# name is a string (input)
# Returns a string
getAttrValue( name )
Find and return the value of an attribute having a specified name.
# index is an integer (input)
# Returns a string
getAttributeName( index )
Returns the name of the Nth attribute of an XML node. The first attribute is at index 0.
# index is an integer (input)
# Returns a string
getAttributeValue( index )
Returns the value of the Nth attribute of an XML node. The first attribute is at index 0.
# tag is a string (input)
# Returns a string
getChildContent( tag )
Returns the content of a child having a specified tag.
# index is an integer (input)
# Returns a string
getChildContentByIndex( index )
Returns the content of the Nth child node.
# index is an integer (input)
# Returns a string
getChildTag( index )
Returns the tag name of the Nth child node.
# index is an integer (input)
# Returns a string
getChildTagByIndex( index )
Returns the tag name of the Nth child node.
# Returns a string
getXml( )
Generate the XML text document for the XML tree rooted at this node.
# Returns a string
lastErrorHtml( )
Error information in HTML format for the last method called.
# Returns a string
lastErrorText( )
Error information in plain-text format for the last method called.
# Returns a string
lastErrorXml( )
Error information in XML format for the last method called.
# Returns a string
tag( )
The XML node's tag.
# Returns a string
version( )
The version of the XML component, such as "2.0.0".
# Returns a string
xml( )
Generate the XML text document for the XML tree rooted at this node.
|