XMLGrid.SaveXML Method (EXMLGrid)

The SaveXML method saves control's content in XML format. Use the LoadXML method to load XML documents. The Name property indicates the name of the XML node being saved. The Value property indicates the value of the XML node being saved. The Image property of the Node object indicates the type of the XML node being saved. The Image property holds the type of the XML node, like listed bellow:

NODE_ELEMENT (1) The node represents an element (its nodeTypeString property is "element"). An Element node can have the following child node types: Element, Text, Comment, ProcessingInstruction, CDATASection, and EntityReference. The Element node can be the child of the Document, DocumentFragment, EntityReference, and Element nodes.
NODE_ATTRIBUTE (2) The node represents an attribute of an element (its nodeTypeString property is "attribute"). An Attribute node can have the following child node types: Text and EntityReference. The Attribute node does not appear as the child node of any other node type; it is not considered a child node of an Element.
NODE_TEXT (3) The node represents the text content of a tag (its nodeTypeString property is "text"). A Text node cannot have any child nodes. The Text node can appear as the child node of the Attribute, DocumentFragment, Element, and EntityReference nodes.
NODE_CDATA_SECTION (4) The node represents a CDATA section in the XML source (its nodeTypeString property is "cdatasection"). CDATA sections are used to escape blocks of text that would otherwise be recognized as markup. A CDATASection node cannot have any child nodes. The CDATASection node can appear as the child of the DocumentFragment, EntityReference, and Element nodes.
NODE_ENTITY_REFERENCE (5) The node represents a reference to an entity in the XML document (its nodeTypeString property is "entityreference"). This applies to all entities, including character entity references. An EntityReference node can have the following child node types: Element, ProcessingInstruction, Comment, Text, CDATASection, and EntityReference. The EntityReference node can appear as the child of the Attribute, DocumentFragment, Element, and EntityReference nodes.
NODE_ENTITY (6) The node represents an expanded entity (its nodeTypeString property is "entity"). An Entity node can have child nodes that represent the expanded entity (for example, Text and EntityReference nodes). The Entity node can appear as the child of the DocumentType node.
NODE_PROCESSING_INSTRUCTION (7) The node represents a processing instruction from the XML document (its nodeTypeString property is "processinginstruction"). A ProcessingInstruction node cannot have any child nodes. The ProcessingInstruction node can appear as the child of the Document, DocumentFragment, Element, and EntityReference nodes.
NODE_COMMENT (8) The node represents a comment in the XML document (its nodeTypeString property is "comment"). A Comment node cannot have any child nodes. The Comment node can appear as the child of the Document, DocumentFragment, Element, and EntityReference nodes.
NODE_DOCUMENT (9) The node represents a document object, that as the root of the document tree, provides access to the entire XML document (its nodeTypeString property is "document"). It is created using the progID "Microsoft.XMLDOM" or through a data island using <XML> or <SCRIPT LANGUAGE=XML>. A Document node can have the following child node types: Element (maximum of one), ProcessingInstruction, Comment, and DocumentType. The Document node cannot appear as the child of any node types.
NODE_DOCUMENT_TYPE (10) The node represents the document type declaration, indicated by the <!DOCTYPE> tag (its nodeTypeString property is "documenttype"). A DocumentType node can have the following child node types: Notation and Entity. The DocumentType node can appear as the child of the Document node.
NODE_DOCUMENT_FRAGMENT (11) The node represents a document fragment (its nodeTypeString property is "documentfragment"). The DocumentFragment node associates a node or subtree with a document without actually being contained within the document. A DocumentFragment node can have the following child node types: Element, ProcessingInstruction, Comment, Text, CDATASection, and EntityReference. The DocumentFragment node cannot appear as the child of any node types.
NODE_NOTATION (12) The node represents a notation in the document type declaration (its nodeTypeString property is "notation"). A Notation node cannot have any child nodes. The Notation node can appear as the child of the DocumentType node.

The Destination's type can be one of the following:

xmlDestination

Description

String

Specifies the file name. Note that this must be a file name, rather than a URL. The file is created if necessary and the contents are entirely replaced with the contents of the saved document. For example:
XMLGrid11.SaveXML("sample.xml")

XML Document Object

For example:

Dim xmldoc as Object Set xmldoc = CreateObject("MSXML.DOMDocument") XMLGrid11.SaveXML(xmldoc)

Custom object supporting persistence

Any other custom COM object that supports QueryInterface for IStream, IPersistStream, or IPersistStreamInit can also be provided here and the document will be saved accordingly. In the IStream case, the IStream::Write method will be called as it saves the document; in the IPersistStream case, IPersistStream::Load will be called with an IStream that supports the Read, Seek, and Stat methods.

		Return	Description
		Boolean	A Boolen expression that specifies whether saving the XML document was ok.

		Type	Description
		Destination as Variant	This object can represent a file name, reference to a string member, an XML document object, or a custom object that supports persistence as follows: String - Specifies the file name. Note that this must be a file name, rather than a URL. The file is created if necessary and the contents are entirely replaced with the contents of the saved document. For example: `XMLGrid1.SaveXML("sample.xml")` Reference to a String member - Saves the control's content to the string member. Note that the string member must be empty, before calling the SaveXML method. For example: `Dim s As String XMLGrid1.SaveXML s` In VB.NET for /NET assembly, you should call such as : `Dim s As String = String.Empty Exmlgrid1.SaveXML(s)` In C# for /NET assembly, you should call such as : `string s = string.Empty; exmlgrid1.SaveXML(ref s);` XML Document Object. For example: `Dim xmldoc as Object Set xmldoc = CreateObject("MSXML.DOMDocument") XMLGrid1.SaveXML(xmldoc)` Custom object supporting persistence - Any other custom COM object that supports QueryInterface for IStream, IPersistStream, or IPersistStreamInit can also be provided here and the document will be saved accordingly. In the IStream case, the IStream::Write method will be called as it saves the document; in the IPersistStream case, IPersistStream::Load will be called with an IStream that supports the Read, Seek, and Stat methods.

xmlDestination	Description
String	Specifies the file name. Note that this must be a file name, rather than a URL. The file is created if necessary and the contents are entirely replaced with the contents of the saved document. For example: `XMLGrid11.SaveXML("sample.xml")`
XML Document Object	For example: `Dim xmldoc as Object Set xmldoc = CreateObject("MSXML.DOMDocument") XMLGrid11.SaveXML(xmldoc)`
Custom object supporting persistence	Any other custom COM object that supports QueryInterface for IStream, IPersistStream, or IPersistStreamInit can also be provided here and the document will be saved accordingly. In the IStream case, the IStream::Write method will be called as it saves the document; in the IPersistStream case, IPersistStream::Load will be called with an IStream that supports the Read, Seek, and Stat methods.