Article
11/18/2011

XObject Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Represents a node or an attribute in an XML tree.

Inheritance Hierarchy

System.Object
  System.Xml.Linq.XObject
    System.Xml.Linq.XAttribute
    System.Xml.Linq.XNode

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

Syntax

'Declaration
Public MustInherit Class XObject _
    Implements IXmlLineInfo

public abstract class XObject : IXmlLineInfo

The XObject type exposes the following members.

Properties

	Name	Description
	BaseUri	Gets the base URI for this XObject.
	Document	Gets the XDocument for this XObject.
	NodeType	Gets the node type for this XObject.
	Parent	Gets the parent XElement of this XObject.

Top

Methods

	Name	Description
	AddAnnotation	Adds an object to the annotation list of this XObject.
	Annotation(Type)	Gets the first annotation object of the specified type from this XObject.
	Annotation<T>()	Get the first annotation object of the specified type from this XObject.
	Annotations(Type)	Gets a collection of annotations of the specified type for this XObject.
	Annotations<T>()	Gets a collection of annotations of the specified type for this XObject.
	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.)
	RemoveAnnotations(Type)	Removes the annotations of the specified type from this XObject.
	RemoveAnnotations<T>()	Removes the annotations of the specified type from this XObject.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Events

	Name	Description
	Changed	Raised when this XObject or any of its descendants have changed.
	Changing	Raised when this XObject or any of its descendants are about to change.

Top

Explicit Interface Implementations

	Name	Description
	IXmlLineInfo.HasLineInfo	Gets a value indicating whether or not this XObject has line information.
	IXmlLineInfo.LineNumber	Gets the line number that the underlying XmlReader reported for this XObject.
	IXmlLineInfo.LinePosition	Gets the line position that the underlying XmlReader reported for this XObject.

Top

Remarks

This class is the abstract common base class for XNode and XAttribute. It provides some basic functionality that is common to both classes, such as annotations, and raising events when nodes have changed.

Note that annotations are not part of the XML infoset; they are not serialized or deserialized.

Examples

The following example creates a document with some complex content. It then uses this property to retrieve the document for the Child element.

Dim output As New StringBuilder
Dim doc As XDocument = _
        <?xml version="1.0"?>
        <!--A comment in the document.-->
        <Root>
            <Child>content</Child>
        </Root>
Dim child As XElement = doc.Descendants("Child").First()
Dim documentOfChild As XDocument = child.Document
output.Append(documentOfChild.FirstNode)
output.Append(Environment.NewLine)

OutputTextBlock.Text = output.ToString()

StringBuilder output = new StringBuilder();
XDocument doc = new XDocument(
    new XComment("A comment in the document."),
    new XElement("Root",
        new XElement("Child", "content")
    )
);
XElement child = doc.Descendants("Child").First();
XDocument documentOfChild = child.Document;
output.Append(documentOfChild.FirstNode + Environment.NewLine);

OutputTextBlock.Text = output.ToString();

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.

Share via