Class ResourcePackage
Предоставляет методы работы с пакетом ресурсов.
Inheritance
Inherited Members
Namespace: Terrasoft.Common
Assembly: Terrasoft.Common.dll
Syntax
public class ResourcePackage : IXmlSerializable, IMetaDataSerializable
Constructors
ResourcePackage()
Инициализирует новый экземпляр класса ResourcePackage.
Declaration
public ResourcePackage()
ResourcePackage(ICollection<LocalizableValue>, CultureInfo, Boolean)
Инициализирует экземпляр класса ResourcePackage, используя заданные коллекцию локализуемых значений, объект культуры и признак оптимизации коллекции.
Declaration
public ResourcePackage(ICollection<LocalizableValue> localizableValues, CultureInfo culture, bool optimize = false)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.ICollection<LocalizableValue> | localizableValues | Коллекция локализуемых значений. |
System.Globalization.CultureInfo | culture | Культура. |
System.Boolean | optimize | Признак оптимизации коллекции локализуемых значений. |
ResourcePackage(CultureInfo)
Инициализирует экземпляр класса ResourcePackage для заданной культуры.
Declaration
public ResourcePackage(CultureInfo culture)
Parameters
Type | Name | Description |
---|---|---|
System.Globalization.CultureInfo | culture | Культура. |
Exceptions
Type | Condition |
---|---|
ArgumentNullOrEmptyException | При передаче в качестве параметра |
ResourcePackage(String)
Инициализирует экземпляр класса ResourcePackage для культуры с заданным именем.
Declaration
public ResourcePackage(string cultureName)
Parameters
Type | Name | Description |
---|---|---|
System.String | cultureName | Имя культуры. |
Exceptions
Type | Condition |
---|---|
NullOrEmptyException | При передаче в качестве параметра |
Properties
Culture
Культура текущего пакета ресурсов.
Declaration
public CultureInfo Culture { get; set; }
Property Value
Type | Description |
---|---|
System.Globalization.CultureInfo |
RootGroup
Корневая группа ресурсов текущего пакета ресурсов.
Declaration
public ResourceGroup RootGroup { get; set; }
Property Value
Type | Description |
---|---|
ResourceGroup |
Methods
CreateFromFile(String)
Формирует пакет ресурсов из файла, расположенного по заданному пути.
Declaration
public static ResourcePackage CreateFromFile(string filePath)
Parameters
Type | Name | Description |
---|---|---|
System.String | filePath | Путь к файлу. |
Returns
Type | Description |
---|---|
ResourcePackage | Сформированный пакет ресурсов. |
CreateFromStream(Stream)
Creates resource package from stream.
Declaration
public static ResourcePackage CreateFromStream(Stream stream)
Parameters
Type | Name | Description |
---|---|---|
System.IO.Stream | stream | Stream to create resource package from. |
Returns
Type | Description |
---|---|
ResourcePackage | Resource package. |
DeleteResource(String)
Выполняет удаление ресурса с заданным именем из текущего пакета ресурсов.
Declaration
public bool DeleteResource(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Имя удаляемого ресурса. |
Returns
Type | Description |
---|---|
System.Boolean |
|
FindItemByName(String)
Выполняет поиск ресурса с заданным именем в текущем пакете ресурсов.
Declaration
public ResourceItem FindItemByName(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Имя искомого ресурса. |
Returns
Type | Description |
---|---|
ResourceItem | Первый найденный ресурс с именем |
GetItemByName(String)
Возвращает элемент ресурса с заданным именем из текущего пакета ресурсов.
Declaration
public ResourceItem GetItemByName(string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Имя искомого ресурса. |
Returns
Type | Description |
---|---|
ResourceItem | Найденный ресурс с именем |
GetSchema()
Возвращает Xml-схему представления пакета ресурсов.
Declaration
public XmlSchema GetSchema()
Returns
Type | Description |
---|---|
System.Xml.Schema.XmlSchema | Xml-схема представления пакета ресурсов. |
ReadMetaData(DataReader)
Выполняет десериализацию текущего пакета ресурсов с помощью заданного DataReader.
Declaration
public void ReadMetaData(DataReader reader)
Parameters
Type | Name | Description |
---|---|---|
DataReader | reader | Экземпляр DataReader, с помощью которого осуществляется десериализация. |
ReadXml(XmlReader)
Выполняет десериализацию пакета ресурсов с помощью заданного экземпляра System.Xml.XmlReader.
Declaration
public void ReadXml(XmlReader reader)
Parameters
Type | Name | Description |
---|---|---|
System.Xml.XmlReader | reader | Экземпляр System.Xml.XmlReader, с помощью которого осуществляется десериализация. |
RenameResource(String, String)
Переименовывает ресурс с заданным именем в текущем пакете ресурсов.
Declaration
public bool RenameResource(string oldName, string name)
Parameters
Type | Name | Description |
---|---|---|
System.String | oldName | Имя ресурса, который переименовывается. |
System.String | name | Новое имя ресурса с именем |
Returns
Type | Description |
---|---|
System.Boolean |
|
SaveToFile(String)
Выполняет сериализацию текущего пакета ресурсов в файл, расположенный по заданному пути.
Declaration
[Obsolete("7.15.0 | Method is not in use and will be removed in upcoming releases")]
public void SaveToFile(string filePath)
Parameters
Type | Name | Description |
---|---|---|
System.String | filePath | Путь к файлу. |
SaveToStream(XmlResourceWriter)
Выполняет сериализацию текущего пакета ресурсов с помощью заданного XmlResourceWriter.
Declaration
public void SaveToStream(XmlResourceWriter xmlResourceWriter)
Parameters
Type | Name | Description |
---|---|---|
XmlResourceWriter | xmlResourceWriter | Экземпляр XmlResourceWriter, с помощью которого осущеcтвляется запись. |
Exceptions
Type | Condition |
---|---|
InvalidObjectStateException | Если для текущего пакета ресурсов не установлено значение культуры. |
SetResourceValue(String, String)
Устанавливает значение ресурсу с заданным именем в текущем пакете ресурсов.
Declaration
public void SetResourceValue(string name, string value)
Parameters
Type | Name | Description |
---|---|---|
System.String | name | Имя ресурса. |
System.String | value | Устанавливаемое значение ресурса. |
WriteMetaData(DataWriter)
Выполняет сериализацию пакета ресурсов с помощью заданного экземпляра DataWriter.
Declaration
public void WriteMetaData(DataWriter writer)
Parameters
Type | Name | Description |
---|---|---|
DataWriter | writer | Экземпляр DataWriter, с помощью которого осуществляется сериализация. |
WriteXml(XmlWriter)
Выполняет сериализацию пакета ресурсов с помощью заданного экземпляра System.Xml.XmlWriter.
Declaration
public void WriteXml(XmlWriter writer)
Parameters
Type | Name | Description |
---|---|---|
System.Xml.XmlWriter | writer | Экземпляр System.Xml.XmlWriter, с помощью которого осуществляется сериализация. |