XObject Class

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
Public propertySupported by Silverlight for Windows PhoneSupported by Xbox 360 BaseUri Gets the base URI for this XObject.
Public propertySupported by Silverlight for Windows PhoneSupported by Xbox 360 Document Gets the XDocument for this XObject.
Public propertySupported by Silverlight for Windows PhoneSupported by Xbox 360 NodeType Gets the node type for this XObject.
Public propertySupported by Silverlight for Windows PhoneSupported by Xbox 360 Parent Gets the parent XElement of this XObject.

Top

Methods

  Name Description
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 AddAnnotation Adds an object to the annotation list of this XObject.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Annotation(Type) Gets the first annotation object of the specified type from this XObject.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Annotation<T>() Get the first annotation object of the specified type from this XObject.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Annotations(Type) Gets a collection of annotations of the specified type for this XObject.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Annotations<T>() Gets a collection of annotations of the specified type for this XObject.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 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.)
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 GetType Gets the Type of the current instance. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 RemoveAnnotations(Type) Removes the annotations of the specified type from this XObject.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 RemoveAnnotations<T>() Removes the annotations of the specified type from this XObject.
Public methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Events

  Name Description
Public eventSupported by Silverlight for Windows PhoneSupported by Xbox 360 Changed Raised when this XObject or any of its descendants have changed.
Public eventSupported by Silverlight for Windows PhoneSupported by Xbox 360 Changing Raised when this XObject or any of its descendants are about to change.

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate methodSupported by Silverlight for Windows PhoneSupported by Xbox 360 IXmlLineInfo.HasLineInfo Gets a value indicating whether or not this XObject has line information.
Explicit interface implemetationPrivate propertySupported by Silverlight for Windows PhoneSupported by Xbox 360 IXmlLineInfo.LineNumber Gets the line number that the underlying XmlReader reported for this XObject.
Explicit interface implemetationPrivate propertySupported by Silverlight for Windows PhoneSupported by Xbox 360 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.