Create Method (Stream, XmlWriterSettings)

XmlWriter.Create Method (Stream, XmlWriterSettings)


Creates a new XmlWriter instance using the stream and XmlWriterSettings object.

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

public static XmlWriter Create(
	Stream output,
	XmlWriterSettings settings


Type: System.IO.Stream

The stream to which you want to write. The XmlWriter writes XML 1.0 text syntax and appends it to the specified stream.

Type: System.Xml.XmlWriterSettings

The XmlWriterSettings object used to configure the new XmlWriter instance. If this is null, a XmlWriterSettings with default settings is used.

If the XmlWriter is being used with the Transform method, you should use the OutputSettings property to obtain an XmlWriterSettings object with the correct settings. This ensures that the created XmlWriter object has the correct output settings.

Return Value

Type: System.Xml.XmlWriter

An XmlWriter object.

Exception Condition

The stream value is null.

XmlWriter always writes a Byte Order Mark (BOM) to the underlying data stream; however, some streams must not have a BOM. To omit the BOM, create a new XmlWriterSettings object and set the Encoding property to be a new UTF8Encoding object with the Boolean value in the constructor set to false.

The following example writes an XML fragment to a memory stream.

XmlWriterSettings settings = new XmlWriterSettings();
settings.OmitXmlDeclaration = true;
settings.ConformanceLevel = ConformanceLevel.Fragment;
settings.CloseOutput = false;

// Create the XmlWriter object and write some content.
MemoryStream strm = new MemoryStream();
XmlWriter writer = XmlWriter.Create(strm, settings);
writer.WriteElementString("orderID", "1-456-ab");
writer.WriteElementString("orderID", "2-36-00a");

// Do additonal processing on the stream.

Universal Windows Platform
Available since 4.5
.NET Framework
Available since 2.0
Portable Class Library
Supported in: portable .NET platforms
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top
© 2015 Microsoft