Export (0) Print
Expand All

XmlWriter Class

Represents a writer that provides a fast, non-cached, forward-only means of generating streams or files containing XML data.

Namespace:  System.Xml
Assembly:  System.Xml (in System.Xml.dll)

public abstract class XmlWriter : IDisposable

The XmlWriter type exposes the following members.

  NameDescription
Protected methodSupported by Silverlight for Windows PhoneSupported by Xbox 360XmlWriterInitializes a new instance of the XmlWriter class.
Top

  NameDescription
Public propertySupported by Silverlight for Windows PhoneSupported by Xbox 360SettingsGets the XmlWriterSettings object used to create this XmlWriter instance.
Public propertySupported by Silverlight for Windows PhoneSupported by Xbox 360WriteStateWhen overridden in a derived class, gets the state of the writer.
Public propertySupported by Silverlight for Windows PhoneSupported by Xbox 360XmlLangWhen overridden in a derived class, gets the current xml:lang scope.
Public propertySupported by Silverlight for Windows PhoneSupported by Xbox 360XmlSpaceWhen overridden in a derived class, gets an XmlSpace representing the current xml:space scope.
Top

  NameDescription
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360CloseWhen overridden in a derived class, closes this stream and the underlying stream.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360Create(Stream)Creates a new XmlWriter instance using the specified stream.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360Create(StringBuilder)Creates a new XmlWriter instance using the specified StringBuilder.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360Create(TextWriter)Creates a new XmlWriter instance using the specified TextWriter.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360Create(XmlWriter)Creates a new XmlWriter instance using the specified XmlWriter object.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360Create(Stream, XmlWriterSettings)Creates a new XmlWriter instance using the stream and XmlWriterSettings object.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360Create(StringBuilder, XmlWriterSettings)Creates a new XmlWriter instance using the StringBuilder and XmlWriterSettings objects.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360Create(TextWriter, XmlWriterSettings)Creates a new XmlWriter instance using the TextWriter and XmlWriterSettings objects.
Public methodStatic memberSupported by Silverlight for Windows PhoneSupported by Xbox 360Create(XmlWriter, XmlWriterSettings)Creates a new XmlWriter instance using the specified XmlWriter and XmlWriterSettings objects.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360Dispose()
Protected methodSupported by Silverlight for Windows PhoneSupported by Xbox 360Dispose(Boolean)Releases the unmanaged resources used by the XmlWriter and optionally releases the managed resources.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360Equals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows PhoneSupported by Xbox 360FinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360FlushWhen overridden in a derived class, flushes whatever is in the buffer to the underlying streams and also flushes the underlying stream.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360GetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360GetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360LookupPrefixWhen overridden in a derived class, returns the closest prefix defined in the current namespace scope for the namespace URI.
Protected methodSupported by Silverlight for Windows PhoneSupported by Xbox 360MemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360ToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteAttributesWhen overridden in a derived class, writes out all the attributes found at the current position in the XmlReader.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteAttributeString(String, String)When overridden in a derived class, writes out the attribute with the specified local name and value.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteAttributeString(String, String, String)When overridden in a derived class, writes an attribute with the specified local name, namespace URI, and value.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteAttributeString(String, String, String, String)When overridden in a derived class, writes out the attribute with the specified prefix, local name, namespace URI, and value.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteBase64When overridden in a derived class, encodes the specified binary bytes as Base64 and writes out the resulting text.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteBinHexWhen overridden in a derived class, encodes the specified binary bytes as BinHex and writes out the resulting text.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteCDataWhen overridden in a derived class, writes out a <![CDATA[...]]> block containing the specified text.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteCharEntityWhen overridden in a derived class, forces the generation of a character entity for the specified Unicode character value.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteCharsWhen overridden in a derived class, writes text one buffer at a time.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteCommentWhen overridden in a derived class, writes out a comment <!--...--> containing the specified text.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteDocTypeWhen overridden in a derived class, writes the DOCTYPE declaration with the specified name and optional attributes.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteElementString(String, String)When overridden in a derived class, writes an element with the specified local name and value.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteElementString(String, String, String)When overridden in a derived class, writes an element with the specified local name, namespace URI, and value.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteElementString(String, String, String, String)Writes an element with the specified local name, namespace URI, and value.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteEndAttributeWhen overridden in a derived class, closes the previous WriteStartAttribute call.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteEndDocumentWhen overridden in a derived class, closes any open elements or attributes and puts the writer back in the Start state.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteEndElementWhen overridden in a derived class, closes one element and pops the corresponding namespace scope.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteEntityRefWhen overridden in a derived class, writes out an entity reference as &name;.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteFullEndElementWhen overridden in a derived class, closes one element and pops the corresponding namespace scope.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteNameWhen overridden in a derived class, writes out the specified name, ensuring it is a valid name according to the W3C XML 1.0 recommendation (http://www.w3.org/TR/1998/REC-xml-19980210#NT-Name).
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteNmTokenWhen overridden in a derived class, writes out the specified name, ensuring it is a valid NmToken according to the W3C XML 1.0 recommendation (http://www.w3.org/TR/1998/REC-xml-19980210#NT-Name).
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteNodeWhen overridden in a derived class, copies everything from the reader to the writer and moves the reader to the start of the next sibling.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteProcessingInstructionWhen overridden in a derived class, writes out a processing instruction with a space between the name and text as follows: <?name text?>.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteQualifiedNameWhen overridden in a derived class, writes out the namespace-qualified name. This method looks up the prefix that is in scope for the given namespace.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteRaw(String)When overridden in a derived class, writes raw markup manually from a string.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteRaw(Char[], Int32, Int32)When overridden in a derived class, writes raw markup manually from a character buffer.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteStartAttribute(String)Writes the start of an attribute with the specified local name.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteStartAttribute(String, String)Writes the start of an attribute with the specified local name and namespace URI.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteStartAttribute(String, String, String)When overridden in a derived class, writes the start of an attribute with the specified prefix, local name, and namespace URI.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteStartDocument()When overridden in a derived class, writes the XML declaration with the version "1.0".
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteStartDocument(Boolean)When overridden in a derived class, writes the XML declaration with the version "1.0" and the standalone attribute.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteStartElement(String)When overridden in a derived class, writes out a start tag with the specified local name.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteStartElement(String, String)When overridden in a derived class, writes the specified start tag and associates it with the given namespace.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteStartElement(String, String, String)When overridden in a derived class, writes the specified start tag and associates it with the given namespace and prefix.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteStringWhen overridden in a derived class, writes the given text content.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteSurrogateCharEntityWhen overridden in a derived class, generates and writes the surrogate character entity for the surrogate character pair.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteValue(Boolean)Writes a Boolean value.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteValue(DateTime)Writes a DateTime value.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteValue(Decimal)Writes a Decimal value.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteValue(Double)Writes a Double value.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteValue(Int32)Writes a Int32 value.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteValue(Int64)Writes a Int64 value.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteValue(Object)Writes the object value.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteValue(Single)Writes a single-precision floating-point number.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteValue(String)Writes a String value.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360WriteWhitespaceWhen overridden in a derived class, writes out the given white space.
Top

The XmlWriter class supports the W3C Extensible Markup Language (XML) 1.0 and the Namespaces in XML recommendations.

NoteNote:

You must use the Create method to create XmlWriter object.

Note   When you use the XmlWriter methods to output XML, the elements and attributes will not be written until you call the Close method.

Security Considerations

The following items are things to consider when working with the XmlWriter class.

  • Exceptions thrown by the XmlWriter can disclose path information that you do not want bubbled up to the application. Your applications must catch exceptions and process them appropriately.

  • The XmlWriter does not validate any data that is passed to the WriteDocType or WriteRaw methods. You should not pass arbitrary data to these methods.

The following example navigates through the stream to determine the current node type, and then uses XmlWriter to output the XmlReader content.


StringBuilder output = new StringBuilder();

String xmlString =
        @"<?xml version='1.0'?>
        <!-- This is a sample XML document -->
        <Items>
          <Item>test with a child element <more/> stuff</Item>
        </Items>";
// Create an XmlReader
using (XmlReader reader = XmlReader.Create(new StringReader(xmlString)))
{
    XmlWriterSettings ws = new XmlWriterSettings();
    ws.Indent = true;
    using (XmlWriter writer = XmlWriter.Create(output, ws))
    {

        // Parse the file and display each of the nodes.
        while (reader.Read())
        {
            switch (reader.NodeType)
            {
                case XmlNodeType.Element:
                    writer.WriteStartElement(reader.Name);
                    break;
                case XmlNodeType.Text:
                    writer.WriteString(reader.Value);
                    break;
                case XmlNodeType.XmlDeclaration:
                case XmlNodeType.ProcessingInstruction:
                    writer.WriteProcessingInstruction(reader.Name, reader.Value);
                    break;
                case XmlNodeType.Comment:
                    writer.WriteComment(reader.Value);
                    break;
                case XmlNodeType.EndElement:
                    writer.WriteFullEndElement();
                    break;
            }
        }

    }
}
OutputTextBlock.Text = output.ToString();


Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

XNA Framework

Supported in: Xbox 360, Windows Phone OS 7.0

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Community Additions

ADD
Show:
© 2014 Microsoft