Click here to Skip to main content
6,594,932 members and growing! (16,261 online)
Email Password   helpLost your password?
Web Development » Ajax and Atlas » General     Intermediate

Writing XML using JavaScript

By christophilus

This article illustrates a Javascript XMLWriter object.
Javascript, XML, HTML, Windows, Visual Studio, Ajax, Dev
Posted:21 Dec 2005
Views:75,772
Bookmarked:40 times
Announcements
Loading...
 
Search    
Advanced Search
Add to IE Search
printPrint   add Share
      Discuss Discuss   Broken Article?Report  
13 votes for this article.
Popularity: 4.54 Rating: 4.08 out of 5
2 votes, 15.4%
1

2

3
2 votes, 15.4%
4
9 votes, 69.2%
5

Introduction

My most recent project makes heavy use of remote scripting (or what some people might call AJAX). As such, I wanted an easy way to write XML from JavaScript so that it could be sent to my server. Now, there might be a very simple way of doing this, but I don�t know it if there is. So I decided to write a JavaScript object to simplify the process of writing XML.

Using the code

The object is called XMLWriter. It automatically replaces invalid characters such as quotation marks or greater than signs with the appropriate XML values. However, it does not throw exceptions on invalid tag names, because the application I�m writing won�t have the possibility of producing invalid tag names. If you want to add tag-name validation to the object, it should not be a difficult task.

The XMLWriter object can be created with the JavaScript new command like so:

var XML = new XMLWriter();

The XMLWriter object has the following public methods:

  • BeginNode (Name)
  • EndNode ()
  • Attrib (Name, Value)
  • WriteString (Value)
  • Node (Name, Value)
  • Close ()
  • ToString ()

BeginNode writes out an opening tag, giving it the name that you pass the method. Below is an example, followed by the XML it would produce:

XML.BeginNode(�Foo�);
//Produces:  <Foo

EndNode ends the current node (if any are still open). So following from the BeginNode example, if we were to write XML.EndNode(), the writer would write �/>�. The object is smart enough to know if you have written any text or inner nodes out and will write �</Foo>� if necessary.

Attrib writes out an attribute and value on the currently open node. Below is an example, followed by the XML it would produce:

XML.BeginNode(�Foo�);
XML.Attrib(�Bar�, �Some Value�);
XML.EndNode();
//Produces: <Foo Bar=�Some Value� />

WriteString writes out a string value to the XML document as illustrated below:

XML.BeginNode(�Foo�);
XML.WriteString(�Hello World�);
XML.EndNode();
//Produces <Foo>Hello World</Foo>

The Node method writes out a named tag and value as illustrated below:

XML.Node(�MyNode�, �My Value�);
//Produces: <MyNode>My Value</MyNode>

The Close method does not necessarily need to be called, but it�s a good idea to do so. What it does is end any nodes that have not been ended.

Finally, the ToString method returns the entire XML document as a single string (duh).

Summary

I�ve provided some sample code. The XMLWriter.js file contains all the code you will need to write XML. It is clean code, but uncommented. I�ve tested this code in IE 6.0 and FireFox 1.5.

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here

About the Author

christophilus


Member
I'm a professional geek.
Occupation: Software Developer
Location: United States United States

Other popular Ajax and Atlas articles:

Article Top
You must Sign In to use this message board.
FAQ FAQ 
 
Noise Tolerance  Layout  Per page   
 Msgs 1 to 10 of 10 (Total in Forum: 10) (Refresh)FirstPrevNext
GeneralBeginNode doesn't work PinmemberGerinald16:05 30 Jul '09  
Generalvery useful Pinmembernmreddy839:28 21 Jun '09  
QuestionUse in project Pinmembermanna4:16 17 Dec '08  
Generaluse in a project im working on Pinmembertkahn618:06 11 Jun '08  
Questionerror undifiend Pinmemberit_pushpakumara3:23 9 May '08  
GeneralQuestion about using in JSP page Pinmembermastaboywonder13:23 27 Apr '08  
Generalsave file Pinmembernh3simman19:15 17 Apr '07  
GeneralWant to write existing xml file Pinmemberpravin parmar1:37 7 Dec '06  
GeneralRe: Want to write existing xml file Pinmemberdesigning_designing4:00 18 Sep '08  
GeneralCode suggestion PinmemberMike On Code4:11 20 May '06  

General General    News News    Question Question    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

PermaLink | Privacy | Terms of Use
Last Updated: 21 Dec 2005
Editor: Smitha Vijayan
Copyright 2005 by christophilus
Everything else Copyright © CodeProject, 1999-2009
Web19 | Advertise on the Code Project