Export (0) Print
Expand All
Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

XComment Class

July 28, 2014

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 methodXComment(String)Initializes a new instance of the XComment class with the specified string content.
Public methodXComment(XComment)Initializes a new instance of the XComment class from an existing comment node.
Top

  NameDescription
Public propertyBaseUriGets the base URI for this XObject. (Inherited from XObject.)
Public propertyDocumentGets the XDocument for this XObject. (Inherited from XObject.)
Public propertyNextNodeGets the next sibling node of this node. (Inherited from XNode.)
Public propertyNodeTypeGets the node type for this node. (Overrides XObject.NodeType.)
Public propertyParentGets the parent XElement of this XObject. (Inherited from XObject.)
Public propertyPreviousNodeGets the previous sibling node of this node. (Inherited from XNode.)
Public propertyValueGets or sets the string value of this comment.
Top

  NameDescription
Public methodAddAfterSelf(Object)Adds the specified content immediately after this node. (Inherited from XNode.)
Public methodAddAfterSelf(Object[])Adds the specified content immediately after this node. (Inherited from XNode.)
Public methodAddAnnotationAdds an object to the annotation list of this XObject. (Inherited from XObject.)
Public methodAddBeforeSelf(Object)Adds the specified content immediately before this node. (Inherited from XNode.)
Public methodAddBeforeSelf(Object[])Adds the specified content immediately before this node. (Inherited from XNode.)
Public methodAncestors()Returns a collection of the ancestor elements of this node. (Inherited from XNode.)
Public methodAncestors(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 methodAnnotation(Type)Gets the first annotation object of the specified type from this XObject. (Inherited from XObject.)
Public methodAnnotation<T>()Get the first annotation object of the specified type from this XObject. (Inherited from XObject.)
Public methodAnnotations(Type)Gets a collection of annotations of the specified type for this XObject. (Inherited from XObject.)
Public methodAnnotations<T>()Gets a collection of annotations of the specified type for this XObject. (Inherited from XObject.)
Public methodCreateReader()Creates an XmlReader for this node. (Inherited from XNode.)
Public methodCreateReader(ReaderOptions)Creates an XmlReader for this node. (Inherited from XNode.)
Public methodElementsAfterSelf()Returns a collection of the sibling elements after this node, in document order. (Inherited from XNode.)
Public methodElementsAfterSelf(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 methodElementsBeforeSelf()Returns a collection of the sibling elements before this node, in document order. (Inherited from XNode.)
Public methodElementsBeforeSelf(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 methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIsAfterDetermines if the current node appears after a specified node in terms of document order. (Inherited from XNode.)
Public methodIsBeforeDetermines if the current node appears before a specified node in terms of document order. (Inherited from XNode.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodNodesAfterSelfReturns a collection of the sibling nodes after this node, in document order. (Inherited from XNode.)
Public methodNodesBeforeSelfReturns a collection of the sibling nodes before this node, in document order. (Inherited from XNode.)
Public methodRemoveRemoves this node from its parent. (Inherited from XNode.)
Public methodRemoveAnnotations(Type)Removes the annotations of the specified type from this XObject. (Inherited from XObject.)
Public methodRemoveAnnotations<T>()Removes the annotations of the specified type from this XObject. (Inherited from XObject.)
Public methodReplaceWith(Object)Replaces this node with the specified content. (Inherited from XNode.)
Public methodReplaceWith(Object[])Replaces this node with the specified content. (Inherited from XNode.)
Public methodToString()Returns the indented XML for this node. (Inherited from XNode.)
Public methodToString(SaveOptions)Returns the XML for this node, optionally disabling formatting. (Inherited from XNode.)
Public methodWriteToWrite this comment to an XmlWriter. (Overrides XNode.WriteTo(XmlWriter).)
Top

  NameDescription
Public eventChangedRaised when this XObject or any of its descendants have changed. (Inherited from XObject.)
Public eventChangingRaised when this XObject or any of its descendants are about to change. (Inherited from XObject.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIXmlLineInfo.HasLineInfoGets a value indicating whether or not this XObject has line information. (Inherited from XObject.)
Explicit interface implemetationPrivate propertyIXmlLineInfo.LineNumberGets the line number that the underlying XmlReader reported for this XObject. (Inherited from XObject.)
Explicit interface implemetationPrivate propertyIXmlLineInfo.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.

The following example creates an element that contains a comment as a child node.


StringBuilder output = new StringBuilder();
XElement root = new XElement("Root",
    new XComment("This is a comment")
);
output.Append(root  + Environment.NewLine);

OutputTextBlock.Text = output.ToString();


Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Windows Phone

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

Show:
© 2014 Microsoft