CSharp_ClassLib.Classes.LanguageFile Class Reference

Language file class. More...

List of all members.

Public Member Functions

 LanguageFile ()
 Class constructor that inits all nesessary stuff.
 LanguageFile (string Language_File)
 Class constructor that inits all nesessary stuff and opens a language file.
void LoadFromFile (string Language_File)
 Loads a language file.
string GetValue (string ID, string Category, string Default)
 Returns an value of a language entry.
string GetValue (string ID, string Category)
 Returns an value of a language entry.
string GetValue (string ID)
 Returns an value of a language entry that has no category.

Properties

string Author
 Returns the name of the author.
string Email
 Returns the author's email.
string Homepage
 Returns the author's homepage url.
string OriginalCaption
 Returns the original caption of this language.
string EnglishCaption
 Returns the english caption of this language.


Detailed Description

Language file class.

Class that contains routines to handle language files in XML format

Author:
generalpd
Version:
Revision
1.1
Date:
2005-04-18

Bug:
none

Todo:
none
Remarks:
Last changed by:
Author
generalpd
in revision
Revision
1.1
on
Date
2005/05/03 12:59:55
Note:
Log
clsLanguageFile.cs,v
Revision 1.1 2005/05/03 12:59:55 generalpd first import

Definition at line 51 of file clsLanguageFile.cs.


Constructor & Destructor Documentation

CSharp_ClassLib::Classes.LanguageFile::LanguageFile  ) 
 

Class constructor that inits all nesessary stuff.

  // Code example
 
  CSharp_ClassLib.Classes.LanguageFile m_oLanguageFile = new CSharp_ClassLib.Classes.LanguageFile();

Definition at line 110 of file clsLanguageFile.cs.

CSharp_ClassLib::Classes.LanguageFile::LanguageFile string  Language_File  ) 
 

Class constructor that inits all nesessary stuff and opens a language file.

Parameters:
Language_File The full path of the language file
  // Code example
 
  CSharp_ClassLib.Classes.LanguageFile m_oLanguageFile = new CSharp_ClassLib.Classes.LanguageFile("C:\\german.lang.xml");

Exceptions:
System.IO.FileNotFoundException The language file was not found!

Definition at line 132 of file clsLanguageFile.cs.


Member Function Documentation

string CSharp_ClassLib::Classes.LanguageFile::GetValue string  ID  ) 
 

Returns an value of a language entry that has no category.

Parameters:
ID The ID of the entry
Returns:
The value (empty string if the entry was not found)

Definition at line 513 of file clsLanguageFile.cs.

string CSharp_ClassLib::Classes.LanguageFile::GetValue string  ID,
string  Category
 

Returns an value of a language entry.

Parameters:
ID The ID of the entry
Category The category of the entry
Default Value that is return if the entry was not found
Returns:
The value (empty string if the entry was not found)

Definition at line 500 of file clsLanguageFile.cs.

string CSharp_ClassLib::Classes.LanguageFile::GetValue string  ID,
string  Category,
string  Default
 

Returns an value of a language entry.

Parameters:
ID The ID of the entry
Category The category of the entry
ThrowException Throw an exception if the entry was not found (true) or not and return an empty string (false)
Exceptions:
System.ArgumentOutOfRangeException Entry was not found!
Returns:
The value

Definition at line 475 of file clsLanguageFile.cs.

string CSharp_ClassLib::Classes.LanguageFile::LoadFromFile string  Language_File  ) 
 

Loads a language file.

Parameters:
Language_File The full path of the language file
  // Code example
 
  m_oLanguageFile.LoadFromFile("C:\\english.lang.xml");

Exceptions:
System.IO.FileNotFoundException The language file was not found!

Definition at line 285 of file clsLanguageFile.cs.


Property Documentation

string CSharp_ClassLib::Classes.LanguageFile::Author [get]
 

Returns the name of the author.

Returns:
The name of the author
  // Code example
 
  Console.WriteLine("This language file was created by: " + m_oLanguageFile.Author);

Definition at line 155 of file clsLanguageFile.cs.

string CSharp_ClassLib::Classes.LanguageFile::Email [get]
 

Returns the author's email.

Returns:
The email of the author
  // Code example
 
  Console.WriteLine("The author of this language file has the following email: " + m_oLanguageFile.Email);

Definition at line 171 of file clsLanguageFile.cs.

string CSharp_ClassLib::Classes.LanguageFile::EnglishCaption [get]
 

Returns the english caption of this language.

Returns:
The english caption of this language
  // Code example
 
  Console.WriteLine("This language is originally called " + m_oLanguageFile.OriginalCaption + " in English.");

Definition at line 219 of file clsLanguageFile.cs.

string CSharp_ClassLib::Classes.LanguageFile::Homepage [get]
 

Returns the author's homepage url.

Returns:
The homepage url of the author
  // Code example
 
  Console.WriteLine("You can visit the author of this language file at: " + m_oLanguageFile.Homepage);

Definition at line 187 of file clsLanguageFile.cs.

string CSharp_ClassLib::Classes.LanguageFile::OriginalCaption [get]
 

Returns the original caption of this language.

Returns:
The caption that is used in this language (e.g. "Deutsch" for "german")
  // Code example
 
  Console.WriteLine("This language is originally called: " + m_oLanguageFile.OriginalCaption);

Definition at line 203 of file clsLanguageFile.cs.


The documentation for this class was generated from the following file:
Generated on Thu Jun 2 08:41:50 2005 for C# ClassLib by  doxygen 1.4.1