C# Class System.Globalization.Localization

Holds all the information necessary to Localize the site into a single language.

Show file Open project: adaptabi/i18N-Complete Class Usage Examples

Public Methods

Method	Description
GetMessage ( string msgID ) : string	Given a msgID, returns the associated msgStr. If msgID doesn't exist in this collection, returns msgID. If the associated msgStr is empty, returns msgID.
GetMessageObject ( string msgID ) : Message	Given a msgID, returns the associated msgStr. If msgID doesn't exist in this collection, returns msgID. If the associated msgStr is empty, returns msgID.
LoadFromFile ( string filepath ) : void	Add Localization messages from a .po file. Doesn't initialize the collection, so it can be called from a loop if needed.
LoadFromReader ( TextReader reader ) : void	Add Localization messages from the specified TextReader (which hopefully points at a .po file) Doesn't initialize the collection, so it can be called from a loop if needed.
Localization ( ) : System	Creates a new, empty, Localization
Localization ( string filePath ) : System	Creates a new Localization, populated from a .po file at the supplied filePath
Localization ( string filePath, bool loadComments ) : System	Creates a new Localization, populated from a .po file at the supplied filePath. If requested, will also load comments from that file.
ToFile ( string filepath ) : void	Writes the contents of this Localization to the specified .po file.

Protected Methods

Method	Description
Unescape ( string text ) : string

Private Methods

Method	Description
GetNodeType ( string line ) : NodeType

Method Details

GetMessage() public method

Given a msgID, returns the associated msgStr. If msgID doesn't exist in this collection, returns msgID. If the associated msgStr is empty, returns msgID.

public GetMessage ( string msgID ) : string
msgID	string
return	string

GetMessageObject() public method

Given a msgID, returns the associated msgStr. If msgID doesn't exist in this collection, returns msgID. If the associated msgStr is empty, returns msgID.

public GetMessageObject ( string msgID ) : Message
msgID	string
return	Message

LoadFromFile() public method

Add Localization messages from a .po file. Doesn't initialize the collection, so it can be called from a loop if needed.

public LoadFromFile ( string filepath ) : void
filepath	string
return	void

LoadFromReader() public method

Add Localization messages from the specified TextReader (which hopefully points at a .po file) Doesn't initialize the collection, so it can be called from a loop if needed.

public LoadFromReader ( TextReader reader ) : void
reader	TextReader
return	void

Localization() public method

Creates a new, empty, Localization

public Localization ( ) : System
return	System

Localization() public method

Creates a new Localization, populated from a .po file at the supplied filePath

public Localization ( string filePath ) : System
filePath	string
return	System

Localization() public method

Creates a new Localization, populated from a .po file at the supplied filePath. If requested, will also load comments from that file.

public Localization ( string filePath, bool loadComments ) : System
filePath	string
loadComments	bool	If true, will populate comments so that this .po file can be saved again exactly as it was loaded.
return	System

ToFile() public method

Writes the contents of this Localization to the specified .po file.

public ToFile ( string filepath ) : void
filepath	string
return	void

Unescape() protected method

protected Unescape ( string text ) : string
text	string
return	string