XComment Class
Microsoft Silverlight will reach end of support after October 2021. Learn more.
Represents an XML comment.
Inheritance Hierarchy
System.Object
System.Xml.Linq.XObject
System.Xml.Linq.XNode
System.Xml.Linq.XComment
Namespace: System.Xml.Linq
Assembly: System.Xml.Linq (in System.Xml.Linq.dll)
Syntax
'Declaration
Public Class XComment _
Inherits XNode
public class XComment : XNode
The XComment type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") .gif "Supported by Silverlight for Windows Phone") .gif "Supported by Xbox 360") |
XComment(String) | Initializes a new instance of the XComment class with the specified string content. |
|
XComment(XComment) | Initializes a new instance of the XComment class from an existing comment node. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
BaseUri | Gets the base URI for this XObject. (Inherited from XObject.) |
|
Document | Gets the XDocument for this XObject. (Inherited from XObject.) |
|
NextNode | Gets the next sibling node of this node. (Inherited from XNode.) |
|
NodeType | Gets the node type for this node. (Overrides XObject.NodeType.) |
|
Parent | Gets the parent XElement of this XObject. (Inherited from XObject.) |
|
PreviousNode | Gets the previous sibling node of this node. (Inherited from XNode.) |
|
Value | Gets or sets the string value of this comment. |
Top
Methods
| Name | Description | |
|---|---|---|
|
AddAfterSelf(Object) | Adds the specified content immediately after this node. (Inherited from XNode.) |
|
AddAfterSelf(array<Object[]) | Adds the specified content immediately after this node. (Inherited from XNode.) |
|
AddAnnotation | Adds an object to the annotation list of this XObject. (Inherited from XObject.) |
|
AddBeforeSelf(Object) | Adds the specified content immediately before this node. (Inherited from XNode.) |
|
AddBeforeSelf(array<Object[]) | Adds the specified content immediately before this node. (Inherited from XNode.) |
|
Ancestors() | Returns a collection of the ancestor elements of this node. (Inherited from XNode.) |
|
Ancestors(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.) |
|
Annotation(Type) | Gets the first annotation object of the specified type from this XObject. (Inherited from XObject.) |
|
Annotation<T>() | Get the first annotation object of the specified type from this XObject. (Inherited from XObject.) |
|
Annotations(Type) | Gets a collection of annotations of the specified type for this XObject. (Inherited from XObject.) |
|
Annotations<T>() | Gets a collection of annotations of the specified type for this XObject. (Inherited from XObject.) |
|
CreateReader() | Creates an XmlReader for this node. (Inherited from XNode.) |
|
CreateReader(ReaderOptions) | Creates an XmlReader for this node. (Inherited from XNode.) |
|
ElementsAfterSelf() | Returns a collection of the sibling elements after this node, in document order. (Inherited from XNode.) |
|
ElementsAfterSelf(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.) |
|
ElementsBeforeSelf() | Returns a collection of the sibling elements before this node, in document order. (Inherited from XNode.) |
|
ElementsBeforeSelf(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.) |
|
Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
.gif "Protected method") |
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.) |
|
IsAfter | Determines if the current node appears after a specified node in terms of document order. (Inherited from XNode.) |
|
IsBefore | Determines if the current node appears before a specified node in terms of document order. (Inherited from XNode.) |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
NodesAfterSelf | Returns a collection of the sibling nodes after this node, in document order. (Inherited from XNode.) |
|
NodesBeforeSelf | Returns a collection of the sibling nodes before this node, in document order. (Inherited from XNode.) |
|
Remove | Removes this node from its parent. (Inherited from XNode.) |
|
RemoveAnnotations(Type) | Removes the annotations of the specified type from this XObject. (Inherited from XObject.) |
|
RemoveAnnotations<T>() | Removes the annotations of the specified type from this XObject. (Inherited from XObject.) |
|
ReplaceWith(Object) | Replaces this node with the specified content. (Inherited from XNode.) |
|
ReplaceWith(array<Object[]) | Replaces this node with the specified content. (Inherited from XNode.) |
|
ToString() | Returns the indented XML for this node. (Inherited from XNode.) |
|
ToString(SaveOptions) | Returns the XML for this node, optionally disabling formatting. (Inherited from XNode.) |
|
WriteTo | Write this comment to an XmlWriter. (Overrides XNode.WriteTo(XmlWriter).) |
Top
Events
| Name | Description | |
|---|---|---|
.gif "Public event") |
Changed | Raised when this XObject or any of its descendants have changed. (Inherited from XObject.) |
|
Changing | Raised when this XObject or any of its descendants are about to change. (Inherited from XObject.) |
Top
Extension Methods
| Name | Description | |
|---|---|---|
.gif "Public Extension Method") |
CreateNavigator() | Overloaded. Creates an XPathNavigator for an XNode. (Defined by Extensions.) |
|
CreateNavigator(XmlNameTable) | Overloaded. Creates an XPathNavigator for an XNode. The XmlNameTable enables more efficient XPath expression processing. (Defined by Extensions.) |
|
XPathEvaluate(String) | Overloaded. Evaluates an XPath expression. (Defined by Extensions.) |
|
XPathEvaluate(String, IXmlNamespaceResolver) | Overloaded. Evaluates an XPath expression, resolving namespace prefixes using the specified IXmlNamespaceResolver. (Defined by Extensions.) |
|
XPathSelectElement(String) | Overloaded. Selects an XElement using a XPath expression. (Defined by Extensions.) |
|
XPathSelectElement(String, IXmlNamespaceResolver) | Overloaded. Selects an XElement using a XPath expression, resolving namespace prefixes using the specified IXmlNamespaceResolver. (Defined by Extensions.) |
|
XPathSelectElements(String) | Overloaded. Selects a collection of elements using an XPath expression. (Defined by Extensions.) |
|
XPathSelectElements(String, IXmlNamespaceResolver) | Overloaded. Selects a collection of elements using an XPath expression, resolving namespace prefixes using the specified IXmlNamespaceResolver. (Defined by Extensions.) |
Top
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
.gif "Explicit interface implemetation") .gif "Private method") |
IXmlLineInfo.HasLineInfo | Gets a value indicating whether or not this XObject has line information. (Inherited from XObject.) |
.gif "Private property") |
IXmlLineInfo.LineNumber | Gets the line number that the underlying XmlReader reported for this XObject. (Inherited from XObject.) |
|
IXmlLineInfo.LinePosition | Gets the line position that the underlying XmlReader reported for this XObject. (Inherited from XObject.) |
Top
Remarks
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.
Examples
The following example creates an element that contains a comment as a child node.
Dim output As New StringBuilder
Dim root As XElement = <Root>
<!--This is a comment-->
</Root>
output.Append(root)
output.Append(Environment.NewLine)
OutputTextBlock.Text = output.ToString()
StringBuilder output = new StringBuilder();
XElement root = new XElement("Root",
new XComment("This is a comment")
);
output.Append(root + 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.
See Also