appSettings 項目 (一般設定結構描述)
包含自訂應用程式的設定,例如檔案路徑、XML Web Service URL,或是儲存在應用程式 .ini 檔內的任何資訊。
<appSettings
file="relative file name" >
</appSettings>
屬性和項目
下列章節會說明屬性、子項目和父項目。
屬性
項目 |
描述 |
---|---|
file |
選擇性 String 屬性。 指定外部檔案的相對路徑,該檔案包含自訂的應用程式組態設定。 指定的檔案所包含的設定類型與在 appSettings add、clear 和 remove 屬性中所指定的相同,並使用與這些項目相同的索引鍵/值組格式。 指定的路徑是相對於本機組態檔。 如果找不到指定的檔案,執行階段便會忽略這個屬性。 由於 Web.config 檔案的任何變更都會使應用程式重新啟動,使用個別的檔案能讓使用者修改在 appSettings 區段中的值而不使應用程式重新啟動。 個別檔案的內容會與 Web.config 檔案中的 appSettings 區段合併。 這項功能僅限於 appSettings 屬性。 注意:在 .NET Framework 2.0 版中,您現在可以針對支援 configSource 屬性的所有組態項目,在個別檔案中包含組態設定。 但是,在使用 configSource 屬性時,由於不能合併項目設定,您必須將整個區段都移至個別檔案。 在使用 configSource 屬性時,會對 Web.config 檔案進行一次寫入。 這會使得應用程式重新啟動,不過對於區段的後續更新則會直接寫入個別檔案,而不會造成後續的應用程式重新啟動。 如需詳細資訊,請參閱 ConfigSource。 |
繼承的屬性 |
選擇性屬性。 所有區段項目繼承的屬性。 |
子項目
項目 |
描述 |
---|---|
add |
選擇性項目。 將自訂應用程式設定當做名稱/值組,加入至應用程式設定的集合。 |
clear |
選擇性項目。 移除繼承自訂應用程式設定的所有參考,只保留目前的 add 屬性所加入的參考。 |
remove |
選擇性項目。 移除應用程式設定集合中,繼承自訂應用程式設定的參考。 |
父項目
項目 |
描述 |
---|---|
configuration |
指定 Common Language Runtime 和 .NET Framework 應用程式所使用之每個組態檔中需要的根項目 (Root Element)。 |
system.web |
指定組態檔中 ASP.NET 組態設定的根項目 (Root Element),並包含會設定 ASP.NET Web 應用程式以及控制這些應用程式之行為的組態項目。 |
備註
appSettings 項目會儲存自訂的應用程式組態資訊,例如檔案路徑、XML Web Service URL,或是儲存在應用程式的 .ini 檔內的任何資訊。 可以使用 ConfigurationManager 類別,在程式碼中存取 appSettings 項目內所指定的索引鍵/值組。 參閱類別中的程式碼範例,瞭解如何透過程式設計方式存取appSettings。
您可以使用 file 屬性指定組態檔,以提供其他設定或覆寫 appSettings 項目中指定的設定。 file 屬性可以用於原始檔控制小組開發案例中,例如當使用者想要覆寫應用程式組態檔所指定的專案設定時。 file 屬性中指定之組態檔的根節點必須是 appSettings 項目,而不是 configuration 項目。
在 .NET Framework 2.0 版應用程式中,請將資料庫連接字串 (Connection String) 儲存在 connectionStrings 項目 (ASP.NET 設定結構描述) 集合中,而非儲存在應用程式設定集合中。
預設組態
下列預設 appSettings 項目不會明確地設定在 Machine.config 檔案或根 Web.config 檔案中。 然而,應用程式傳回的是預設組態。
<appSettings file="">
<settings>
<clear />
</settings>
</appSettings>
範例
file 屬性中指定之組態檔的根節點必須是 appSettings 項目,而不是 configuration 項目。
下列程式碼範例示範如何使用 file 屬性中所指定之組態檔的正確格式。
<?xml version="1.0" encoding="utf-8" ?>
<appSettings>
<add key="Application1" value="MyApplication1" />
<add key="Setting1" value="MySetting" />
</appSettings>
下列程式碼範例將顯示如何在組態檔中定義自訂的應用程式設定。
<configuration>
<appSettings>
<add key="Application Name" value="MyApplication" />
</appSettings>
</configuration>
項目資訊
組態區段處理常式 |
|
組態成員 |
|
可設定的位置 |
Machine.config 根層次的 Web.config 應用程式層級的 Web.config 虛擬或實體目錄層級的 Web.config |
需求 |
Microsoft Internet Information Services (IIS) 5.0、5.1 或 6.0 .NET Framework 1.0、1.1 或 2.0 版 Microsoft Visual Studio 2003 或 Visual Studio 2005 |
請參閱
參考
appSettings 的 add 項目 (一般設定結構描述)
appSettings 的 clear 項目 (一般設定結構描述)
appSettings 的 remove 項目 (一般設定結構描述)