ResXDataNode.Comment Property


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

Gets or sets an arbitrary comment regarding this resource.

Namespace:   System.Resources
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public string Comment { get; set; }

Property Value

Type: System.String

A string that represents the comment.

If a comment has not been assigned to the resource item, the value of the Comment property is String.Empty.

You access the Comment property of an data node in an existing XML resource file by instantiating a ResXResourceReader object, setting the ResXResourceReader.UseResXDataNodes property to true, and calling the ResXResourceReader.GetEnumerator method to retrieve an IDictionaryEnumerator object that you use to enumerate the items in the XML resource file. The IDictionaryEnumerator.Value property returns the ResXDataNode object.

See the example for the ResXDataNode class.

.NET Framework
Available since 2.0
Return to top