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)

'Declaration
Public MustInherit Class XmlWriter _
	Implements IDisposable

The XmlWriter type exposes the following members.

  NameDescription
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibraryXmlWriterInitializes a new instance of the XmlWriter class.
Top

  NameDescription
Public propertySupported by the XNA FrameworkSupported by Portable Class LibrarySettingsGets the XmlWriterSettings object used to create this XmlWriter instance.
Public propertySupported by the XNA FrameworkSupported by Portable Class LibraryWriteStateWhen overridden in a derived class, gets the state of the writer.
Public propertySupported by the XNA FrameworkSupported by Portable Class LibraryXmlLangWhen overridden in a derived class, gets the current xml:lang scope.
Public propertySupported by the XNA FrameworkSupported by Portable Class LibraryXmlSpaceWhen overridden in a derived class, gets an XmlSpace representing the current xml:space scope.
Top

  NameDescription
Public methodSupported by the XNA FrameworkCloseWhen overridden in a derived class, closes this stream and the underlying stream.
Public methodStatic memberSupported by the XNA FrameworkSupported by Portable Class LibraryCreate(Stream)Creates a new XmlWriter instance using the specified stream.
Public methodStatic memberSupported by the XNA FrameworkCreate(String)Creates a new XmlWriter instance using the specified filename.
Public methodStatic memberSupported by the XNA FrameworkSupported by Portable Class LibraryCreate(StringBuilder)Creates a new XmlWriter instance using the specified StringBuilder.
Public methodStatic memberSupported by the XNA FrameworkSupported by Portable Class LibraryCreate(TextWriter)Creates a new XmlWriter instance using the specified TextWriter.
Public methodStatic memberSupported by the XNA FrameworkSupported by Portable Class LibraryCreate(XmlWriter)Creates a new XmlWriter instance using the specified XmlWriter object.
Public methodStatic memberSupported by the XNA FrameworkSupported by Portable Class LibraryCreate(Stream, XmlWriterSettings)Creates a new XmlWriter instance using the stream and XmlWriterSettings object.
Public methodStatic memberSupported by the XNA FrameworkCreate(String, XmlWriterSettings)Creates a new XmlWriter instance using the filename and XmlWriterSettings object.
Public methodStatic memberSupported by the XNA FrameworkSupported by Portable Class LibraryCreate(StringBuilder, XmlWriterSettings)Creates a new XmlWriter instance using the StringBuilder and XmlWriterSettings objects.
Public methodStatic memberSupported by the XNA FrameworkSupported by Portable Class LibraryCreate(TextWriter, XmlWriterSettings)Creates a new XmlWriter instance using the TextWriter and XmlWriterSettings objects.
Public methodStatic memberSupported by the XNA FrameworkSupported by Portable Class LibraryCreate(XmlWriter, XmlWriterSettings)Creates a new XmlWriter instance using the specified XmlWriter and XmlWriterSettings objects.
Public methodSupported by Portable Class LibraryDispose
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibraryDispose(Boolean)Releases the unmanaged resources used by the XmlWriter and optionally releases the managed resources.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibraryFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryFlushWhen overridden in a derived class, flushes whatever is in the buffer to the underlying streams and also flushes the underlying stream.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryLookupPrefixWhen overridden in a derived class, returns the closest prefix defined in the current namespace scope for the namespace URI.
Protected methodSupported by the XNA FrameworkSupported by Portable Class LibraryMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteAttributesWhen overridden in a derived class, writes out all the attributes found at the current position in the XmlReader.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteAttributeString(String, String)When overridden in a derived class, writes out the attribute with the specified local name and value.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteAttributeString(String, String, String)When overridden in a derived class, writes an attribute with the specified local name, namespace URI, and value.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteAttributeString(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 the XNA FrameworkSupported by Portable Class LibraryWriteBase64When overridden in a derived class, encodes the specified binary bytes as Base64 and writes out the resulting text.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteBinHexWhen overridden in a derived class, encodes the specified binary bytes as BinHex and writes out the resulting text.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteCDataWhen overridden in a derived class, writes out a <![CDATA[...]]> block containing the specified text.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteCharEntityWhen overridden in a derived class, forces the generation of a character entity for the specified Unicode character value.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteCharsWhen overridden in a derived class, writes text one buffer at a time.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteCommentWhen overridden in a derived class, writes out a comment <!--...--> containing the specified text.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteDocTypeWhen overridden in a derived class, writes the DOCTYPE declaration with the specified name and optional attributes.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteElementString(String, String)Writes an element with the specified local name and value.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteElementString(String, String, String)Writes an element with the specified local name, namespace URI, and value.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteElementString(String, String, String, String)Writes an element with the specified local name, namespace URI, and value.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteEndAttributeWhen overridden in a derived class, closes the previous WriteStartAttribute call.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteEndDocumentWhen overridden in a derived class, closes any open elements or attributes and puts the writer back in the Start state.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteEndElementWhen overridden in a derived class, closes one element and pops the corresponding namespace scope.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteEntityRefWhen overridden in a derived class, writes out an entity reference as &name;.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteFullEndElementWhen overridden in a derived class, closes one element and pops the corresponding namespace scope.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteNameWhen 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 the XNA FrameworkSupported by Portable Class LibraryWriteNmTokenWhen 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 the XNA FrameworkSupported by Portable Class LibraryWriteNode(XmlReader, Boolean)When 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 methodWriteNode(XPathNavigator, Boolean)Copies everything from the XPathNavigator object to the writer. The position of the XPathNavigator remains unchanged.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteProcessingInstructionWhen 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 the XNA FrameworkSupported by Portable Class LibraryWriteQualifiedNameWhen 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 the XNA FrameworkSupported by Portable Class LibraryWriteRaw(String)When overridden in a derived class, writes raw markup manually from a string.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteRaw(Char(), Int32, Int32)When overridden in a derived class, writes raw markup manually from a character buffer.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteStartAttribute(String)Writes the start of an attribute with the specified local name.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteStartAttribute(String, String)Writes the start of an attribute with the specified local name and namespace URI.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteStartAttribute(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 the XNA FrameworkSupported by Portable Class LibraryWriteStartDocumentWhen overridden in a derived class, writes the XML declaration with the version "1.0".
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteStartDocument(Boolean)When overridden in a derived class, writes the XML declaration with the version "1.0" and the standalone attribute.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteStartElement(String)When overridden in a derived class, writes out a start tag with the specified local name.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteStartElement(String, String)When overridden in a derived class, writes the specified start tag and associates it with the given namespace.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteStartElement(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 the XNA FrameworkSupported by Portable Class LibraryWriteStringWhen overridden in a derived class, writes the given text content.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteSurrogateCharEntityWhen overridden in a derived class, generates and writes the surrogate character entity for the surrogate character pair.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteValue(Boolean)Writes a Boolean value.
Public methodSupported by the XNA FrameworkWriteValue(DateTime)Writes a DateTime value.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteValue(Decimal)Writes a Decimal value.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteValue(Double)Writes a Double value.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteValue(Int32)Writes a Int32 value.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteValue(Int64)Writes a Int64 value.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteValue(Object)Writes the object value.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteValue(Single)Writes a single-precision floating-point number.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteValue(String)Writes a String value.
Public methodSupported by the XNA FrameworkSupported by Portable Class LibraryWriteWhitespaceWhen overridden in a derived class, writes out the given white space.
Top

  NameDescription
Explicit interface implemetationPrivate methodSupported by the XNA FrameworkIDisposable.DisposeFor a description of this member, see IDisposable.Dispose.
Top

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

NoteNote

Although the Microsoft .NET Framework includes the XmlTextWriter class, which is an implementation of the XmlWriter class, in the 2.0 release, it is recommended that you use the Create method to create new XmlWriter objects. The Create method allows you to specify the features to support on the created XmlWriter object, and it also allows you to take full advantage of the new features introduced in the 2.0 release.

NoteNote

When you use the XmlWriter methods to output XML, the elements and attributes will not be written until you call the Close method. For example, if you are using the XmlWriter to populate an XmlDocument, until you close the XmlWriter, you will not be able to observe the written elements and attributes in the target document.

For more information about the XmlWriter class, see Writing XML with the XmlWriter.

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.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft