XmlWriterSettings.Async Property

.NET Framework (current version)

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets or sets a value that indicates whether asynchronous XmlWriter methods can be used on a particular XmlWriter instance.

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

public bool Async { get; set; }

Property Value

Type: System.Boolean

true if asynchronous methods can be used; otherwise, false.

You must set this value to true when you create a new XmlWriter instance if you want to use asynchronous XmlWriter methods on that instance. After the XmlWriter instance is created, the Async property is read-only. The default value of this property is false.

This flag is ignored by the XmlWriter.Create overload. This means that if you create a new XmlWriter based on an existing XmlWriter, the async behavior depends on the input XmlWriter, and you cannot use the Async flag to change the async behavior.

Universal Windows Platform
Available since 8
.NET Framework
Available since 4.5
Portable Class Library
Supported in: portable .NET platforms
Windows Phone Silverlight
Available since 8.0
Windows Phone
Available since 8.1
Return to top