• Article

XComment.Value Property

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Gets or sets the string value of this comment.

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

Syntax

'Declaration
Public Property Value As String

public string Value { get; set; }

Property Value

Type: System.String
A String that contains the string value of this comment.

Exceptions

Exception Condition
ArgumentNullException

The value is nulla null reference (Nothing in Visual Basic).

Remarks

Unlike XElement and XAttribute, you cannot retrieve the contents of a comment by casting it to a string. Instead, you must use this property to retrieve the contents.

Setting this property will raise the Changed and the Changing events.

Examples

The following example creates a comment node. It then retrieves the contents of the comment node.

Dim output As New StringBuilder
Dim com As XComment = New XComment("This is a comment")
output.Append(com.Value)
output.Append(Environment.NewLine)

OutputTextBlock.Text = output.ToString()

StringBuilder output = new StringBuilder();
XComment com = new XComment("This is a comment");
output.Append(com.Value);
output.Append(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.