ResXResourceReader Класс

Определение

Перечисляет файлы (.resx) и потоки XML-ресурсов, считывая последовательно пары "имя — значение" для ресурсов.Enumerates XML resource (.resx) files and streams, and reads the sequential resource name and value pairs.

public ref class ResXResourceReader : System::Resources::IResourceReader
public ref class ResXResourceReader : IDisposable, System::Collections::IEnumerable, System::Resources::IResourceReader
public class ResXResourceReader : System.Resources.IResourceReader
public class ResXResourceReader : IDisposable, System.Collections.IEnumerable, System.Resources.IResourceReader
type ResXResourceReader = class
    interface IResourceReader
    interface IEnumerable
    interface IDisposable
Public Class ResXResourceReader
Implements IResourceReader
Public Class ResXResourceReader
Implements IDisposable, IEnumerable, IResourceReader
Наследование
ResXResourceReader
Реализации

Примеры

В следующем примере показано, как использовать ResXResourceReader для итерации ресурсов в RESX-файле.The following example demonstrates how to use a ResXResourceReader to iterate through the resources in a .resx file. Во-первых, ResXResourceReader rsxr для файла создается items.resx .First, the ResXResourceReaderrsxr is created for the file items.resx. Затем GetEnumerator метод используется для создания объекта IDictionaryEnumerator для прохода по ресурсам и вывода содержимого на консоль.Next, the GetEnumerator method is used to create an IDictionaryEnumerator to iterate through the resources and display the contents to the console.

#using <system.windows.forms.dll>
#using <System.dll>

using namespace System;
using namespace System::Resources;
using namespace System::Collections;
void main()
{

   // Create a ResXResourceReader for the file items.resx.
   ResXResourceReader^ rsxr = gcnew ResXResourceReader( "items.resx" );


   // Iterate through the resources and display the contents to the console.
   IEnumerator^ myEnum = rsxr->GetEnumerator();
   while ( myEnum->MoveNext() )
   {
      DictionaryEntry^ d = safe_cast<DictionaryEntry^>(myEnum->Current);
      Console::WriteLine( "{0}:\t {1}", d->Key, d->Value );
   }


   //Close the reader.
   rsxr->Close();
}

using System;
using System.Resources;
using System.Collections;

class ReadResXResources
{
   public static void Main()
   {

      // Create a ResXResourceReader for the file items.resx.
      ResXResourceReader rsxr = new ResXResourceReader("items.resx");

      // Iterate through the resources and display the contents to the console.
      foreach (DictionaryEntry d in rsxr)
      {
    Console.WriteLine(d.Key.ToString() + ":\t" + d.Value.ToString());
      }

     //Close the reader.
     rsxr.Close();
   }
}
Imports System.Resources
Imports System.Collections

Class ReadResXResources
   
   Public Shared Sub Main()
      
      ' Create a ResXResourceReader for the file items.resx.
      Dim rsxr As ResXResourceReader
      rsxr = New ResXResourceReader("items.resx")

      ' Iterate through the resources and display the contents to the console.
      Dim d As DictionaryEntry
      For Each d In  rsxr
         Console.WriteLine(d.Key.ToString() + ":" + ControlChars.Tab + d.Value.ToString())
      Next d
      
      'Close the reader.
      rsxr.Close()

   End Sub

End Class

Комментарии

ResXResourceReaderКласс предоставляет реализацию интерфейса по умолчанию IResourceReader , считывающую сведения о ресурсах в формате XML.The ResXResourceReader class provides a default implementation of the IResourceReader interface that reads resource information in an XML format. Чтобы считать сведения о ресурсах из двоичного формата ресурсов, используйте ResourceReader класс.To read resource information from a binary resource format, use the ResourceReader class.

ResXResourceReaderКласс используется для перечисления ресурсов в RESX-файлах путем обхода перечислителя словаря ( IDictionaryEnumerator ), возвращаемого GetEnumerator методом.You use the ResXResourceReader class to enumerate resources in .resx files by traversing the dictionary enumerator (IDictionaryEnumerator) that is returned by the GetEnumerator method. Методы, предоставляемые, вызываются IDictionaryEnumerator для перехода к следующему ресурсу и для считывания имени и значения каждого ресурса в файле. resx.You call the methods provided by IDictionaryEnumerator to advance to the next resource and to read the name and value of each resource in the .resx file.

Примечание

ResXResourceReaderКласс предоставляет два перечислителей.The ResXResourceReader class provides two enumerators. ResXResourceReader.GetEnumeratorМетод возвращает IDictionaryEnumerator объект; для перечисления ресурсов рекомендуется использовать этот метод.The ResXResourceReader.GetEnumerator method returns an IDictionaryEnumerator object; we recommend that you use this method to enumerate resources. ResXResourceReader.IEnumerable.GetEnumeratorМетод является явной реализацией интерфейса, возвращающей IEnumerator объект; мы не рекомендуем его использовать.The ResXResourceReader.IEnumerable.GetEnumerator method is an explicit interface implementation that returns an IEnumerator object; we do not recommend its use.

В следующем примере метод используется GetEnumerator для получения IDictionaryEnumerator объекта, который используется для перечисления ресурсов в RESX-файле.The following example uses the GetEnumerator method to obtain an IDictionaryEnumerator object that is used to enumerate the resources in a .resx file. Пример включает CreateResourceFile подпрограммы, создающие необходимый файл ресурсов.The example includes a CreateResourceFile routine that creates the necessary resource file.

using System;
using System.Collections;
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);
      IDictionaryEnumerator dict = rr.GetEnumerator();
      while (dict.MoveNext())
         Console.WriteLine("{0}: {1}", dict.Key, dict.Value);   
   }

   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", "", 
                            "The area in square miles", "", 
                            "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
//       Population: Population (2010}
//       Area: Area
//       Capital: Capital
//       LCity: Largest City
Imports System.Collections
Imports System.Resources

Module Example
   Private Const resxFilename As String = ".\CountryHeaders.resx"
     
   Public Sub Main()
      ' Create a resource file to read.
      CreateResourceFile()
      
      ' Enumerate the resources in the file.
      Dim rr As New ResXResourceReader(resxFilename)
      Dim dict As IDictionaryEnumerator = rr.GetEnumerator()
      Do While dict.MoveNext()
         Console.WriteLine("{0}: {1}", dict.Key, dict.Value)   
      Loop
   End Sub
   
   Private Sub CreateResourceFile()
      Dim rw As New ResxResourceWriter(resxFilename)
      Dim resNames() As String = {"Country", "Population", "Area", 
                                  "Capital", "LCity" }
      Dim columnHeaders() As String = { "Country Name", "Population (2010}", 
                                        "Area", "Capital", "Largest City" }
      Dim comments() As String = { "The localized country name", "", 
                                   "The area in square miles", "", 
                                   "The largest city based on 2010 data" }
      rw.AddResource("Title", "Country Information")
      rw.AddResource("nColumns", resNames.Length)
      For ctr As Integer = 0 To resNames.Length - 1
         Dim node As New ResXDataNode(resNames(ctr), columnHeaders(ctr))
         node.Comment = comments(ctr)
         rw.AddResource(node)
      Next
      rw.Generate()
      rw.Close()
   End Sub
End Module
' The example displays the following output:
'       Title: Country Information
'       nColumns: 5
'       Country: Country Name
'       Population: Population (2010}
'       Area: Area
'       Capital: Capital
'       LCity: Largest City

Если UseResXDataNodes свойство имеет true значение, значением IDictionaryEnumerator.Value свойства является объект, а не ResXDataNode значение ресурса.If the UseResXDataNodes property is true, the value of the IDictionaryEnumerator.Value property is a ResXDataNode object rather than the resource value. Это делает комментарий к элементу ресурса доступным из ResXDataNode.Comment Свойства.This makes a resource item's comment available from the ResXDataNode.Comment property. В следующем примере свойству присваивается значение UseResXDataNodes true и перечисляются ресурсы в RESX-файле.The following example sets the UseResXDataNodes property to true and enumerates the resources in a .resx 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", "", 
                            "The area in square miles", "", 
                            "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}
//    Area:                Area                 // The area in square miles
//    Capital:             Capital
//    LCity:               Largest City         // The largest city based on 2010 data
Imports System.Collections
Imports System.ComponentModel.Design
Imports System.Resources

Module Example
   Private Const resxFilename As String = ".\CountryHeaders.resx"
     
   Public Sub Main()
      ' Create a resource file to read.
      CreateResourceFile()
      
      ' Enumerate the resources in the file.
      Dim rr As New ResXResourceReader(resxFilename)
      rr.UseResXDataNodes = True
      Dim dict As IDictionaryEnumerator = rr.GetEnumerator()
      Do While dict.MoveNext()
         Dim node As ResXDataNode = DirectCast(dict.Value, ResXDataNode)
         Console.WriteLine("{0,-20} {1,-20} {2}", 
                           node.Name + ":", 
                           node.GetValue(CType(Nothing, ITypeResolutionService)), 
                           If(Not String.IsNullOrEmpty(node.Comment), "// " + node.Comment, ""))
      Loop
   End Sub
   
   Private Sub CreateResourceFile()
      Dim rw As New ResxResourceWriter(resxFilename)
      Dim resNames() As String = {"Country", "Population", "Area", 
                                  "Capital", "LCity" }
      Dim columnHeaders() As String = { "Country Name", "Population (2010}", 
                                        "Area", "Capital", "Largest City" }
      Dim comments() As String = { "The localized country name", "", 
                                   "The area in square miles", "", 
                                   "The largest city based on 2010 data" }
      rw.AddResource("Title", "Country Information")
      rw.AddResource("nColumns", resNames.Length)
      For ctr As Integer = 0 To resNames.Length - 1
         Dim node As New ResXDataNode(resNames(ctr), columnHeaders(ctr))
         node.Comment = comments(ctr)
         rw.AddResource(node)
      Next
      rw.Generate()
      rw.Close()
   End Sub
End Module
' The example displays the following output:
'    Title:               Country Information
'    nColumns:            5
'    Country:             Country Name         // The localized country name
'    Population:          Population (2010}
'    Area:                Area                 // The area in square miles
'    Capital:             Capital
'    LCity:               Largest City         // The largest city based on 2010 data

Если UseResXDataNodes параметр имеет значение true , то ResXDataNode элементы перечисления могут иметь одно из следующих значений:If UseResXDataNodes is true, the ResXDataNode items in the enumeration can be either:

  • Именованные ресурсы вместе с их данными.Named resources along with their data. В этом случае ResXDataNode.FileRef свойство имеет значение null .In this case, the ResXDataNode.FileRef property is null.

  • Именованные ресурсы вместе с именем файла, который содержит данные ресурса.Named resources along with the name of the file that contains the resource data. В этом случае ResXDataNode.FileRef свойство возвращает ResXFileRef объект, предоставляющий сведения о ресурсе, включая его имя файла.In this case, the ResXDataNode.FileRef property returns a ResXFileRef object that provides information about the resource, including its filename. Если используются относительные имена файлов, следует всегда задавать BasePath для свойства значение, чтобы предоставить точку ссылки относительного пути к файлу.If relative file names are used, you should always set the BasePath property to provide a reference point for the relative file path.

Если требуется извлечь именованные ресурсы из RESX-файла, а не перечислять его ресурсы, можно создать экземпляр ResXResourceSet объекта и вызвать его GetString GetObject методы и.If you want to retrieve named resources from a .resx file rather than enumerating its resources, you can instantiate a ResXResourceSet object and call its GetString and GetObject methods.

Примечание

ResXResourceReaderКласс содержит требование компоновки и требование наследования на уровне класса, которое применяется ко всем элементам.The ResXResourceReader class contains a link demand and an inheritance demand at the class level that applies to all members. SecurityExceptionИсключение возникает, когда либо непосредственный вызывающий объект, либо производный класс не имеет разрешения полного доверия.A SecurityException exception is thrown when either the immediate caller or the derived class does not have full-trust permission.

Конструкторы

ResXResourceReader(Stream)

Инициализирует новый экземпляр класса ResXResourceReader для заданного потока.Initializes a new instance of the ResXResourceReader class for the specified stream.

ResXResourceReader(Stream, AssemblyName[])

Инициализирует новый экземпляр класса ResXResourceReader, используя поток и массив имен сборок.Initializes a new instance of the ResXResourceReader class using a stream and an array of assembly names.

ResXResourceReader(Stream, ITypeResolutionService)

Инициализирует новый экземпляр класса ResXResourceReader, используя входной поток и службу разрешения типов.Initializes a new instance of the ResXResourceReader class using an input stream and a type resolution service.

ResXResourceReader(String)

Инициализирует новый экземпляр класса ResXResourceReader для указанного имени файла ресурсов.Initializes a new instance of the ResXResourceReader class for the specified resource file.

ResXResourceReader(String, AssemblyName[])

Инициализирует новый экземпляр класса ResXResourceReader, используя имя файла ресурсов XML и массив имен сборок.Initializes a new instance of the ResXResourceReader class using an XML resource file name and an array of assembly names.

ResXResourceReader(String, ITypeResolutionService)

Инициализирует новый экземпляр класса ResXResourceReader, используя имя файла и службу разрешения типов.Initializes a new instance of the ResXResourceReader class using a file name and a type resolution service.

ResXResourceReader(TextReader)

Инициализирует новый экземпляр класса ResXResourceReader для указанного объекта TextReader.Initializes a new instance of the ResXResourceReader class for the specified TextReader.

ResXResourceReader(TextReader, AssemblyName[])

Инициализирует новый экземпляр класса ResXResourceReader, используя объект TextReader и массив имен сборок.Initializes a new instance of the ResXResourceReader class using a TextReader object and an array of assembly names.

ResXResourceReader(TextReader, ITypeResolutionService)

Инициализирует новый экземпляр класса ResXResourceReader, используя средство чтения текстового потока и службу разрешения типов.Initializes a new instance of the ResXResourceReader class using a text stream reader and a type resolution service.

Свойства

BasePath

Возвращает или задает базовый путь для относительного пути к файлу, заданному в объекте ResXFileRef.Gets or sets the base path for the relative file path specified in a ResXFileRef object.

UseResXDataNodes

Получает или задает значение, указывающее, производится ли возвращение объектов ResXDataNode при чтении текущего файла XML-ресурсов или потока.Gets or sets a value that indicates whether ResXDataNode objects are returned when reading the current XML resource file or stream.

Методы

Close()

Освобождает все ресурсы, занятые модулем ResXResourceReader.Releases all resources used by the ResXResourceReader.

Dispose(Boolean)

Освобождает неуправляемые ресурсы, используемые объектом ResXResourceReader, а при необходимости освобождает также управляемые ресурсы.Releases the unmanaged resources used by the ResXResourceReader and optionally releases the managed resources.

Equals(Object)

Определяет, равен ли указанный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Унаследовано от Object)
Finalize()

Этот член переопределяет метод Finalize().This member overrides the Finalize() method.

FromFileContents(String)

Создает новый объект ResXResourceReader и инициализирует его, чтобы выполнить чтение строки, содержимое которой представлено в виде файла ресурсов XML.Creates a new ResXResourceReader object and initializes it to read a string whose contents are in the form of an XML resource file.

FromFileContents(String, AssemblyName[])

Создает новый объект ResXResourceReader и инициализирует его, чтобы выполнить чтение строки, содержимое которой представлено в виде файла XML-ресурсов, и использовать массив объектов AssemblyName для разрешения имен типов, заданных в ресурсе.Creates a new ResXResourceReader object and initializes it to read a string whose contents are in the form of an XML resource file, and to use an array of AssemblyName objects to resolve type names specified in a resource.

FromFileContents(String, ITypeResolutionService)

Создает новый объект ResXResourceReader и инициализирует его, чтобы выполнить чтение строки, содержимое которой представлено в виде файла XML-ресурсов, и использовать объект ITypeResolutionService для разрешения имен типов, заданных в ресурсе.Creates a new ResXResourceReader object and initializes it to read a string whose contents are in the form of an XML resource file, and to use an ITypeResolutionService object to resolve type names specified in a resource.

GetEnumerator()

Возвращает перечислитель для текущего объекта ResXResourceReader.Returns an enumerator for the current ResXResourceReader object.

GetHashCode()

Служит хэш-функцией по умолчанию.Serves as the default hash function.

(Унаследовано от Object)
GetMetadataEnumerator()

Обеспечивает словарный перечислитель, который может извлекать свойства времени разработки из текущего файла ресурсов XML или из потока.Provides a dictionary enumerator that can retrieve the design-time properties from the current XML resource file or stream.

GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Унаследовано от Object)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Унаследовано от Object)

Явные реализации интерфейса

IDisposable.Dispose()

Освобождает неуправляемые ресурсы, используемые объектом ResXResourceReader, а при необходимости освобождает также управляемые ресурсы.Releases the unmanaged resources used by the ResXResourceReader and optionally releases the managed resources. Описание этого элемента содержится в методе Dispose().For a description of this member, see the Dispose() method.

IEnumerable.GetEnumerator()

Возвращает перечислитель для текущего объекта ResXResourceReader.Returns an enumerator for the current ResXResourceReader object. Описание этого элемента содержится в методе GetEnumerator().For a description of this member, see the GetEnumerator() method.

Методы расширения

Cast<TResult>(IEnumerable)

Приводит элементы объекта IEnumerable к заданному типу.Casts the elements of an IEnumerable to the specified type.

OfType<TResult>(IEnumerable)

Выполняет фильтрацию элементов объекта IEnumerable по заданному типу.Filters the elements of an IEnumerable based on a specified type.

AsParallel(IEnumerable)

Позволяет осуществлять параллельный запрос.Enables parallelization of a query.

AsQueryable(IEnumerable)

Преобразовывает коллекцию IEnumerable в объект IQueryable.Converts an IEnumerable to an IQueryable.

Применяется к

См. также раздел