XComment Class

Represents an XML comment.

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

public class XComment : XNode

The XComment type exposes the following members.

  NameDescription
Public methodSupported by the XNA FrameworkXComment(String)Initializes a new instance of the XComment class with the specified string content.
Public methodSupported by the XNA FrameworkXComment(XComment)Initializes a new instance of the XComment class from an existing comment node.
Top

  NameDescription
Public propertySupported by the XNA FrameworkBaseUriGets the base URI for this XObject. (Inherited from XObject.)
Public propertySupported by the XNA FrameworkDocumentGets the XDocument for this XObject. (Inherited from XObject.)
Public propertySupported by the XNA FrameworkNextNodeGets the next sibling node of this node. (Inherited from XNode.)
Public propertySupported by the XNA FrameworkNodeTypeGets the node type for this node. (Overrides XObject.NodeType.)
Public propertySupported by the XNA FrameworkParentGets the parent XElement of this XObject. (Inherited from XObject.)
Public propertySupported by the XNA FrameworkPreviousNodeGets the previous sibling node of this node. (Inherited from XNode.)
Public propertySupported by the XNA FrameworkValueGets or sets the string value of this comment.
Top

  NameDescription
Public methodSupported by the XNA FrameworkAddAfterSelf(Object)Adds the specified content immediately after this node. (Inherited from XNode.)
Public methodSupported by the XNA FrameworkAddAfterSelf(Object[])Adds the specified content immediately after this node. (Inherited from XNode.)
Public methodSupported by the XNA FrameworkAddAnnotationAdds an object to the annotation list of this XObject. (Inherited from XObject.)
Public methodSupported by the XNA FrameworkAddBeforeSelf(Object)Adds the specified content immediately before this node. (Inherited from XNode.)
Public methodSupported by the XNA FrameworkAddBeforeSelf(Object[])Adds the specified content immediately before this node. (Inherited from XNode.)
Public methodSupported by the XNA FrameworkAncestors()Returns a collection of the ancestor elements of this node. (Inherited from XNode.)
Public methodSupported by the XNA FrameworkAncestors(XName)Returns a filtered collection of the ancestor elements of this node. Only elements that have a matching XName are included in the collection. (Inherited from XNode.)
Public methodSupported by the XNA FrameworkAnnotation(Type)Gets the first annotation object of the specified type from this XObject. (Inherited from XObject.)
Public methodSupported by the XNA FrameworkAnnotation<T>()Get the first annotation object of the specified type from this XObject. (Inherited from XObject.)
Public methodSupported by the XNA FrameworkAnnotations(Type)Gets a collection of annotations of the specified type for this XObject. (Inherited from XObject.)
Public methodSupported by the XNA FrameworkAnnotations<T>()Gets a collection of annotations of the specified type for this XObject. (Inherited from XObject.)
Public methodSupported by the XNA FrameworkCreateReader()Creates an XmlReader for this node. (Inherited from XNode.)
Public methodCreateReader(ReaderOptions)Creates an XmlReader with the options specified by the readerOptions parameter. (Inherited from XNode.)
Public methodSupported by the XNA FrameworkElementsAfterSelf()Returns a collection of the sibling elements after this node, in document order. (Inherited from XNode.)
Public methodSupported by the XNA FrameworkElementsAfterSelf(XName)Returns a filtered collection of the sibling elements after this node, in document order. Only elements that have a matching XName are included in the collection. (Inherited from XNode.)
Public methodSupported by the XNA FrameworkElementsBeforeSelf()Returns a collection of the sibling elements before this node, in document order. (Inherited from XNode.)
Public methodSupported by the XNA FrameworkElementsBeforeSelf(XName)Returns a filtered collection of the sibling elements before this node, in document order. Only elements that have a matching XName are included in the collection. (Inherited from XNode.)
Public methodSupported by the XNA FrameworkEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodSupported by the XNA FrameworkFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodSupported by the XNA FrameworkGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodSupported by the XNA FrameworkGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodSupported by the XNA FrameworkIsAfterDetermines if the current node appears after a specified node in terms of document order. (Inherited from XNode.)
Public methodSupported by the XNA FrameworkIsBeforeDetermines if the current node appears before a specified node in terms of document order. (Inherited from XNode.)
Protected methodSupported by the XNA FrameworkMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by the XNA FrameworkNodesAfterSelfReturns a collection of the sibling nodes after this node, in document order. (Inherited from XNode.)
Public methodSupported by the XNA FrameworkNodesBeforeSelfReturns a collection of the sibling nodes before this node, in document order. (Inherited from XNode.)
Public methodSupported by the XNA FrameworkRemoveRemoves this node from its parent. (Inherited from XNode.)
Public methodSupported by the XNA FrameworkRemoveAnnotations(Type)Removes the annotations of the specified type from this XObject. (Inherited from XObject.)
Public methodSupported by the XNA FrameworkRemoveAnnotations<T>()Removes the annotations of the specified type from this XObject. (Inherited from XObject.)
Public methodSupported by the XNA FrameworkReplaceWith(Object)Replaces this node with the specified content. (Inherited from XNode.)
Public methodSupported by the XNA FrameworkReplaceWith(Object[])Replaces this node with the specified content. (Inherited from XNode.)
Public methodSupported by the XNA FrameworkToString()Returns the indented XML for this node. (Inherited from XNode.)
Public methodSupported by the XNA FrameworkToString(SaveOptions)Returns the XML for this node, optionally disabling formatting. (Inherited from XNode.)
Public methodSupported by the XNA FrameworkWriteToWrite this comment to an XmlWriter. (Overrides XNode.WriteTo(XmlWriter).)
Top

  NameDescription
Public eventSupported by the XNA FrameworkChangedRaised when this XObject or any of its descendants have changed. (Inherited from XObject.)
Public eventSupported by the XNA FrameworkChangingRaised when this XObject or any of its descendants are about to change. (Inherited from XObject.)
Top

  NameDescription
Public Extension MethodCreateNavigator()Overloaded. Creates an XPathNavigator for an XNode. (Defined by Extensions.)
Public Extension MethodCreateNavigator(XmlNameTable)Overloaded. Creates an XPathNavigator for an XNode. The XmlNameTable enables more efficient XPath expression processing. (Defined by Extensions.)
Public Extension MethodXPathEvaluate(String)Overloaded. Evaluates an XPath expression. (Defined by Extensions.)
Public Extension MethodXPathEvaluate(String, IXmlNamespaceResolver)Overloaded. Evaluates an XPath expression, resolving namespace prefixes using the specified IXmlNamespaceResolver. (Defined by Extensions.)
Public Extension MethodXPathSelectElement(String)Overloaded. Selects an XElement using a XPath expression. (Defined by Extensions.)
Public Extension MethodXPathSelectElement(String, IXmlNamespaceResolver)Overloaded. Selects an XElement using a XPath expression, resolving namespace prefixes using the specified IXmlNamespaceResolver. (Defined by Extensions.)
Public Extension MethodXPathSelectElements(String)Overloaded. Selects a collection of elements using an XPath expression. (Defined by Extensions.)
Public Extension MethodXPathSelectElements(String, IXmlNamespaceResolver)Overloaded. Selects a collection of elements using an XPath expression, resolving namespace prefixes using the specified IXmlNamespaceResolver. (Defined by Extensions.)
Top

  NameDescription
Explicit interface implemetationPrivate methodSupported by the XNA FrameworkIXmlLineInfo.HasLineInfoGets a value indicating whether or not this XObject has line information. (Inherited from XObject.)
Explicit interface implemetationPrivate propertySupported by the XNA FrameworkIXmlLineInfo.LineNumberGets the line number that the underlying XmlReader reported for this XObject. (Inherited from XObject.)
Explicit interface implemetationPrivate propertySupported by the XNA FrameworkIXmlLineInfo.LinePositionGets the line position that the underlying XmlReader reported for this XObject. (Inherited from XObject.)
Top

You can add an XML comment as a child node of an element. You can also add an XML comment to an XDocument as a sibling of the root element node.

.NET Framework

Supported in: 4, 3.5

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft