XDeclaration Class

Inheritance Hierarchy

System.Object
  System.Xml.Linq.XDeclaration

Syntax

'Declaration
Public Class XDeclaration

public class XDeclaration

Constructors

	Name	Description
	XDeclaration(XDeclaration)	Initializes a new instance of the XDeclaration class from another XDeclaration object.
	XDeclaration(String, String, String)	Initializes a new instance of the XDeclaration class with the specified version, encoding, and standalone status.

Top

Properties

	Name	Description
	Encoding	Gets or sets the encoding for this document.
	Standalone	Gets or sets the standalone property for this document.
	Version	Gets or sets the version property for this document.

Top

Methods

	Name	Description
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Provides the declaration as a formatted string. (Overrides Object.ToString().)

Top

Remarks

An XML declaration is used to declare the XML version, the encoding, and whether or not the XML document is standalone. This class represents the XML concept of an XML declaration.

Just as in the XML standard, declarations are associated with a document. When you create a document, you have the option to specify the declaration for the document. The XDocument class contains the Declaration property, which allows you to set or get the declaration.

Examples

The following example creates a document that contains a declaration.

            Dim doc As XDocument = _
            <?xml version="1.0" encoding="utf-8" standalone="yes"?>
            <!--This is a comment-->
            <Root>content</Root>

XDocument doc = new XDocument(
    new XDeclaration("1.0", "utf-8", "yes"),
    new XComment("This is a comment"),
    new XElement("Root", "content")
);

Version Information

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

Platforms

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

Thread Safety

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

See Also

Reference

Other Resources