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

В следующем примере кода показано, как проверить значение ReadOnlyAttribute для MyProperty.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. Затем он индексируется в PropertyDescriptorCollection для получения MyProperty.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.The example presents two different ways of checking the value of the ReadOnlyAttribute. Во втором фрагменте кода в примере вызывается метод 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. Элементы, у которых нет этого атрибута или помеченные ReadOnlyAttribute, имеют значение false, доступны для чтения и записи и могут быть изменены.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. При пометке свойства с ReadOnlyAttribute, установленным в true, значение этого атрибута устанавливается равным элементу константы 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()

Возвращает строку, представляющую текущий объект.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)

Применяется к

Дополнительно