SettingsDescriptionAttribute

.NET Framework クラス ライブラリ リファレンス

SettingsDescriptionAttribute クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

個々の構成プロパティを説明する文字列を提供します。このクラスは継承できません。

名前空間: System.Configuration
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

<AttributeUsageAttribute(AttributeTargets.Property)> _
Public NotInheritable Class
 SettingsDescriptionAttribute
    Inherits Attribute

Visual Basic (使用法)

Dim instance As SettingsDescriptionAttribute

C#

[AttributeUsageAttribute(AttributeTargets.Property)] 
public sealed class SettingsDescriptionAttribute
 : Attribute

C++

[AttributeUsageAttribute(AttributeTargets::Property)] 
public ref class SettingsDescriptionAttribute
 sealed : public Attribute

J#

/** @attribute AttributeUsageAttribute(AttributeTargets.Property) */ 
public final class SettingsDescriptionAttribute
 extends Attribute

JScript

AttributeUsageAttribute(AttributeTargets.Property) 
public final class SettingsDescriptionAttribute
 extends Attribute

解説

SettingsDescriptionAttribute は、関連付けられた構成プロパティを識別および説明する場合に、デザイン時ツールと実行時管理ツールの両方を支援するために用意されています。

この属性はオプションであり、個々の構成プロパティ レベルでのみ適用できます。

継承階層

System.Object
   System.Attribute
    System.Configuration.SettingsDescriptionAttribute

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
SettingsDescriptionAttribute メンバ
System.Configuration 名前空間
SettingsGroupDescriptionAttribute

SettingsDescriptionAttribute コンストラクタ

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

SettingsDescriptionAttribute クラスのインスタンスを初期化します。

名前空間: System.Configuration
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Public Sub New ( _
    description As String _
)

Visual Basic (使用法)

Dim description As String

Dim instance As New SettingsDescriptionAttribute(description)

C#

public SettingsDescriptionAttribute (
    string description
)

C++

public:
SettingsDescriptionAttribute (
    String^ description
)

J#

public SettingsDescriptionAttribute (
    String description
)

JScript

public function SettingsDescriptionAttribute
 (
    description : String
)

パラメータ

description

説明テキストとして使用する String。

解説

説明には、長さが Int32 で表される String クラスの理論上の最大長が設定されていますが、description パラメータのサイズは次の 2 つの実際的な理由から制限されています。

• 長い説明テキストは、ユーザー インターフェイス (UI) で表示するのが難しく、またユーザーも読みづらく感じます。

• 設定プロバイダは、全体的な使用クォータを強制的に適用する場合があります。また、設定プロバイダは、UserSettingsPermission クラスで指定されたユーザー構成クォータを強制的に適用する必要があります。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
SettingsDescriptionAttribute クラス
SettingsDescriptionAttribute メンバ
System.Configuration 名前空間
Description
UserSettingsPermission

SettingsDescriptionAttribute プロパティ

パブリック プロパティ

	名前	説明
	Description	関連付けられた構成プロパティの説明テキストを取得します。
	TypeId	派生クラスに実装されている場合は、この Attribute の一意の識別子を取得します。 ( Attribute から継承されます。)

参照

関連項目

SettingsDescriptionAttribute クラス
System.Configuration 名前空間
SettingsGroupDescriptionAttribute

SettingsDescriptionAttribute メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 ( Attribute から継承されます。)
	GetCustomAttribute	オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用された指定した型のカスタム属性を取得します。 ( Attribute から継承されます。)
	GetCustomAttributes	オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されたカスタム属性の配列を取得します。 ( Attribute から継承されます。)
	GetHashCode	このインスタンスのハッシュ コードを返します。 ( Attribute から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	IsDefaultAttribute	派生クラス内でオーバーライドされたときに、このインスタンスの値が派生クラスの既定値かどうかを示します。 ( Attribute から継承されます。)
	IsDefined	オーバーロードされます。 指定した型のカスタム属性が、アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されているかどうかを判断します。 ( Attribute から継承されます。)
	Match	派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。 ( Attribute から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

参照

関連項目

SettingsDescriptionAttribute クラス
System.Configuration 名前空間
SettingsGroupDescriptionAttribute

SettingsDescriptionAttribute メンバ

個々の構成プロパティを説明する文字列を提供します。このクラスは継承できません。

SettingsDescriptionAttribute データ型で公開されるメンバを以下の表に示します。

パブリック コンストラクタ

	名前	説明
	SettingsDescriptionAttribute	SettingsDescriptionAttribute クラスのインスタンスを初期化します。

パブリック プロパティ

	名前	説明
	Description	関連付けられた構成プロパティの説明テキストを取得します。
	TypeId	派生クラスに実装されている場合は、この Attribute の一意の識別子を取得します。(Attribute から継承されます。)

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 ( Attribute から継承されます。)
	GetCustomAttribute	オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用された指定した型のカスタム属性を取得します。 (Attribute から継承されます。)
	GetCustomAttributes	オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されたカスタム属性の配列を取得します。 (Attribute から継承されます。)
	GetHashCode	このインスタンスのハッシュ コードを返します。 (Attribute から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	IsDefaultAttribute	派生クラス内でオーバーライドされたときに、このインスタンスの値が派生クラスの既定値かどうかを示します。 (Attribute から継承されます。)
	IsDefined	オーバーロードされます。 指定した型のカスタム属性が、アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されているかどうかを判断します。 (Attribute から継承されます。)
	Match	派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。 (Attribute から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)

参照

関連項目

SettingsDescriptionAttribute クラス
System.Configuration 名前空間
SettingsGroupDescriptionAttribute