ReadOnlyAttribute

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

ReadOnlyAttribute クラス

この属性が関連付けられているプロパティがデザイン時に読み取り専用か、または読み書き可能かを指定します。このクラスは継承できません。

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

Visual Basic (宣言)

<AttributeUsageAttribute(AttributeTargets.All)> _
Public NotInheritable Class
 ReadOnlyAttribute
    Inherits Attribute

Visual Basic (使用法)

Dim instance As ReadOnlyAttribute

C#

[AttributeUsageAttribute(AttributeTargets.All)] 
public sealed class ReadOnlyAttribute : Attribute

C++

[AttributeUsageAttribute(AttributeTargets::All)] 
public ref class ReadOnlyAttribute sealed :
 public Attribute

J#

/** @attribute AttributeUsageAttribute(AttributeTargets.All) */ 
public final class ReadOnlyAttribute extends
 Attribute

JScript

AttributeUsageAttribute(AttributeTargets.All) 
public final class ReadOnlyAttribute extends
 Attribute

解説

ReadOnlyAttribute に true を設定してマークされているメンバや、Set メソッドを持たないメンバは変更できません。この属性を持たないメンバや、ReadOnlyAttribute に false を設定してマークされているメンバは、読み書き可能で、変更できます。既定値は No です。

重要 :
PropertyDescriptor クラスは、デザイン環境で、および実行時に ReadOnlyAttribute を適用します。ReadOnlyAttribute に true を設定してプロパティをマークすると、この属性の値は定数メンバ Yes に設定されます。false に設定された ReadOnlyAttribute でマークしたプロパティの場合、値は No になります。したがって、コード内でこの属性の値を確認する場合は、属性を ReadOnlyAttribute.Yes または ReadOnlyAttribute.No として指定する必要があります。

詳細については、属性の概要、属性を使用したメタデータの拡張 の各トピックを参照してください。

使用例

プロパティを読み取り専用としてマークするコード例を次に示します。

Visual Basic

Public ReadOnly Property
 MyProperty() As Integer
    Get
        ' Insert code here.
        Return 0
    End Get
End Property

C#

[ReadOnly(true)]
 public int MyProperty {
    get {
       // Insert code here.
       return 0;
    }
}

C++

   [ReadOnly(true)]
   int get()
   {
      // Insert code here.
      return 0;
   }
}

J#

/** @attribute ReadOnly(true)
 */
/** @property 
 */
public int get_MyProperty()
{
    // Insert code here.
    return 0;
} //get_MyProperty

MyProperty の ReadOnlyAttribute の値を確認する方法を次のコード例に示します。最初に、オブジェクトのすべてのプロパティを保持する PropertyDescriptorCollection を取得します。次に、インデックスを付けて PropertyDescriptorCollection から MyProperty を取得します。そして、このプロパティの属性を返し、その属性を属性変数に保存します。

この例では、ReadOnlyAttribute の値を確認する 2 種類の方法を示します。2 番目のコード片では、Equals メソッドを呼び出します。最後のコード片では、IsReadOnly プロパティを使用して値を確認します。

Visual Basic

' Gets the attributes for the property.
Dim attributes As AttributeCollection = _
    TypeDescriptor.GetProperties(Me)("MyProperty").Attributes

' Checks to see whether the value of the ReadOnlyAttribute is Yes.
If attributes(GetType(ReadOnlyAttribute)).Equals(ReadOnlyAttribute.Yes)
 Then
    ' Insert code here.
End If 

' This is another way to see whether the property is read-only.
Dim myAttribute As ReadOnlyAttribute = _
    CType(attributes(GetType(ReadOnlyAttribute)), ReadOnlyAttribute)
    
If myAttribute.IsReadOnly Then
    ' Insert code here.
End If 

C#

// Gets the attributes for the property.
AttributeCollection attributes = 
   TypeDescriptor.GetProperties(this)["MyProperty"].Attributes;
 
// Checks to see whether the value of the ReadOnlyAttribute is Yes.
if(attributes[typeof(ReadOnlyAttribute)].Equals(ReadOnlyAttribute.Yes))
 {
   // Insert code here.
}
 
// This is another way to see whether the property is read-only.
ReadOnlyAttribute myAttribute = 
   (ReadOnlyAttribute)attributes[typeof(ReadOnlyAttribute)];
if(myAttribute.IsReadOnly) {
   // Insert code here.
}

C++

// Gets the attributes for the property.
AttributeCollection^ attributes = TypeDescriptor::GetProperties( this
 )[ "MyProperty" ]->Attributes;

// Checks to see whether the value of the ReadOnlyAttribute is Yes.
if ( attributes[ ReadOnlyAttribute::typeid ]->Equals( ReadOnlyAttribute::Yes
 ) )
{
   // Insert code here.
}

// This is another way to see whether the property is read-only.
ReadOnlyAttribute^ myAttribute = dynamic_cast<ReadOnlyAttribute^>(attributes[
 ReadOnlyAttribute::typeid ]);
if ( myAttribute->IsReadOnly )
{
   // Insert code here.
}

J#

// Gets the attributes for the property.
AttributeCollection attributes = TypeDescriptor.GetProperties(this).
    get_Item("MyProperty").get_Attributes();

// Checks to see whether the value of the ReadOnlyAttribute is Yes.
if (attributes.get_Item(ReadOnlyAttribute.class.ToType()).Equals
    (ReadOnlyAttribute.Yes)) {
    // Insert code here.
}

// This is another way to see whether the property is read-only.
ReadOnlyAttribute myAttribute = ((ReadOnlyAttribute)
    (attributes.get_Item(ReadOnlyAttribute.class.ToType())));

if (myAttribute.get_IsReadOnly()) {
    // Insert code here.
}

ReadOnlyAttribute を使用してクラスをマークした場合は、次のコード例を使用して値を確認します。

Visual Basic

Dim attributes As AttributeCollection = TypeDescriptor.GetAttributes(MyProperty)
If attributes(GetType(ReadOnlyAttribute)).Equals(ReadOnlyAttribute.Yes)
 Then
    ' Insert code here.
End If 

C#

AttributeCollection attributes = 
   TypeDescriptor.GetAttributes(MyProperty);
if(attributes[typeof(ReadOnlyAttribute)].Equals(ReadOnlyAttribute.Yes))
 {
   // Insert code here.
}

C++

AttributeCollection^ attributes = TypeDescriptor::GetAttributes( MyProperty );
if ( attributes[ ReadOnlyAttribute::typeid ]->Equals( ReadOnlyAttribute::Yes
 ) )
{
   // Insert code here.
}

J#

AttributeCollection attributes = 
    TypeDescriptor.GetAttributes("MyProperty");

if (attributes.get_Item(ReadOnlyAttribute.class.ToType()).Equals(
    ReadOnlyAttribute.Yes)) {
    // Insert code here.
}

継承階層

System.Object
   System.Attribute
    System.ComponentModel.ReadOnlyAttribute

スレッド セーフ

この型の 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、1.1、1.0

参照

関連項目
ReadOnlyAttribute メンバ
System.ComponentModel 名前空間
Attribute
PropertyDescriptor クラス
AttributeCollection クラス
PropertyDescriptorCollection クラス

ReadOnlyAttribute コンストラクタ

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

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

Visual Basic (宣言)

Public Sub New ( _
    isReadOnly As Boolean _
)

Visual Basic (使用法)

Dim isReadOnly As Boolean

Dim instance As New ReadOnlyAttribute(isReadOnly)

C#

public ReadOnlyAttribute (
    bool isReadOnly
)

C++

public:
ReadOnlyAttribute (
    bool isReadOnly
)

J#

public ReadOnlyAttribute (
    boolean isReadOnly
)

JScript

public function ReadOnlyAttribute (
    isReadOnly : boolean
)

パラメータ

isReadOnly

この属性が関連付けられているプロパティが読み取り専用であることを示す場合は true。プロパティが読み書き可能であることを示す場合は false。

解説

ReadOnlyAttribute に true を設定してマークされているメンバや、Set メソッドを持たないメンバは変更できません。この属性を持たないメンバや、ReadOnlyAttribute に false を設定してマークされているメンバは、読み書き可能で、変更できます。既定値は No です。

メモ
ReadOnlyAttribute に true を設定してプロパティをマークすると、この属性の値は定数メンバ Yes に設定されます。false に設定された ReadOnlyAttribute でマークしたプロパティの場合、値は No になります。したがって、コード内でこの属性の値を確認する場合は、属性を ReadOnlyAttribute.Yes または ReadOnlyAttribute.No として指定する必要があります。

使用例

プロパティを読み取り専用としてマークするコード例を次に示します。このコードは、新しい ReadOnlyAttribute を作成し、その値を ReadOnlyAttribute.Yes に設定してから、その属性をプロパティに関連付けます。

Visual Basic

<ReadOnlyAttribute(True)> _
Public Property MyProperty() As
 Integer
    Get
        ' Insert code here.
        Return 0
    End Get
    Set
        ' Insert code here.
    End Set
End Property

C#

[ReadOnly(true)]
public int MyProperty {
   get {
      // Insert code here.
      return 0;
   }
   set {
      // Insert code here.
   }
}
   

C++

public:
   [ReadOnly(true)]
   property int MyProperty 
   {
      int get()
      {
         // Insert code here.
         return 0;
      }
      void set( int value
 )
      {
         // Insert code here.
      }
   }

J#

/** @attribute ReadOnly(true)
 */
/** @property
 */
public int get_MyProperty()
{
    // Insert code here.
    return 0;
} //get_MyProperty

/** @property 
 */
public void set_MyProperty(int
 value)
{
    // Insert code here.
} //set_MyProperty

プラットフォーム

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、1.1、1.0

参照

関連項目
ReadOnlyAttribute クラス
ReadOnlyAttribute メンバ
System.ComponentModel 名前空間
ReadOnlyAttribute クラス

ReadOnlyAttribute フィールド

パブリック フィールド

	名前	説明
	Default	ReadOnlyAttribute の既定値である No を指定します。つまり、この属性が関連付けられたプロパティは読み書き可能です。static フィールドは読み取り専用です。
	No	この属性が関連付けられているプロパティが読み書き可能であり、デザイン時に変更できることを指定します。static フィールドは読み取り専用です。
	Yes	この属性が関連付けられているプロパティが読み取り専用であり、サーバー エクスプローラで変更できないことを指定します。static フィールドは読み取り専用です。

参照

関連項目

ReadOnlyAttribute クラス
System.ComponentModel 名前空間
Attribute
PropertyDescriptor クラス
AttributeCollection クラス
PropertyDescriptorCollection クラス

ReadOnlyAttribute プロパティ

パブリック プロパティ

	名前	説明
	IsReadOnly	この属性が関連付けられているプロパティが読み取り専用かどうかを示す値を取得します。
	TypeId	派生クラスに実装されている場合は、この Attribute の一意の識別子を取得します。 ( Attribute から継承されます。)

参照

関連項目

ReadOnlyAttribute クラス
System.ComponentModel 名前空間
Attribute
PropertyDescriptor クラス
AttributeCollection クラス
PropertyDescriptorCollection クラス

ReadOnlyAttribute メソッド

パブリック メソッド

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

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

プロテクト メソッド

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

参照

関連項目

ReadOnlyAttribute クラス
System.ComponentModel 名前空間
Attribute
PropertyDescriptor クラス
AttributeCollection クラス
PropertyDescriptorCollection クラス

ReadOnlyAttribute メンバ

この属性が関連付けられているプロパティがデザイン時に読み取り専用か、または読み書き可能かを指定します。このクラスは継承できません。

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

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

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

パブリック フィールド

	名前	説明
	Default	ReadOnlyAttribute の既定値である No を指定します。つまり、この属性が関連付けられたプロパティは読み書き可能です。static フィールドは読み取り専用です。
	No	この属性が関連付けられているプロパティが読み書き可能であり、デザイン時に変更できることを指定します。static フィールドは読み取り専用です。
	Yes	この属性が関連付けられているプロパティが読み取り専用であり、サーバー エクスプローラで変更できないことを指定します。static フィールドは読み取り専用です。

パブリック プロパティ

	名前	説明
	IsReadOnly	この属性が関連付けられているプロパティが読み取り専用かどうかを示す値を取得します。
	TypeId	派生クラスに実装されている場合は、この Attribute の一意の識別子を取得します。(Attribute から継承されます。)

パブリック メソッド

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

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

プロテクト メソッド

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

参照

関連項目

ReadOnlyAttribute クラス
System.ComponentModel 名前空間
Attribute
PropertyDescriptor クラス
AttributeCollection クラス
PropertyDescriptorCollection クラス