OmegaEngine API  1.0.3
Public Member Functions | Static Public Member Functions | Public Attributes | Properties | List of all members
OmegaGUI.Model.LocaleFile Class Reference

A wrapper around an XmlDictionary used to store localized strings. More...

Public Member Functions

 LocaleFile ()
 Base-constructor for XML serialization. Do not call manually! More...
 

Static Public Member Functions

static XmlDictionary FromContent (string id)
 Loads a localization table from an XML file via the ContentManager. More...
 
static XmlDictionary Load (string path)
 Loads a localization table from an XML file. More...
 
static XmlDictionary LoadLang (string language)
 Loads a localization table from an XML file if possible. More...
 
static void Save (string path, XmlDictionary entries)
 Saves a localization table in an XML file. More...
 

Public Attributes

const string FileExt = ".locale"
 The file extensions when this class is stored as a file. More...
 

Properties

XmlDictionary Entries [get]
 The collection of entries to be stored. More...
 

Detailed Description

A wrapper around an XmlDictionary used to store localized strings.

Constructor & Destructor Documentation

◆ LocaleFile()

OmegaGUI.Model.LocaleFile.LocaleFile ( )
inline

Base-constructor for XML serialization. Do not call manually!

Member Function Documentation

◆ FromContent()

static XmlDictionary OmegaGUI.Model.LocaleFile.FromContent ( string  id)
inlinestatic

Loads a localization table from an XML file via the ContentManager.

Parameters
idThe ID of the file to load from.
Returns
>The loaded table.

◆ Load()

static XmlDictionary OmegaGUI.Model.LocaleFile.Load ( string  path)
inlinestatic

Loads a localization table from an XML file.

Parameters
pathThe file to load from.
Returns
The loaded table.

◆ LoadLang()

static XmlDictionary OmegaGUI.Model.LocaleFile.LoadLang ( string  language)
inlinestatic

Loads a localization table from an XML file if possible.

Parameters
languageThe language to load.
Returns
The loaded table or an empty table if not found.

◆ Save()

static void OmegaGUI.Model.LocaleFile.Save ( string  path,
XmlDictionary  entries 
)
inlinestatic

Saves a localization table in an XML file.

Parameters
pathThe file to save in
entriesThe collection of entries to be stored.

Member Data Documentation

◆ FileExt

const string OmegaGUI.Model.LocaleFile.FileExt = ".locale"

The file extensions when this class is stored as a file.

Property Documentation

◆ Entries

XmlDictionary OmegaGUI.Model.LocaleFile.Entries
get

The collection of entries to be stored.


The documentation for this class was generated from the following file: