ReadOnlyAttribute クラス

[アーティクル]
03/28/2008

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

この型のすべてのメンバの一覧については、ReadOnlyAttribute メンバを参照してください。

System.Object
System.Attribute
System.ComponentModel.ReadOnlyAttribute

<AttributeUsage(AttributeTargets.All)>
NotInheritable Public Class ReadOnlyAttribute   Inherits Attribute
[C#]
[AttributeUsage(AttributeTargets.All)]
public sealed class ReadOnlyAttribute : Attribute
[C++]
[AttributeUsage(AttributeTargets::All)]
public __gc __sealed class ReadOnlyAttribute : public Attribute
[JScript]
public
   AttributeUsage(AttributeTargets.All)
class ReadOnlyAttribute extends Attribute

スレッドセーフ

この型の public static (Visual Basicでは Shared) のすべてのメンバは、マルチスレッド操作で安全に使用できます。インスタンスのメンバの場合は、スレッドセーフであるとは限りません。

解説

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

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

詳細については、「属性の概要」および「属性を使用したメタデータの拡張」を参照してください。

使用例

[Visual Basic, C#, C++] プロパティを読み取り専用としてマークする例を次に示します。

 
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++] 
public:
    [ReadOnly(true)]
     __property int get_MyProperty() {
           // Insert code here.
           return 0;
        }

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

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

 
' 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)->Item[S"MyProperty"]->Attributes;
 
// Checks to see whether the value of the ReadOnlyAttribute is Yes.
if(attributes->Item[__typeof(ReadOnlyAttribute)]->Equals(ReadOnlyAttribute::Yes)) {
   // Insert code here.
}
 
// This is another way to see whether the property is read-only.
ReadOnlyAttribute* myAttribute = 
   dynamic_cast<ReadOnlyAttribute*>(attributes->Item[__typeof(ReadOnlyAttribute)]);
if(myAttribute->IsReadOnly) {
   // Insert code here.
}

[Visual Basic, C#, C++] ReadOnlyAttribute を使用してクラスをマークした場合は、次のコード例を使用して値を確認します。

 
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( __box(MyProperty));
if(attributes->Item[__typeof(ReadOnlyAttribute)]->Equals(ReadOnlyAttribute::Yes)) {
   // Insert code here.
}

[JScript] JScript のサンプルはありません。Visual Basic、C#、および C++ のサンプルを表示するには、このページの左上隅にある言語のフィルタボタンをクリックします。

必要条件

名前空間: System.ComponentModel

プラットフォーム: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 ファミリ

アセンブリ: System (System.dll 内)

参照

次の方法で共有

ReadOnlyAttribute クラス

スレッドセーフ

解説

使用例

必要条件

参照

その他のリソース