アプリケーション設定の属性

アプリケーション設定アーキテクチャには、アプリケーション設定ラッパー クラスまたはその個々のプロパティに適用できるさまざまな属性が用意されています。 これらの属性は、カスタム ラッパーの指定要件に合わせて機能を調節できるように、アプリケーション設定インフラストラクチャ (多くの場合、具体的には設定プロバイダー) によって実行時にチェックされます。

アプリケーション設定ラッパー クラス、このクラスの個々のプロパティ、またはその両方に適用できる属性を次の表に示します。 定義上、各設定プロパティに 1 つのスコープ属性 (UserScopedSettingAttribute または ApplicationScopedSettingAttribute) だけを適用する必要があります。

注意

SettingsProvider クラスから派生するカスタム設定プロバイダーは、ApplicationScopedSettingAttributeUserScopedSettingAttributeDefaultSettingValueAttribute の 3 つの属性だけを認識する必要があります。

属性

Target

説明

SettingsProviderAttribute

両方が の場合

永続化に使用される設定プロバイダーの短い名前を指定します。

この属性を指定しないときは、既定のプロバイダー LocalFileSettingsProvider を指定したものと見なされます。

UserScopedSettingAttribute

両方が の場合

ユーザー スコープのアプリケーション設定としてプロパティを定義します。

ApplicationScopedSettingAttribute

両方が の場合

アプリケーション スコープのアプリケーション設定としてプロパティを定義します。

DefaultSettingValueAttribute

プロパティ

プロバイダーによって、このプロパティのハードコーディングされた既定値に逆シリアル化できる文字列を指定します。

LocalFileSettingsProvider はこの属性を必要としません。既に永続化されている値がある場合は、この属性で指定された値をオーバーライドします。

SettingsDescriptionAttribute

プロパティ

主に実行時ツールとデザイン時ツールによって使用される、個々の設定の記述テストを指定します。

SettingsGroupNameAttribute

クラス

設定グループの名前を明示的に指定します。 この属性を指定しない場合、ApplicationSettingsBase はラッパー クラス名を使用します。

SettingsGroupDescriptionAttribute

クラス

主に実行時ツールとデザイン時ツールによって使用される、設定グループの記述テストを指定します。

SettingsManageabilityAttribute

両方が の場合

設定グループまたはプロパティに提供する必要がある 0 個以上の管理機能サービスを指定します。 使用できるサービスは、SettingsManageability 列挙型によって記述されます。

SpecialSettingAttribute

プロパティ

設定プロバイダーによる特別な処理を意味する特別な定義済みカテゴリ (接続文字列など) に設定が属することを示します。 この属性の定義済みカテゴリは、SpecialSetting 列挙型によって定義されます。

SettingsSerializeAsAttribute

両方が の場合

設定グループまたはプロパティに推奨されるシリアル化機構を指定します。 使用できるシリアル化機構は、SettingsSerializeAs 列挙型によって定義されます。

NoSettingsVersionUpgradeAttribute

プロパティ

マークしたプロパティのアプリケーション アップグレード機能を設定プロバイダーがすべて無効にすることを指定します。

クラスは、その属性をアプリケーション設定ラッパー クラスだけに適用できることを示します。 プロパティは、その属性を設定プロパティだけに適用できることを示します。 両方は、その属性をどちらのレベルでも適用できることを示します。

参照

処理手順

方法 : デザイナーを使用してアプリケーション設定を作成する

参照

ApplicationSettingsBase

SettingsProvider

概念

アプリケーション設定アーキテクチャ