クラス Siki.Configure.GlobalConfigure

アプリケーションの設定を管理するクラス. [詳細]

Siki.Configure.GlobalConfigureに対する継承グラフ
Inheritance graph
[凡例]

すべてのメンバ一覧

Public メソッド

 GlobalConfigure ()
 デフォルトコンストラクタ. 設定ファイルをデフォルトのパスに指定する.
 GlobalConfigure (string filename)
 コンストラクタ. 設定ファイルをデフォルトのフォルダの filename に指定する.
 GlobalConfigure (string dir, string filename)
 GlobalConfigure (string dir, string filename, string rootname)
 コンストラクタ. 設定ファイルを dir フォルダの filename に指定する.
virtual bool Load ()
 設定ファイルを読み込む. ファイルが存在しない場合は新規に作成する.
virtual void OnInitialized (ConfigureEventArgs e)
 Initializedイベントを発行する.
virtual void OnLoaded (ConfigureEventArgs e)
 Loadedイベントを発行する.
virtual bool Save ()
 現在のDOMの状態を設定ファイルに保存する.
virtual void OnSaved (ConfigureEventArgs e)
 Savedイベントを発行する.

プロパティ

string FullPath [get, set]
 設定ファイルのフルパスを取得する.
XmlDocument Dom [get]
 XmlDocumentを取得する.
ConfigureNode this [string name] [get]
 インデクサ. 指定された名前の子ノードを取得する. 存在しない場合は作成する.

イベント

EventHandler< ConfigureEventArgs > Initialized
 DOMが初期化されたときに発生するイベント.
EventHandler< ConfigureEventArgs > Loaded
 ファイルから読み込まれたときに発生するイベント.
EventHandler< ConfigureEventArgs > Saved
 ファイルに保存されたときに発生するイベント.

説明

アプリケーションの設定を管理するクラス.

GlobalConfigure.cs の 14 行で定義されています。

コンストラクタとデストラクタ

Siki.Configure.GlobalConfigure.GlobalConfigure (  ) 

デフォルトコンストラクタ. 設定ファイルをデフォルトのパスに指定する.

GlobalConfigure.cs の 91 行で定義されています。

00092             : this("conf.xml") {
00093 
00094         }

Siki.Configure.GlobalConfigure.GlobalConfigure ( string  filename  ) 

コンストラクタ. 設定ファイルをデフォルトのフォルダの filename に指定する.

引数:
filename 設定ファイル名

GlobalConfigure.cs の 103 行で定義されています。

00104             : this(Application.UserAppDataPath, filename) {
00105 
00106         }

Siki.Configure.GlobalConfigure.GlobalConfigure ( string  dir,
string  filename 
)

GlobalConfigure.cs の 108 行で定義されています。

00109             : this(dir, filename, ""){
00110 
00111         }

Siki.Configure.GlobalConfigure.GlobalConfigure ( string  dir,
string  filename,
string  rootname 
)

コンストラクタ. 設定ファイルを dir フォルダの filename に指定する.

引数:
dir 設定ファイルのフォルダ
filename 設定ファイル名

GlobalConfigure.cs の 119 行で定義されています。

00119                                                                              {
00120             FullPath = (dir.EndsWith("\\") ? dir : dir + "\\") + filename;
00121             RootName = rootname;
00122             m_dom = new XmlDocument();
00123             Load();
00124         }

メソッド

virtual bool Siki.Configure.GlobalConfigure.Load (  )  [virtual]

設定ファイルを読み込む. ファイルが存在しない場合は新規に作成する.

戻り値:
XMLの読み込みor作成に成功したか.

GlobalConfigure.cs の 131 行で定義されています。

00131                                    {
00132             try {
00133                 if (File.Exists(FullPath)) {
00134                     // 設定ファイルが存在するとき
00135                     // ファイルを読み込む
00136                     Dom.Load(FullPath);
00137                     return true;
00138                 }
00139                 throw new XmlException("ファイルが存在しません。");
00140             } catch (XmlException) {
00141                 // 設定ファイルが存在しない、
00142                 // もしくは読み込みに失敗したとき
00143                 Dom.AppendChild(Dom.CreateXmlDeclaration("1.0", "UTF-8", "yes"));
00144                 Dom.AppendChild(Dom.CreateElement(RootName));
00145                 Save();
00146             } catch (Exception) {
00147                 // その他の例外
00148                 return false;
00149             }
00150             return true;
00151         }

virtual void Siki.Configure.GlobalConfigure.OnInitialized ( ConfigureEventArgs  e  )  [virtual]

Initializedイベントを発行する.

引数:
e イベント引数

GlobalConfigure.cs の 157 行で定義されています。

00157                                                                 {
00158             if (Initialized != null) {
00159                 Initialized(this, e);
00160             }
00161         }

virtual void Siki.Configure.GlobalConfigure.OnLoaded ( ConfigureEventArgs  e  )  [virtual]

Loadedイベントを発行する.

引数:
e イベント引数

GlobalConfigure.cs の 167 行で定義されています。

00167                                                            {
00168             if (Loaded != null) {
00169                 Loaded(this, e);
00170             }
00171         }

virtual void Siki.Configure.GlobalConfigure.OnSaved ( ConfigureEventArgs  e  )  [virtual]

Savedイベントを発行する.

引数:
e イベント引数

GlobalConfigure.cs の 194 行で定義されています。

00194                                                           {
00195             if(Saved != null){
00196                 Saved(this, e);
00197             }
00198         }

virtual bool Siki.Configure.GlobalConfigure.Save (  )  [virtual]

現在のDOMの状態を設定ファイルに保存する.

戻り値:
保存に成功すれば真

GlobalConfigure.cs の 177 行で定義されています。

00177                                    {
00178             try {
00179                 Dom.Save(FullPath);
00180                 OnSaved(new ConfigureEventArgs(FullPath));
00181             } catch (XmlException) {
00182                 // XMLに関する例外
00183             } catch {
00184                 // その他の例外
00185                 return false;
00186             }
00187             return true;
00188         }

プロパティ

XmlDocument Siki.Configure.GlobalConfigure.Dom [get, protected]

XmlDocumentを取得する.

GlobalConfigure.cs の 47 行で定義されています。

string Siki.Configure.GlobalConfigure.FullPath [get, set]

設定ファイルのフルパスを取得する.

GlobalConfigure.cs の 32 行で定義されています。

ConfigureNode Siki.Configure.GlobalConfigure.this[string name] [get]

インデクサ. 指定された名前の子ノードを取得する. 存在しない場合は作成する.

引数:
name ノード名
戻り値:
指定された名前の子ノード

GlobalConfigure.cs の 68 行で定義されています。

イベント

EventHandler<ConfigureEventArgs> Siki.Configure.GlobalConfigure.Initialized

DOMが初期化されたときに発生するイベント.

GlobalConfigure.cs の 17 行で定義されています。

EventHandler<ConfigureEventArgs> Siki.Configure.GlobalConfigure.Loaded

ファイルから読み込まれたときに発生するイベント.

GlobalConfigure.cs の 20 行で定義されています。

EventHandler<ConfigureEventArgs> Siki.Configure.GlobalConfigure.Saved

ファイルに保存されたときに発生するイベント.

GlobalConfigure.cs の 23 行で定義されています。

このクラスの説明は次のファイルから生成されました:
Sikiに対してFri Nov 27 15:07:22 2009に生成されました。  doxygen 1.6.1