應用程式設定屬性
應用程式設定結構提供許多屬性,可套用至應用程式設定包裝函式類別或其個別屬性。 這些屬性會在執行階段由應用程式設定基礎結構 (具體而言,通常是設定提供者) 檢查,以便根據自訂包裝函式的指定需求量身打造其運作。
下表列出可套用至應用程式設定包裝函式類別、此類別的個別屬性,或兩者的屬性。 根據定義,只有單一範圍屬性 — UserScopedSettingAttribute 或 ApplicationScopedSettingAttribute — 必須套用至每個設定屬性和所有的設定屬性。
注意
衍生自 SettingsProvider 類別的自訂設定提供者,只需要辨識下列三個屬性:ApplicationScopedSettingAttribute、UserScopedSettingAttribute,以及 DefaultSettingValueAttribute。
屬性 | Target | 描述 |
---|---|---|
SettingsProviderAttribute | 兩者 | 指定要用於持續性之設定提供者的簡短名稱。 如果未提供此屬性,則會假設為預設提供者 LocalFileSettingsProvider。 |
UserScopedSettingAttribute | 兩者 | 將屬性定義為使用者範圍應用程式設定。 |
ApplicationScopedSettingAttribute | 兩者 | 將屬性定義為應用程式範圍的應用程式設定。 |
DefaultSettingValueAttribute | 屬性 | 指定可由提供者還原序列化為此屬性硬式編碼預設值的字串。 LocalFileSettingsProvider 不需要這個屬性,而且如果該屬性已經有保存的值,則會覆寫其所提供的任何值。 |
SettingsDescriptionAttribute | 屬性 | 提供個別設定的描述性測試,主要執行階段和設計階段工具使用。 |
SettingsGroupNameAttribute | 類別 | 提供設定群組的明確名稱。 如果遺漏此屬性,ApplicationSettingsBase 會使用包裝函式類別名稱。 |
SettingsGroupDescriptionAttribute | 類別 | 提供設定群組的描述性測試,主要是由執行階段和設計階段工具使用。 |
SettingsManageabilityAttribute | 兩者 | 指定應該提供給設定群組或屬性的零個或多個可管理性服務。 可用的服務是由 SettingsManageability 列舉所描述。 |
SpecialSettingAttribute | 屬性 | 表示設定屬於特殊預先定義的類別,例如連接字串,建議由設定提供者進行特殊處理。 此屬性的預先定義類別是由 SpecialSetting 列舉所定義。 |
SettingsSerializeAsAttribute | 兩者 | 指定設定群組或屬性的慣用序列化機制。 可用的序列化機制是由 SettingsSerializeAs 列舉所定義。 |
NoSettingsVersionUpgradeAttribute | 屬性 | 指定設定提供者應該停用標示屬性的所有應用程式升級功能。 |
類別 表示該屬性只能套用至應用程式設定包裝函式類別。 屬性 表示該屬性只能套用設定屬性。 兩者 都表示屬性可以在任一層級套用。