XMLw Component

Properties   Methods   Events   Configuration Settings   Errors  

The XMLw component provides an easy way to generate well-formed XML documents.

Syntax

nsoftware.IPWorks.Xmlw

Remarks

The XMLw component creates XML documents while providing you control over every aspect of the document.

To use the component first decide whether or not to write to file, a stream, or to OutputData. To write to file set OutputFile. To write to a stream call SetOutputStream. If neither OutputFile nor SetOutputStream are used the document will be created in memory and will be available from OutputData.

To begin writing the XML document first call WriteXMLDeclaration. While this is not required is it suggested so that your XML document contains a traditional XML declaration at the beginning of the document.

Next begin adding elements to your document. Calling StartElement will open an element with the specified name. To create a nested structure continue calling StartElement to open more child elements. To write a value within an element call WriteString. To close the element that was last opened call EndElement. Each time EndElement is called the element at the current level is closed. Alternatively, calling WriteElement will write the element specified with the value specified and will also close the element.

To write an attribute of the current element, after calling StartElement call WriteAttribute. Call WriteAttribute multiple times to add multiple attributes.

Writing comments or CDATA can be done at any time with the WriteComment and WriteCData methods.

To close your XML document call Close. You can call Close from any location and it will close any remaining open elements automatically.