Xml

Controls how this element's text content is emitted. When set to true, the element content is written inside a CDATA section instead of being emitted as ordinary character data with XML escaping.

Gets or sets the text content stored directly on this XML element. Child elements are not included in this value.

For example, both of the following elements have This is the content as their Content:

<tag1>This is the content</tag1>

<tag2><child1>abc</child1><child2>abc</child2>This is the content</tag2>

Gets or sets this element's content as a 32-bit integer. Setting the property converts the integer to its decimal text representation; getting the property interprets the element's text content as an integer.

If set to a file path, this property logs the LastErrorText of each Chilkat method or property call to the specified file. This logging helps identify the context and history of Chilkat calls leading up to any crash or hang, aiding in debugging.

Enabling the VerboseLogging property provides more detailed information. This property is mainly used for debugging rare instances where a Chilkat method call causes a hang or crash, which should generally not happen.

Possible causes of hangs include:

• A timeout property set to 0, indicating an infinite timeout.
• A hang occurring within an event callback in the application code.
• An internal bug in the Chilkat code causing the hang.

Gets or sets the document type declaration associated with the XML document.

The value represents the document-level DOCTYPE declaration, for example <!DOCTYPE note SYSTEM "note.dtd">.

Controls whether a byte order mark (BOM, also called a preamble) is written when XML is saved to a file. The default is false.

This setting is relevant to encodings for which a BOM can be emitted, such as UTF-8 and UTF-16. It does not affect XML returned as a language string by methods such as GetXml.

Controls whether XML emitted by GetXml and GetXmlSb is compact. When true, unnecessary formatting whitespace and line breaks are omitted. The default is false for backward compatibility.

Controls whether the XML declaration is included when XML is emitted. The default is true. When set to false, output methods such as GetXml and SaveXml omit the declaration.

An XML declaration is the leading construct such as <?xml version="1.0" encoding="utf-8"?>.

Gets or sets the encoding value used in the XML declaration. The default is utf-8. This is a document-level setting and may be accessed from any element in the tree.

When XML is loaded, Chilkat sets this property from the encoding declared by the input XML when one is present. If no encoding is declared, the property is reset to utf-8.

Provides a substitution value for [i] in Chilkat tag paths and ChilkatPath expressions. When a path contains [i], the current value of this property is substituted for I.

Returns true if this element's content consists only of characters allowed in standard Base64 text, with whitespace ignored. Standard Base64 uses A-Z, a-z, 0-9, +, /, and optional trailing = padding.

Provides a substitution value for [j] in Chilkat tag paths and ChilkatPath expressions. When a path contains [j], the current value of this property is substituted for J.

Provides a substitution value for [k] in Chilkat tag paths and ChilkatPath expressions. When a path contains [k], the current value of this property is substituted for K.

Provides HTML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

Provides plain text information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

Provides XML-formatted information about the last called method or property. If a method call fails or behaves unexpectedly, check this property for details. Note that information is available regardless of the method call's success.

Indicates the success or failure of the most recent method call: true means success, false means failure. This property remains unchanged by property setters or getters. This method is present to address challenges in checking for null or Nothing returns in certain programming languages. Note: This property does not apply to methods that return integer values or to boolean-returning methods where the boolean does not indicate success or failure.

Returns the number of attributes on this element.

For example, <tag attr1="value1" attr2="value2">...</tag> has two attributes. Attribute indexes used by methods such as GetAttributeName and GetAttributeValue are zero-based.

Returns the number of direct child elements of this element. Descendants below those children are not included in the count.

Controls case sensitivity for the XML sorting methods. Set to true for case-insensitive string comparisons or false for case-sensitive comparisons.

Controls the standalone pseudo-attribute in the XML declaration. This is a document-level setting and may be accessed from any element in the tree.

Setting this property to true causes the declaration to include standalone="yes".

Gets or sets the element name for this element, including any namespace prefix. For example, the tag for <soapenv:Body> is soapenv:Body.

Use TagNsPrefix and TagUnprefixed when the prefix and local portion are needed separately.

Gets or sets the namespace prefix portion of this element's tag. For soapenv:Envelope, the namespace prefix is soapenv.

Returns the Chilkat tag path needed to reach this element from the document root. If this object currently references the root element, the returned path is the empty string.

Gets or sets the unprefixed portion of this element's tag. For soapenv:Envelope, the unprefixed tag is Envelope.

Use TagNsPrefix to access the prefix separately.

Returns the identifier of the XML tree to which this element belongs. Elements in the same XML document have the same TreeId.

Provides a catch-all string for uncommon XML behaviors. The default is the empty string, which is appropriate for normal use.

Leave this property empty unless Chilkat documentation or support identifies a specific option needed for a specialized interoperability case.

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.

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

Traverses the subtree rooted at the calling element and concatenates the text content of all elements whose tag equals tag.

skipTags is a vertical-bar-delimited list of tag names whose entire subtrees are excluded from the accumulation. For example, script|style skips elements rooted at either of those tags.

Returns null on failure

Adds an attribute named name with the specified string value to the calling element.

Returns true on success and false on failure.

Returns true for success, false for failure.

Adds an attribute named name whose value is the decimal representation of value.

Returns true on success and false on failure.

Returns true for success, false for failure.

Adds the entire XML subtree referenced by tree as a new direct child of the calling element.

If tree already belongs to another XML document, the subtree is transferred to the destination tree rather than copied as an unrelated duplicate.

Returns true for success, false for failure.

Sets the string value of an attribute on the calling element. If an attribute named name already exists, its value is replaced; otherwise the attribute is added.

Sets an integer-valued attribute on the calling element. If an attribute named name already exists, its value is replaced with the decimal representation of value; otherwise the attribute is added.

Adds an XML stylesheet processing instruction to the document. Pass the complete processing-instruction text, for example:

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

Treats the named attribute value as an integer, adds amount, and stores the resulting integer back in the attribute.

If the attribute does not yet exist, this method behaves like AddOrUpdateAttributeI and creates it with amount as the value.

Finds the child identified by tag, interprets its content as an integer, adds amount, and stores the resulting integer as the child's new content.

Interprets this element's content as an integer, adds amount, and stores the resulting integer as the new content.

Appends str to the existing text content of the calling element without replacing its child elements.

Returns true on success and false on failure.

Returns true for success, false for failure.

Returns true if the child identified by tagPath has content matching pattern; otherwise returns false. caseSensitive controls whether letter case is significant.

The pattern may contain * wildcards, where each asterisk matches zero or more characters.

Evaluates a Chilkat-specific path command that can navigate from the current element, return element content or an attribute value, or move the caller's internal element reference.

This syntax is not XPath. Commands are separated by vertical bars and the expression ends with a return command:

command|command|command|...|returnCommand

Navigation commands include:

• TagName — first direct child having that tag.
• TagName[n] — the indexed direct child having that tag.
• .. — parent.
• ++ / -- — next / previous sibling.
• TagName{Content} — first direct child with that tag and exact content.
• /T/TagName — traverse the subtree and find the first element with that tag.
• /C/TagName,ContentPattern — traverse for a tag whose content matches a wildcard pattern.
• /C/ContentPattern — traverse for any tag whose content matches a wildcard pattern.
• /A/TagName,AttrName,AttrValuePattern — traverse for a tag having a matching attribute value.

The final return command is:

• * — return the current element's content.
• (AttrName) — return an attribute value.
• $ — move this Xml object to the selected element and return an empty string.

Returns null on failure

Clears the calling element by removing all child elements, attributes, and text content, and resets its tag name to unnamed.

The element itself remains in the tree; this method clears its contents rather than removing the element from its parent.

Returns true if this element's content matches pattern; otherwise returns false. caseSensitive controls whether letter case is significant.

The pattern may contain * wildcards, where each asterisk matches zero or more characters.

Copies the Tag, Content, and attributes from node to the calling element.

Changes this Xml object so that it references the same underlying XML element as copyFromNode. The caller's previous element reference is discarded.

Decodes HTML character entities found in str and returns the decoded text. This is a utility operation; it does not modify the XML tree unless the returned string is assigned to an element.

For example, an HTML entity such as & is decoded to &.

Returns null on failure

Decrypts element content previously produced by EncryptContent, using the same password, and restores the original plaintext content.

Returns true on success and false on failure.

Returns true for success, false for failure.

Encrypts the calling element's text content using Chilkat's password-based 128-bit AES-CBC format and replaces the plaintext content with Base64-encoded encrypted data.

Returns true on success and false on failure.

Returns true for success, false for failure.

Moves the calling Xml object's internal reference to the child selected by tagPath. Returns true when the child is found and the move succeeds; otherwise returns false.

Returns true for success, false for failure.

Moves the calling Xml object's internal reference to its first direct child. Returns true if a first child exists; otherwise returns false.

Returns true for success, false for failure.

Returns the name of the attribute at zero-based index. Use NumAttributes to determine the valid index range.

Returns null on failure

Returns the value of the attribute at zero-based index. Use NumAttributes to determine the valid index range.

Returns null on failure

Returns the value of the attribute at zero-based index, interpreted as a 32-bit integer.

Returns the value of the attribute named name on the calling element.

Use HasAttribute when the application must distinguish a missing attribute from an attribute whose value is empty.

Returns null on failure

Returns the value of the attribute named name interpreted as a 32-bit integer. Returns 0 if the attribute does not exist.

Moves the calling Xml object's internal reference to the direct child at zero-based index. Returns true on success and false if the child cannot be selected.

Returns true for success, false for failure.

Returns the value of attribute attrName on the descendant element selected by tagPath.

Returns null on failure

Returns the integer content of the child selected by tagPath as a Boolean value: content equal to 0 yields false; a non-zero integer yields true.

Returns the text content of the child selected by tagPath.

Returns null on failure

Returns the text content of the direct child at zero-based index. Use NumChildren to determine the valid range.

Returns null on failure

Finds the element selected by tagPath and appends that element's text content to sb.

The existing contents of the StringBuilder are preserved.

Returns true on success and false on failure.

Returns true for success, false for failure.

Returns the content of the child selected by tagPath, interpreted as a 32-bit integer.

Returns the tag name of the direct child at zero-based index. Use NumChildren to determine the valid index range.

Returns null on failure

Returns the tag name of the direct child at zero-based index. Use NumChildren to determine the valid index range.

Returns null on failure

Moves the calling Xml object's internal reference to the child selected by tagPath. Returns true when the child is found and the move succeeds; otherwise returns false.

Returns true for success, false for failure.

Moves the calling Xml object's internal reference to the zero-based nth direct child whose tag equals tag. Returns true on success and false when no such child exists.

Returns true for success, false for failure.

Moves the calling Xml object's internal reference to its parent. Returns true if a parent exists; otherwise returns false when already at the root.

Returns true for success, false for failure.

Moves the calling Xml object's internal reference to the root element of its XML tree.

Serializes the XML tree or subtree rooted at the current element and returns the XML text.

When called while positioned on the document root, the XML declaration is included if EmitXmlDecl is true. When called on a non-root element, only that subtree is emitted and the document declaration is not included.

EmitCompact, Encoding, Standalone, and related document/output properties affect serialization as applicable.

Returns null on failure

Serializes the XML tree or subtree rooted at the current element and appends the encoded XML bytes to bd.

The existing contents of the BinData object are preserved. The XML output encoding is governed by the XML document's output settings, including Encoding.

Returns true on success and false on failure.

Returns true for success, false for failure.

Serializes the XML tree or subtree rooted at the current element and appends the resulting XML text to sb.

The existing contents of sb are preserved. Output properties such as EmitCompact and EmitXmlDecl apply as appropriate.

Returns true on success and false on failure.

Returns true for success, false for failure.

Returns true if the calling element has an attribute named name; otherwise returns false.

Returns true if the calling element has an attribute named name whose value exactly equals value; otherwise returns false.

Returns true if any direct child has text content exactly equal to content; otherwise returns false.

Returns true if the child selected by tagPath exists; otherwise returns false.

Returns true if the child selected by tagPath exists and its text content exactly equals content; otherwise returns false.

Inserts the entire subtree referenced by tree as a direct child immediately after the existing child at zero-based index.

If tree belongs to another XML document, the subtree is transferred to the destination tree.

Inserts the entire subtree referenced by tree as a direct child immediately before the existing child at zero-based index.

If tree belongs to another XML document, the subtree is transferred to the destination tree.

Moves the calling Xml object's internal reference to its last direct child. Returns true if a last child exists; otherwise returns false.

Returns true for success, false for failure.

Parses XML from the bytes contained in bd and replaces the calling object's current XML tree with the loaded document.

If autoTrim is true, leading and trailing whitespace is removed from each leaf element's text content during loading.

Returns true on success and false on failure.

Returns true for success, false for failure.

Parses XML from the current contents of sb and replaces the calling object's current XML tree with the loaded document.

If autoTrim is true, leading and trailing whitespace is removed from each leaf element's text content while loading.

Returns true on success and false on failure.

Returns true for success, false for failure.

Parses the XML text in xmlData and replaces the calling object's current XML tree content with the loaded document root. Returns true if parsing succeeds.

Returns true for success, false for failure.

Parses the XML text in xmlData and replaces the current XML tree, like LoadXml. The autoTrim argument additionally controls whether leading and trailing whitespace is removed from each leaf element's text content while loading.

Returns true for success, false for failure.

Reads and parses an XML document from fileName, replacing the calling object's current XML tree with the loaded document root. Returns true on success.

The file's XML declaration and byte encoding are used as part of normal XML parsing.

Returns true for success, false for failure.

Reads and parses an XML document from fileName, replacing the current XML tree. The autoTrim argument controls whether leading and trailing whitespace is removed from each leaf element's text content.

Returns true for success, false for failure.

Creates a new child at tagPath with the specified text content, but does not return a separate Xml object for the new element.

Creates a new child at tagPath whose content is the decimal representation of value. No separate child object is returned.

Moves the calling Xml object to the next element in a depth-first traversal of the tree and updates sbState with the traversal state.

Pass an empty StringBuilder when beginning a traversal, then reuse the same sbState for each subsequent call.

Moves the calling Xml object's internal reference to its next sibling. Returns true if one exists; otherwise returns false.

Returns true for success, false for failure.

Returns the number of direct children of the element selected by tagPath. Returns -1 if the path does not identify an existing element.

Returns the number of direct children whose tag exactly equals tag. Descendants below those children are not included.

Moves the calling Xml object's internal reference to its previous sibling. Returns true if one exists; otherwise returns false.

Returns true for success, false for failure.

Recursively traverses the subtree rooted at the calling element and removes every occurrence of the attribute named attrName.

Returns the number of attributes removed.

Recursively traverses the subtree rooted at the calling element and removes every element whose tag equals tag. Each removed element's entire descendant subtree is removed with it.

Returns the number of matching tag occurrences removed.

Removes every attribute from the calling element. Returns true on success.

Returns true for success, false for failure.

Removes all direct child elements and their subtrees from the calling element. The calling element's own tag, attributes, and text content are retained.

Removes the attribute named name from the calling element. Returns true when the operation succeeds.

Returns true for success, false for failure.

Removes all child elements selected by tagPath beneath the calling element.

Removes the direct child at zero-based index, including that child's entire subtree.

Removes all direct children whose text content exactly equals content, including each removed child's subtree.

Detaches the calling element and its entire subtree from its parent. The detached element becomes the root of its own independent XML tree.

Removes XML stylesheet processing instructions whose attribute named attrName has the value attrValue.

Returns the number of matching stylesheet declarations removed, or -1 if an error occurs.

Decodes the binary content stored in this element and writes the resulting bytes to filename. Set unzipFlag and decryptFlag to reverse the transformations originally applied, and supply the corresponding password when decrypting.

Returns true on success and false on failure.

Returns true for success, false for failure.

Serializes the XML tree or subtree rooted at the current element and writes it to fileName.

Document/output properties such as Encoding, EmitBom, EmitXmlDecl, and EmitCompact affect the generated output as applicable.

Returns true on success and false on failure.

Returns true for success, false for failure.

Recursively normalizes the XML subtree rooted at the calling element according to the comma-separated keywords in directives.

Supported directives are:

• AttrTrimEnds — remove leading and trailing whitespace from attribute values.
• AttrTrimInside — replace tabs, CR, and LF with spaces and collapse repeated spaces inside attribute values.
• ContentTrimEnds — remove leading and trailing whitespace from element content.
• ContentTrimInside — normalize internal tabs/line breaks/spaces in element content.
• LowercaseAttrs — convert attribute names to lowercase.
• LowercaseTags — convert tag names to lowercase.
• RemoveCtrl — remove US-ASCII control characters with values 0-31 except TAB, CR, and LF.

Stores the bytes in data as binary content on this element, with optional ZIP compression and optional password-based AES encryption. The stored binary representation is emitted as Base64 text when XML is serialized.

If zipFlag is true, the bytes are compressed first. If encryptFlag is true, the data is encrypted using Chilkat's 128-bit Rijndael/AES format and password.

Returns true on success and false on failure.

Returns true for success, false for failure.

Reads the bytes from filename and stores them as this element's binary content, with optional ZIP compression and optional password-based encryption. The resulting stored data is represented as Base64 when XML text is generated.

Returns true on success and false on failure.

Returns true for success, false for failure.

Sorts the calling element's direct children by the string value of attribute attrName. Set ascending to true for ascending order or false for descending order.

SortCaseInsensitive controls case sensitivity for string sorting.

Sorts the calling element's direct children numerically by the value of attribute attrName, interpreting each sort value as an integer rather than comparing the text lexicographically.

Set ascending to true for ascending order or false for descending order.

Sorts the calling element's direct children by their text content. Set ascending to true for ascending order or false for descending order.

SortCaseInsensitive controls case sensitivity for the string comparison.

Sorts the calling element's direct children by tag name. Set ascending to true for ascending order or false for descending order.

SortCaseInsensitive controls case sensitivity for the tag-name comparison.

Treats each direct child as a record and sorts those records by the value of attribute attrName on the record's child identified by sortTag.

Set ascending to true for ascending order or false for descending order. String comparisons honor SortCaseInsensitive.

Treats each direct child as a record and sorts those records by the text content of the record's child named sortTag.

Set ascending to true for ascending order or false for descending order. String comparisons honor SortCaseInsensitive.

Treats each direct child as a record and sorts those records numerically by the integer content of the record's child named sortTag.

Numeric comparison is used instead of lexicographic string comparison. Set ascending to true for ascending order or false for descending order.

Swaps the calling element's tag, text content, and attributes with those of node.

Returns true on success and false on failure.

Returns true for success, false for failure.

Swaps the calling element's complete tree state with tree, including tag, text content, attributes, and children.

Returns true on success and false on failure.

Returns true for success, false for failure.

Searches the subtree rooted at the calling element for the first element whose tag equals tagName and returns that element's text content.

Returns null on failure

Returns true if the calling element's complete tag name, including any namespace prefix, exactly equals tag; otherwise returns false.

Returns the zero-based child index of the element selected by tagPath. Returns -1 when no matching element is found at that path.

Returns true if this element's namespace-prefix portion exactly equals ns; otherwise returns false.

For example, the namespace prefix of soapenv:Body is soapenv.

Returns true if this element's unprefixed tag exactly equals unprefixedTag; otherwise returns false.

For example, the unprefixed tag of soapenv:Body is Body.

Reverses ZipContent: decodes and decompresses the calling element's compressed content and replaces the stored Base64-compressed representation with the original content.

Returns true on success and false on failure.

Returns true for success, false for failure.

Reverses ZipTree: decompresses the stored representation and reconstructs the calling element's previously compressed subtree.

The element's tag and attributes, which are not replaced by ZipTree, remain associated with the restored tree.

Returns true on success and false on failure.

Returns true for success, false for failure.

Sets the text content of the element selected by tagPath to value.

If autoCreate is true, missing elements along the path are created as needed. If it is false, the update requires the target path to already exist.

Sets attribute attrName to attrValue on the element selected by tagPath. The attribute is added when it does not already exist.

If autoCreate is true, missing elements along the path are created as needed. If it is false, the target path must already exist.

Sets attribute attrName to attrValue. If the attribute already exists its value is replaced; otherwise the attribute is added.

Returns true on success and false on failure.

Returns true for success, false for failure.

Sets attribute attrName to the decimal representation of integer value. Use UpdateAttribute for string values.

Returns true on success and false on failure.

Returns true for success, false for failure.

Sets the text content of the child selected by tagPath to value. Missing elements along the path are automatically created as needed.

Sets the content of the child selected by tagPath to the decimal representation of integer value.

ZIP-compresses this element's text content and replaces the original content with Base64-encoded compressed data.

Returns true on success and false on failure.

Returns true for success, false for failure.

ZIP-compresses the calling element's content together with its entire child subtree and replaces that structure with Base64-encoded compressed data.

The calling element's tag and attributes are not changed. Call UnzipTree to reconstruct the compressed subtree.

Returns true on success and false on failure.

Returns true for success, false for failure.