ReadOnlyAttribute クラス

定義

この属性が関連付けられているプロパティを読み取り専用にするか、読み書き両用にするかを指定します。Specifies whether the property this attribute is bound to is read-only or read/write. このクラスは継承できません。This class cannot be inherited.

public ref class ReadOnlyAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.All)]
public sealed class ReadOnlyAttribute : Attribute
type ReadOnlyAttribute = class
    inherit Attribute
Public NotInheritable Class ReadOnlyAttribute
Inherits Attribute
継承
ReadOnlyAttribute
属性

次のコード例では、プロパティを読み取り専用としてマークします。The following code example marks a property as read-only.

   [ReadOnly(true)]
   int get()
   {
      // Insert code here.
      return 0;
   }
}
[ReadOnly(true)]
 public int MyProperty {
    get {
       // Insert code here.
       return 0;
    }
}
Public ReadOnly Property MyProperty() As Integer
    Get
        ' Insert code here.
        Return 0
    End Get
End Property

次のコード例は、MyPropertyReadOnlyAttribute の値を確認する方法を示しています。The next code example shows how to check the value of the ReadOnlyAttribute for MyProperty. まず、このコードはオブジェクトのすべてのプロパティを含む PropertyDescriptorCollection を取得します。First, the code gets a PropertyDescriptorCollection with all the properties for the object. 次に、MyPropertyを取得するために PropertyDescriptorCollection にインデックスを付けます。Next, it indexes into the PropertyDescriptorCollection to get MyProperty. 次に、このプロパティの属性を返し、それらを attributes 変数に保存します。Then it returns the attributes for this property and saves them in the attributes variable.

この例では、ReadOnlyAttributeの値を確認する2つの異なる方法を示します。The example presents two different ways of checking the value of the ReadOnlyAttribute. 2番目のコード片では、この例では Equals メソッドを呼び出します。In the second code fragment, the example calls the Equals method. 最後のコードフラグメントでは、この例では、IsReadOnly プロパティを使用して値をチェックします。In the last code fragment, the example uses the IsReadOnly property to check the value.

// 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.
}
// 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.
}
' 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 

ReadOnlyAttributeでクラスをマークした場合は、次のコード例を使用して値を確認します。If you marked a class with the ReadOnlyAttribute, use the following code example to check the value.

AttributeCollection^ attributes = TypeDescriptor::GetAttributes( MyProperty );
if ( attributes[ ReadOnlyAttribute::typeid ]->Equals( ReadOnlyAttribute::Yes ) )
{
   // Insert code here.
}
AttributeCollection attributes = 
   TypeDescriptor.GetAttributes(MyProperty);
if(attributes[typeof(ReadOnlyAttribute)].Equals(ReadOnlyAttribute.Yes)) {
   // Insert code here.
}
Dim attributes As AttributeCollection = TypeDescriptor.GetAttributes(MyProperty)
If attributes(GetType(ReadOnlyAttribute)).Equals(ReadOnlyAttribute.Yes) Then
    ' Insert code here.
End If 

注釈

ReadOnlyAttribute でマークされたメンバーは true に設定されるか、または Set メソッドを持たないメンバーは変更できません。Members that are marked with the ReadOnlyAttribute set to true or that do not have a Set method cannot be changed. この属性を持たないメンバー、または false に設定された ReadOnlyAttribute でマークされているメンバーは、読み取り/書き込みが可能であり、変更することができます。Members that do not have this attribute or that are marked with the ReadOnlyAttribute set to false are read/write, and they can be changed. 既定値は、No です。The default is No.

重要

PropertyDescriptor クラスは、デザイン環境と実行時に ReadOnlyAttribute を適用します。The PropertyDescriptor class enforces the ReadOnlyAttribute in the design environment and at run time. ReadOnlyAttributetrueに設定してプロパティをマークすると、この属性の値は Yes定数メンバーに設定されます。When you mark a property with the ReadOnlyAttribute set to true, the value of this attribute is set to the constant member Yes. ReadOnlyAttribute でマークされたプロパティが falseに設定されている場合、値は Noです。For a property marked with the ReadOnlyAttribute set to false, the value is No. したがって、コード内でこの属性の値を確認する場合は、属性を ReadOnlyAttribute.Yes または ReadOnlyAttribute.Noとして指定する必要があります。Therefore, when you want to check the value of this attribute in your code, you must specify the attribute as ReadOnlyAttribute.Yes or ReadOnlyAttribute.No.

詳細については、「属性」を参照してください。For more information, see Attributes.

コンストラクター

ReadOnlyAttribute(Boolean)

ReadOnlyAttribute クラスの新しいインスタンスを初期化します。Initializes a new instance of the ReadOnlyAttribute class.

フィールド

Default

ReadOnlyAttribute の既定値である No を指定します。つまり、この属性が関連付けられたプロパティは読み書き可能です。Specifies the default value for the ReadOnlyAttribute, which is No (that is, the property this attribute is bound to is read/write). static フィールドは読み取り専用です。This static field is read-only.

No

この属性が関連付けられているプロパティが読み書き可能であり、変更できることを指定します。Specifies that the property this attribute is bound to is read/write and can be modified. static フィールドは読み取り専用です。This static field is read-only.

Yes

この属性が関連付けられているプロパティが読み取り専用であり、サーバー エクスプローラーで変更できないことを指定します。Specifies that the property this attribute is bound to is read-only and cannot be modified in the server explorer. static フィールドは読み取り専用です。This static field is read-only.

プロパティ

IsReadOnly

この属性が関連付けられているプロパティが読み取り専用かどうかを示す値を取得します。Gets a value indicating whether the property this attribute is bound to is read-only.

TypeId

派生クラスで実装されると、この Attribute の一意の識別子を取得します。When implemented in a derived class, gets a unique identifier for this Attribute.

(継承元 Attribute)

メソッド

Equals(Object)

このインスタンスと指定したオブジェクトが等しいかどうかを示します。Indicates whether this instance and a specified object are equal.

GetHashCode()

このインスタンスのハッシュ コードを返します。Returns the hash code for this instance.

GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(継承元 Object)
IsDefaultAttribute()

この属性が既定値かどうかを判断します。Determines if this attribute is the default.

Match(Object)

派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(継承元 Attribute)
MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(継承元 Object)
ToString()

現在のオブジェクトを表す string を返します。Returns a string that represents the current object.

(継承元 Object)

明示的なインターフェイスの実装

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

一連の名前を対応する一連のディスパッチ識別子に割り当てます。Maps a set of names to a corresponding set of dispatch identifiers.

(継承元 Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

オブジェクトの型情報を取得します。この情報はインターフェイスの型情報の取得に使用できます。Retrieves the type information for an object, which can be used to get the type information for an interface.

(継承元 Attribute)
_Attribute.GetTypeInfoCount(UInt32)

オブジェクトが提供する型情報インターフェイスの数 (0 または 1) を取得します。Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(継承元 Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

オブジェクトによって公開されたプロパティおよびメソッドへのアクセスを提供します。Provides access to properties and methods exposed by an object.

(継承元 Attribute)

適用対象

こちらもご覧ください