DefaultValueAttribute Класс

Определение

Пространство имен:

System.ComponentModel

Сборки:

netstandard.dll, System.Runtime.dll

Исходный код:

DefaultValueAttribute.cs

Указывает значение по умолчанию для свойства.

public ref class DefaultValueAttribute : Attribute

[System.AttributeUsage(System.AttributeTargets.All)]
public class DefaultValueAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.All)>]
type DefaultValueAttribute = class
    inherit Attribute

Public Class DefaultValueAttribute
Inherits Attribute

Наследование

Object

Attribute

DefaultValueAttribute

Атрибуты

AttributeUsageAttribute

Примеры

В следующем примере устанавливается значение MyPropertyfalseпо умолчанию.

private:
   bool _myVal;

public:
   [DefaultValue(false)]
   property bool MyProperty 
   {
      bool get()
      {
         return _myVal;
      }

      void set( bool value )
      {
         _myVal = value;
      }
   }

[DefaultValue(false)]
public bool MyProperty { get; set; }

Private _myVar As Boolean = False

<DefaultValue(False)>
Public Property MyProperty() As Boolean
    Get
        Return _myVar
    End Get
    Set
        _myVar = Value
    End Set
End Property

В следующем примере проверяется значение MyPropertyпо умолчанию. Сначала код получает PropertyDescriptorCollection все свойства объекта. Далее он индексирует в PropertyDescriptorCollection получение MyProperty. Затем он возвращает атрибуты для этого свойства и сохраняет их в переменной атрибутов.

Затем в примере выводится значение по умолчанию, извлекая DefaultValueAttribute его из AttributeCollectionконсоли и записывая его имя на экран консоли.

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

/* Prints the default value by retrieving the DefaultValueAttribute 
      * from the AttributeCollection. */
DefaultValueAttribute^ myAttribute = dynamic_cast<DefaultValueAttribute^>(attributes[ DefaultValueAttribute::typeid ]);
Console::WriteLine( "The default value is: {0}", myAttribute->Value );

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

/* Prints the default value by retrieving the DefaultValueAttribute
 * from the AttributeCollection. */
DefaultValueAttribute myAttribute =
    (DefaultValueAttribute)attributes[typeof(DefaultValueAttribute)];
Console.WriteLine("The default value is: " + myAttribute.Value.ToString());

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

' Prints the default value by retrieving the DefaultValueAttribute
' from the AttributeCollection. 
Dim myAttribute As DefaultValueAttribute =
        CType(attributes(GetType(DefaultValueAttribute)), DefaultValueAttribute)
Console.WriteLine(("The default value is: " & myAttribute.Value.ToString()))

Комментарии

Вы можете создать любое DefaultValueAttribute значение. Значение по умолчанию члена обычно является его начальным значением. Визуальный конструктор может использовать значение по умолчанию для сброса значения элемента. Генераторы кода также могут использовать значения по умолчанию, чтобы определить, следует ли создавать код для элемента.

Note

Элемент DefaultValueAttribute не будет автоматически инициализирован со значением атрибута. Необходимо задать начальное значение в коде.

Дополнительные сведения см. в разделе Атрибуты.

Конструкторы

Имя	Описание
DefaultValueAttribute(Boolean)	Инициализирует новый экземпляр DefaultValueAttribute класса с помощью Boolean значения.
DefaultValueAttribute(Byte)	Инициализирует новый экземпляр класса с помощью 8-разрядного целого DefaultValueAttribute числа без знака.
DefaultValueAttribute(Char)	Инициализирует новый экземпляр DefaultValueAttribute класса с помощью символа Юникода.
DefaultValueAttribute(Double)	Инициализирует новый экземпляр DefaultValueAttribute класса с помощью числа с плавающей запятой двойной точности.
DefaultValueAttribute(Int16)	Инициализирует новый экземпляр класса с помощью 16-разрядного целого DefaultValueAttribute числа со знаком.
DefaultValueAttribute(Int32)	Инициализирует новый экземпляр класса с помощью 32-разрядного целого DefaultValueAttribute числа со знаком.
DefaultValueAttribute(Int64)	Инициализирует новый экземпляр класса с помощью 64-разрядного целого DefaultValueAttribute числа со знаком.
DefaultValueAttribute(Object)	Инициализирует новый экземпляр класса DefaultValueAttribute.
DefaultValueAttribute(SByte)	Инициализирует новый экземпляр DefaultValueAttribute класса с помощью SByte значения.
DefaultValueAttribute(Single)	Инициализирует новый экземпляр DefaultValueAttribute класса с помощью числа с плавающей запятой с одной точностью.
DefaultValueAttribute(String)	Инициализирует новый экземпляр DefaultValueAttribute класса с помощью .String
DefaultValueAttribute(Type, String)	Инициализирует новый экземпляр DefaultValueAttribute класса, преобразуя указанное значение в указанный тип и используя инвариантный язык и региональные параметры в качестве контекста перевода.
DefaultValueAttribute(UInt16)	Инициализирует новый экземпляр DefaultValueAttribute класса с помощью UInt16 значения.
DefaultValueAttribute(UInt32)	Инициализирует новый экземпляр DefaultValueAttribute класса с помощью UInt32 значения.
DefaultValueAttribute(UInt64)	Инициализирует новый экземпляр DefaultValueAttribute класса с помощью UInt64 значения.

Свойства

Имя	Описание
TypeId	При реализации в производном классе получает уникальный идентификатор для этого Attribute. (Унаследовано от Attribute)
Value	Возвращает значение по умолчанию свойства, к которым привязан этот атрибут.

Методы

Имя	Описание
Equals(Object)	Возвращает значение, равное ли заданному объекту текущее DefaultValueAttributeзначение.
GetHashCode()	Возвращает хэш-код для этого экземпляра.
GetType()	Возвращает Type текущего экземпляра. (Унаследовано от Object)
IsDefaultAttribute()	При переопределении в производном классе указывает, является ли значение этого экземпляра значением по умолчанию для производного класса. (Унаследовано от Attribute)
Match(Object)	При переопределении в производном классе возвращает значение, указывающее, равен ли этот экземпляр указанному объекту. (Унаследовано от Attribute)
MemberwiseClone()	Создает неглубокую копию текущей Object. (Унаследовано от Object)
SetValue(Object)	Задает значение по умолчанию для свойства, к которому привязан этот атрибут.
ToString()	Возвращает строку, представляющую текущий объект. (Унаследовано от Object)

См. также раздел

• Attribute
• PropertyDescriptor