共用方式為

管理應用程式設定 (.NET)

  • 發行項

應用程式設定可讓您動態儲存應用程式資訊。 使用應用程式設定時，您可以使用用戶端電腦來儲存不應該包含在執行階段的應用程式程式碼中的資訊。 應用程式設定可以包含連接字串、使用者喜好設定等等。

注意

應用程式設定會取代舊版 Visual Studio 中使用的動態屬性。

每一個應用程式設定都必須具備唯一的名稱。 名稱可以是字母、數字或底線的任何組合。 不過，名稱不能以數字開頭，而且不能有空格。 透過 Name 屬性即可變更名稱。

應用程式設定可以儲存為任何資料類型，只要該類型會序列化為 XML，或是具有可實作 ToString/FromString 的 TypeConverter。 最常見的類型為 String、Integer和 Boolean。 您也可以將值儲存為 Color、 Object，或連接字串。

應用程式設定也有一個值。 該值是透過 Value 屬性來進行設定，而且必須符合設定的資料類型。

此外，應用程式設定也可在設計階段繫結到表單或控制項的屬性。

應用程式設定根據範圍可分成兩種類型：

  • 應用程式範圍的設定 可用於 Web 服務的 URL 或資料庫連接字串等資訊。 這些值與應用程式相關聯。 因此，使用者無法在執行階段進行變更。

  • 使用者範圍的設定 可用於保留表單最後一個位置或字型偏好設定等資訊。 使用者可以在執行階段變更這些值。

您可以使用 [範圍] 屬性變更設定的類型。

專案系統會將應用程式設定儲存在兩個 XML 檔案中：

  • 一個是 app.config 檔案，當您建立第一個應用程式設定時在設計階段建立的

  • 一個是 user.config 檔案，當執行應用程式的使用者變更任何使用者設定的值時，它會在執行階段建立。

請注意，使用者設定中的變更不會寫入磁碟中，除非應用程式明確呼叫方法以執行這個動作。

在設計階段建立應用程式設定

在設計階段，您可以透過兩種方式建立應用程式設定:

  • 使用 [專案設計工具] 的 [設定] 頁面。

  • 使用表單或控制項的 [屬性] 視窗，讓您將設定繫結至屬性。

當您建立應用程式範圍的設定時 (例如資料庫連接字串或伺服器資源參考)，Visual Studio 會使用 <applicationSettings> 標記將它儲存在 app.config 中。 (連接字串儲存在 <connectionStrings> 標記之下)。

當您建立使用者範圍的設定 (例如預設字型、首頁或視窗大小) 時，Visual Studio 會使用 <userSettings> 標記將它儲存在 app.config 中。

重要

當您將連接字串儲存在 app.config 中時，請特別謹慎，以免洩露連接字串中的重要資訊 (例如密碼或伺服器路徑)。

如果您是從外部來源取得連接字串資訊 (例如提供使用者識別碼和密碼的使用者)，請務必確保您用來建構連接字串的值不包含會變更連接行為的其他連接字串參數。

您可以考慮使用 [受保護的組態] 功能，將組態檔中的重要資訊加密。 如需詳細資訊，請參閱保護連線資訊。

注意

由於類別庫的設定檔檔案模式，應用程式設定不適用於類別庫專案。 例外狀況是 Visual Studio Tools for Office 執行階段 DLL 專案，它可以有一個設定檔。

使用自訂的設定檔

您可以在專案中加入自訂設定檔，以便於管理設定群組。 單一檔案中所包含的設定會以單元方式載入和儲存。 將設定儲存在經常使用及不常使用群組的個別檔案中，可以節省載入和儲存設定的時間。

例如，您可以將 SpecialSettings.settings 檔案新增至您的專案中。 雖然 SpecialSettings 類別不會出現在 My 命名空間中，但是 [檢視程式碼] 仍可讀取包含 Partial Class SpecialSettings 的自訂設定檔。

設定設計工具 會先搜尋專案系統所建立的 Settings.settings 檔案。 此 Settings.settings 檔案是 [專案設計工具] 顯示在 [設定] 索引標籤中的預設檔案。Settings.settings 檔案位於 Visual Basic 專案的 [我的專案] 資料夾，以及 Visual C# 專案的 [屬性] 資料夾中。 然後，[專案設計工具] 會搜尋專案根資料夾中的其他設定檔。 因此，您應該將自訂設定檔放在此。 如果您將 .settings 檔案新增至專案中的其他地方，[專案設計工具] 就無法找到該檔案。

在 Visual Basic 中於執行階段存取或變更應用程式設定

在 Visual Basic 專案中，您可以使用 My.Settings 物件在執行階段存取應用程式設定。 請在 [設定] 頁面中，按一下 [檢視程式碼] 按鈕，以檢視 Settings.vb 檔案。 Settings.vb 會定義 Settings 類別，讓您用來處理設定類別上的下列事件：SettingChanging、PropertyChanged、SettingsLoaded 和 SettingsSaving。 請注意，Settings.vb 中的 Settings 類別是部分類別，只會顯示使用者所擁有的程式碼，不會顯示整個產生的類別。 如需使用 My.Settings 物件存取應用程式設定的詳細資訊，請參閱存取應用程式設定 (.NET Framework)。

使用者在執行階段所變更之任何使用者範圍的設定值 (例如表單的位置)，都會儲存在 user.config 檔案中。 請注意，預設值仍然是儲存在 app.config 中。

如果在執行階段期間 (例如在測試應用程式時) 變更了任何使用者範圍的設定，並想要將這些設定重設為預設值，請選取 [同步處理] 按鈕。

建議使用 My.Settings 物件和預設 .settings 檔案來存取設定。 因為您可以使用 [設定設計工具] 將屬性指派給設定，此外，還會在應用程式關閉前自動儲存使用者設定。 然而，Visual Basic 應用程式可以直接存取設定。 在這種情況下，您必須存取 MySettings 類別，並使用專案根目錄下的自訂 .settings 檔案。 您必須在結束應用程式之前儲存使用者設定，如同您針對 C# 應用程式所做的一樣 (將於下一章節中描述)。

在 C# 中於執行階段存取或變更應用程式設定

在除了 Visual Basic 之外的語言中 (例如 C#)，您必須直接存取 Settings 類別，如下列 Visual C# 範例所示。

Properties.Settings.Default.FirstUserSetting = "abc";

您必須明確呼叫此包裝函式類別的 Save 方法，才能保存使用者設定。 這通常在主要表單的 Closing 事件處理常式中執行。 下列 C# 範例會示範呼叫 Save 方法。

Properties.Settings.Default.Save();

如需透過 Settings 類別存取應用程式設定的一般資訊，請參閱應用程式設定概觀 (.NET Framework)。 如需逐一查看設定的詳細資訊，請參閱此 論壇文章。

相關內容