StringValidatorAttribute

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

StringValidatorAttribute クラス

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

.NET Framework が構成プロパティに対して文字列の検証を実行するように、宣言によって指示します。このクラスは継承できません。

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

Visual Basic (宣言)

<AttributeUsageAttribute(AttributeTargets.Property)> _
Public NotInheritable Class
 StringValidatorAttribute
    Inherits ConfigurationValidatorAttribute

Visual Basic (使用法)

Dim instance As StringValidatorAttribute

C#

[AttributeUsageAttribute(AttributeTargets.Property)] 
public sealed class StringValidatorAttribute
 : ConfigurationValidatorAttribute

C++

[AttributeUsageAttribute(AttributeTargets::Property)] 
public ref class StringValidatorAttribute sealed
 : public ConfigurationValidatorAttribute

J#

/** @attribute AttributeUsageAttribute(AttributeTargets.Property) */ 
public final class StringValidatorAttribute
 extends ConfigurationValidatorAttribute

JScript

AttributeUsageAttribute(AttributeTargets.Property) 
public final class StringValidatorAttribute
 extends ConfigurationValidatorAttribute

解説

StringValidatorAttribute を使用して、構成プロパティを装飾します。これは、.NET Framework に StringValidator を使用してプロパティを検証するように指示し、装飾のパラメータの値を渡すためです。

StringValidatorAttribute オブジェクトは、プロパティ型だけに適用できます。

使用例

StringValidatorAttribute オブジェクトを使用して、カスタム ConfigurationSection オブジェクトのプロパティを装飾する方法を、次のコード例に示します。

Visual Basic

<ConfigurationProperty("fileName", _
DefaultValue:="default.txt", _
IsRequired:=True, _
IsKey:=False), _
StringValidator( _
InvalidCharacters:=" ~!@#$%^&*()[]{}/;'""|\",
 _
MinLength:=1, _
MaxLength:=60)> _
Public Property FileName() As
 String
    Get
        Return CStr(Me("fileName"))
    End Get
    Set(ByVal value As String)
        Me("fileName") = value
    End Set
End Property

C#

[ConfigurationProperty("fileName", DefaultValue = "default.txt"
,
    IsRequired = true, IsKey = false)]
[StringValidator(InvalidCharacters = " ~!@#$%^&*()[]{}/;'\"|\\"
,
    MinLength = 1, MaxLength = 60)]
public string FileName
{
    get
    {
        return (string)this["fileName"];
    }
    set
    {
        this["fileName"] = value;
    }
}

継承階層

System.Object
   System.Attribute
     System.Configuration.ConfigurationValidatorAttribute
      System.Configuration.StringValidatorAttribute

スレッド セーフ

この型の 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

参照

関連項目
StringValidatorAttribute メンバ
System.Configuration 名前空間
ConfigurationValidatorAttribute クラス
ConfigurationPropertyAttribute クラス
StringValidator クラス

StringValidatorAttribute コンストラクタ

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

StringValidatorAttribute クラスの新しいインスタンスを初期化します。

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

Visual Basic (宣言)

Public Sub New

Visual Basic (使用法)

Dim instance As New StringValidatorAttribute

C#

public StringValidatorAttribute ()

C++

public:
StringValidatorAttribute ()

J#

public StringValidatorAttribute ()

JScript

public function StringValidatorAttribute ()

解説

このコンストラクタを属性付きモデルで使用し、構成要素のプロパティに確実に文字列型の値が割り当てられるようにします。

使用例

StringValidatorAttribute コンストラクタを使用する例を次に示します。

Visual Basic

<ConfigurationProperty("alias", _
DefaultValue:="anotherName.txt", _
IsRequired:=True, _
IsKey:=False), _
StringValidator()> _
Public Property [Alias]() As
 String
    Get
        Return CStr(Me("alias"))
    End Get
    Set(ByVal value As String)
        Me("alias") = value
    End Set
End Property

C#

[ConfigurationProperty("alias", DefaultValue = "anotherName.txt"
,
    IsRequired = true, IsKey = false)]
[StringValidator()]
public string Alias
{
    get
    {
        return (string)this["alias"];
    }
    set
    {
        this["alias"] = value;
    }
}

プラットフォーム

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

参照

関連項目
StringValidatorAttribute クラス
StringValidatorAttribute メンバ
System.Configuration 名前空間
StringValidator クラス

StringValidatorAttribute プロパティ

パブリック プロパティ

	名前	説明
	InvalidCharacters	プロパティに対して無効な文字を取得または設定します。
	MaxLength	プロパティに割り当てることができる文字列の最大長を取得または設定します。
	MinLength	プロパティに割り当てることができる文字列の最小値を取得または設定します。
	TypeId	派生クラスに実装されている場合は、この Attribute の一意の識別子を取得します。 ( Attribute から継承されます。)
	ValidatorInstance	オーバーライドされます。 StringValidator のインスタンスを取得します。
	ValidatorType	検証コントロールの属性の型を取得します。 ( ConfigurationValidatorAttribute から継承されます。)

参照

関連項目

StringValidatorAttribute クラス
System.Configuration 名前空間
ConfigurationValidatorAttribute クラス
ConfigurationPropertyAttribute クラス
StringValidator クラス

StringValidatorAttribute メソッド

パブリック メソッド

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

	名前	説明
	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 から継承されます。)

参照

関連項目

StringValidatorAttribute クラス
System.Configuration 名前空間
ConfigurationValidatorAttribute クラス
ConfigurationPropertyAttribute クラス
StringValidator クラス

StringValidatorAttribute メンバ

.NET Framework が構成プロパティに対して文字列の検証を実行するように、宣言によって指示します。このクラスは継承できません。

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

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

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

パブリック プロパティ

	名前	説明
	InvalidCharacters	プロパティに対して無効な文字を取得または設定します。
	MaxLength	プロパティに割り当てることができる文字列の最大長を取得または設定します。
	MinLength	プロパティに割り当てることができる文字列の最小値を取得または設定します。
	TypeId	派生クラスに実装されている場合は、この Attribute の一意の識別子を取得します。(Attribute から継承されます。)
	ValidatorInstance	オーバーライドされます。 StringValidator のインスタンスを取得します。
	ValidatorType	検証コントロールの属性の型を取得します。(ConfigurationValidatorAttribute から継承されます。)

パブリック メソッド

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

	名前	説明
	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 から継承されます。)

参照

関連項目

StringValidatorAttribute クラス
System.Configuration 名前空間
ConfigurationValidatorAttribute クラス
ConfigurationPropertyAttribute クラス
StringValidator クラス