ResXDataNode Class

ResXDataNode Class

 

Represents an element in an XML resource (.resx) file.

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

System.Object
  System.Resources.ResXDataNode

[SerializableAttribute]
[PermissionSetAttribute(SecurityAction.LinkDemand, Name = "FullTrust")]
public sealed class ResXDataNode : ISerializable

NameDescription
System_CAPS_pubmethodResXDataNode(String, Object)

Initializes a new instance of the ResXDataNode class.

System_CAPS_pubmethodResXDataNode(String, Object, Func<Type, String>)

Initializes a new instance of the ResXDataNode class.

System_CAPS_pubmethodResXDataNode(String, ResXFileRef)

Initializes a new instance of the ResXDataNode class with a reference to a resource file.

System_CAPS_pubmethodResXDataNode(String, ResXFileRef, Func<Type, String>)

Initializes a new instance of the ResXDataNode class with a reference to a resource file.

NameDescription
System_CAPS_pubpropertyComment

Gets or sets an arbitrary comment regarding this resource.

System_CAPS_pubpropertyFileRef

Gets the file reference for this resource.

System_CAPS_pubpropertyName

Gets or sets the name of this resource.

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetNodePosition()

Retrieves the position of the resource in the resource file.

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodGetValue(AssemblyName[])

Retrieves the object that is stored by this node by searching the specified assemblies.

System_CAPS_pubmethodGetValue(ITypeResolutionService)

Retrieves the object that is stored by this node by using the specified type resolution service.

System_CAPS_pubmethodGetValueTypeName(AssemblyName[])

Retrieves the type name for the value by examining the specified assemblies.

System_CAPS_pubmethodGetValueTypeName(ITypeResolutionService)

Retrieves the type name for the value by using the specified type resolution service.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodISerializable.GetObjectData(SerializationInfo, StreamingContext)

This API supports the product infrastructure and is not intended to be used directly from your code. Populates a SerializationInfo object with the data needed to serialize the target object.

The ResXDataNode class supports the representation of rich data types within a resource file. It can support the storage of any object in a resource file, so long as the object supports serialization and type editors.

You can create a ResXDataNode object by calling one of its overloaded class constructors. You can then add the resource item or element to a resource file by calling the ResXResourceWriter.AddResource method.

To retrieve an existing ResXDataNode object, you must enumerate the ResXDataNode objects in an XML resource file by instantiating a ResXResourceReader object, setting the ResXResourceReader.UseResXDataNodes property to true, and calling the ResXResourceReader.GetEnumerator method to get an enumerator. The example provides an illustration.

The following example uses the ResXResourceReader.GetEnumerator method to obtain an IDictionaryEnumerator object that is used to enumerate the ResXDataNode objects in a .resx file. The example includes a CreateResourceFile routine that creates the necessary XML resource file.

using System;
using System.Collections;
using System.ComponentModel.Design;
using System.Resources;

public class Example
{
   private const string resxFilename = @".\CountryHeaders.resx";

   public static void Main()
   {
      // Create a resource file to read.
      CreateResourceFile();

      // Enumerate the resources in the file.
      ResXResourceReader rr = new ResXResourceReader(resxFilename);
      rr.UseResXDataNodes = true;
      IDictionaryEnumerator dict = rr.GetEnumerator();
      while (dict.MoveNext()) {
         ResXDataNode node = (ResXDataNode) dict.Value;
         Console.WriteLine("{0,-20} {1,-20} {2}", 
                           node.Name + ":", 
                           node.GetValue((ITypeResolutionService) null), 
                           ! String.IsNullOrEmpty(node.Comment) ? "// " + node.Comment : "");
      }
   }

   private static void CreateResourceFile()
   {
      ResXResourceWriter rw = new ResXResourceWriter(resxFilename);
      string[] resNames = {"Country", "Population", "Area", 
                           "Capital", "LCity" };
      string[] columnHeaders = { "Country Name", "Population (2010}", 
                                 "Area", "Capital", "Largest City" };
      string[] comments = { "The localized country name", "Estimated population, 2010", 
                            "The area in square miles", "Capital city or chief administrative center", 
                            "The largest city based on 2010 data" };
      rw.AddResource("Title", "Country Information");
      rw.AddResource("nColumns", resNames.Length);
      for (int ctr = 0; ctr < resNames.Length; ctr++) {
         ResXDataNode node = new ResXDataNode(resNames[ctr], columnHeaders[ctr]);
         node.Comment = comments[ctr];
         rw.AddResource(node);
      }
      rw.Generate();
      rw.Close();
   }
}
// The example displays the following output:
//    Title:               Country Information
//    nColumns:            5
//    Country:             Country Name         // The localized country name
//    Population:          Population (2010}    // Estimated population, 2010
//    Area:                Area                 // The area in square miles
//    Capital:             Capital              // Capital city or chief administrative center
//    LCity:               Largest City         // The largest city based on 2010 data

Because the UseResXDataNodes property is true, the value of the IDictionaryEnumerator.Value property is a ResXDataNode object rather than the resource value. This makes a resource item's comment available from the ResXDataNode.Comment property.

SecurityAction.LinkDemand

for full trust for the immediate caller. This type cannot be used by partially trusted code.

.NET Framework
Available since 2.0

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

Return to top
Show:
© 2016 Microsoft