mscorlib(4.0.0.0) API with additions
System.Xml.XmlComment Class Reference

Represents the content of an XML comment. More...

Inheritance diagram for System.Xml.XmlComment:
[legend]
Collaboration diagram for System.Xml.XmlComment:
[legend]

Public Member Functions

override XmlNode CloneNode (bool deep)
 Creates a duplicate of this node. More...
 
override void WriteTo (XmlWriter w)
 Saves the node to the specified T:System.Xml.XmlWriter. More...
 
override void WriteContentTo (XmlWriter w)
 Saves all the children of the node to the specified T:System.Xml.XmlWriter. Because comment nodes do not have children, this method has no effect. More...
 
- Public Member Functions inherited from System.Xml.XmlCharacterData
virtual string Substring (int offset, int count)
 Retrieves a substring of the full string from the specified range. More...
 
virtual void AppendData (string strData)
 Appends the specified string to the end of the character data of the node. More...
 
virtual void InsertData (int offset, string strData)
 Inserts the specified string at the specified character offset. More...
 
virtual void DeleteData (int offset, int count)
 Removes a range of characters from the node. More...
 
virtual void ReplaceData (int offset, int count, string strData)
 Replaces the specified number of characters starting at the specified offset with the specified string. More...
 
- Public Member Functions inherited from System.Xml.XmlNode
virtual XPathNavigator CreateNavigator ()
 Creates an T:System.Xml.XPath.XPathNavigator for navigating this object. More...
 
XmlNode SelectSingleNode (string xpath)
 Selects the first XmlNode that matches the XPath expression. More...
 
XmlNode SelectSingleNode (string xpath, XmlNamespaceManager nsmgr)
 Selects the first XmlNode that matches the XPath expression. Any prefixes found in the XPath expression are resolved using the supplied T:System.Xml.XmlNamespaceManager. More...
 
XmlNodeList SelectNodes (string xpath)
 Selects a list of nodes matching the XPath expression. More...
 
XmlNodeList SelectNodes (string xpath, XmlNamespaceManager nsmgr)
 Selects a list of nodes matching the XPath expression. Any prefixes found in the XPath expression are resolved using the supplied T:System.Xml.XmlNamespaceManager. More...
 
virtual XmlNode InsertBefore (XmlNode newChild, XmlNode refChild)
 Inserts the specified node immediately before the specified reference node. More...
 
virtual XmlNode InsertAfter (XmlNode newChild, XmlNode refChild)
 Inserts the specified node immediately after the specified reference node. More...
 
virtual XmlNode ReplaceChild (XmlNode newChild, XmlNode oldChild)
 Replaces the child node oldChild with newChild node. More...
 
virtual XmlNode RemoveChild (XmlNode oldChild)
 Removes specified child node. More...
 
virtual XmlNode PrependChild (XmlNode newChild)
 Adds the specified node to the beginning of the list of child nodes for this node. More...
 
virtual XmlNode AppendChild (XmlNode newChild)
 Adds the specified node to the end of the list of child nodes, of this node. More...
 
virtual void Normalize ()
 Puts all XmlText nodes in the full depth of the sub-tree underneath this XmlNode into a "normal" form where only markup (that is, tags, comments, processing instructions, CDATA sections, and entity references) separates XmlText nodes, that is, there are no adjacent XmlText nodes. More...
 
virtual bool Supports (string feature, string version)
 Tests if the DOM implementation implements a specific feature. More...
 
virtual XmlNode Clone ()
 Creates a duplicate of this node. More...
 
IEnumerator GetEnumerator ()
 Get an enumerator that iterates through the child nodes in the current node. More...
 
virtual void RemoveAll ()
 Removes all the child nodes and/or attributes of the current node. More...
 
virtual string GetNamespaceOfPrefix (string prefix)
 Looks up the closest xmlns declaration for the given prefix that is in scope for the current node and returns the namespace URI in the declaration. More...
 
virtual string GetPrefixOfNamespace (string namespaceURI)
 Looks up the closest xmlns declaration for the given namespace URI that is in scope for the current node and returns the prefix defined in that declaration. More...
 

Public Attributes

override string Name => OwnerDocument.strCommentName
 Gets the qualified name of the node. More...
 
override string LocalName => OwnerDocument.strCommentName
 Gets the local name of the node. More...
 
override XmlNodeType NodeType => XmlNodeType.Comment
 Gets the type of the current node. More...
 
- Public Attributes inherited from System.Xml.XmlNode
virtual XmlNodeList ChildNodes => new XmlChildNodes(this)
 Gets all the child nodes of the node. More...
 
virtual XmlNode PreviousSibling => null
 Gets the node immediately preceding this node. More...
 
virtual XmlNode NextSibling => null
 Gets the node immediately following this node. More...
 
virtual XmlAttributeCollection Attributes => null
 Gets an T:System.Xml.XmlAttributeCollection containing the attributes of this node. More...
 
virtual XmlNode FirstChild => LastNode?.next
 Gets the first child of the node. More...
 
virtual XmlNode LastChild => LastNode
 Gets the last child of the node. More...
 
virtual bool HasChildNodes => LastNode != null
 Gets a value indicating whether this node has any child nodes. More...
 
virtual string NamespaceURI => string.Empty
 Gets the namespace URI of this node. More...
 
virtual IXmlSchemaInfo SchemaInfo => XmlDocument.NotKnownSchemaInfo
 Gets the post schema validation infoset that has been assigned to this node as a result of schema validation. More...
 
virtual XmlNode PreviousText => null
 Gets the text node that immediately precedes this node. More...
 

Protected Member Functions

internal XmlComment (string comment, XmlDocument doc)
 Initializes a new instance of the T:System.Xml.XmlComment class. More...
 
- Protected Member Functions inherited from System.Xml.XmlCharacterData
internal XmlCharacterData (string data, XmlDocument doc)
 Initializes a new instance of the T:System.Xml.XmlCharacterData class. More...
 

Additional Inherited Members

- Properties inherited from System.Xml.XmlCharacterData
override string Value [get, set]
 Gets or sets the value of the node. More...
 
override string InnerText [get, set]
 Gets or sets the concatenated values of the node and all the children of the node. More...
 
virtual string Data [get, set]
 Contains the data of the node. More...
 
virtual int Length [get]
 Gets the length of the data, in characters. More...
 
- Properties inherited from System.Xml.XmlLinkedNode
override XmlNode PreviousSibling [get]
 Gets the node immediately preceding this node. More...
 
override XmlNode NextSibling [get]
 Gets the node immediately following this node. More...
 
- Properties inherited from System.Xml.XmlNode
abstract string Name [get]
 Gets the qualified name of the node, when overridden in a derived class. More...
 
virtual string Value [get, set]
 Gets or sets the value of the node. More...
 
abstract XmlNodeType NodeType [get]
 Gets the type of the current node, when overridden in a derived class. More...
 
virtual XmlNode ParentNode [get]
 Gets the parent of this node (for nodes that can have parents). More...
 
virtual XmlDocument OwnerDocument [get]
 Gets the T:System.Xml.XmlDocument to which this node belongs. More...
 
virtual string Prefix [get, set]
 Gets or sets the namespace prefix of this node. More...
 
abstract string LocalName [get]
 Gets the local name of the node, when overridden in a derived class. More...
 
virtual bool IsReadOnly [get]
 Gets a value indicating whether the node is read-only. More...
 
virtual string InnerText [get, set]
 Gets or sets the concatenated values of the node and all its child nodes. More...
 
virtual string OuterXml [get]
 Gets the markup containing this node and all its child nodes. More...
 
virtual string InnerXml [get, set]
 Gets or sets the markup representing only the child nodes of this node. More...
 
virtual string BaseURI [get]
 Gets the base URI of the current node. More...
 
virtual XmlElement this[string name] [get]
 Gets the first child element with the specified P:System.Xml.XmlNode.Name. More...
 
virtual XmlElement this[string localname, string ns] [get]
 Gets the first child element with the specified P:System.Xml.XmlNode.LocalName and P:System.Xml.XmlNode.NamespaceURI. More...
 

Detailed Description

Represents the content of an XML comment.

Definition at line 6 of file XmlComment.cs.

Constructor & Destructor Documentation

◆ XmlComment()

internal System.Xml.XmlComment.XmlComment ( string  comment,
XmlDocument  doc 
)
protected

Initializes a new instance of the T:System.Xml.XmlComment class.

Parameters
commentThe content of the comment element.
docThe parent XML document.

Definition at line 25 of file XmlComment.cs.

Member Function Documentation

◆ CloneNode()

override XmlNode System.Xml.XmlComment.CloneNode ( bool  deep)
virtual

Creates a duplicate of this node.

Parameters
deeptrue to recursively clone the subtree under the specified node; false to clone only the node itself. Because comment nodes do not have children, the cloned node always includes the text content, regardless of the parameter setting.
Returns
The cloned node.

Implements System.Xml.XmlNode.

Definition at line 34 of file XmlComment.cs.

◆ WriteContentTo()

override void System.Xml.XmlComment.WriteContentTo ( XmlWriter  w)
virtual

Saves all the children of the node to the specified T:System.Xml.XmlWriter. Because comment nodes do not have children, this method has no effect.

Parameters
wThe XmlWriter to which you want to save.

Implements System.Xml.XmlNode.

Definition at line 48 of file XmlComment.cs.

◆ WriteTo()

override void System.Xml.XmlComment.WriteTo ( XmlWriter  w)
virtual

Saves the node to the specified T:System.Xml.XmlWriter.

Parameters
wThe XmlWriter to which you want to save.

Implements System.Xml.XmlNode.

Definition at line 41 of file XmlComment.cs.

Member Data Documentation

◆ LocalName

override string System.Xml.XmlComment.LocalName => OwnerDocument.strCommentName

Gets the local name of the node.

Returns
For comment nodes, the value is #comment.

Definition at line 14 of file XmlComment.cs.

◆ Name

override string System.Xml.XmlComment.Name => OwnerDocument.strCommentName

Gets the qualified name of the node.

Returns
For comment nodes, the value is #comment.

Definition at line 10 of file XmlComment.cs.

◆ NodeType

override XmlNodeType System.Xml.XmlComment.NodeType => XmlNodeType.Comment

Gets the type of the current node.

Returns
For comment nodes, the value is XmlNodeType.Comment.

Definition at line 18 of file XmlComment.cs.


The documentation for this class was generated from the following file: