DefaultValueAttribute Класс

Определение

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

System.ComponentModel

Сборка:

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;
      }
   }

private bool _myVal = false;

[DefaultValue(false)]
public bool MyProperty
{
    get
    {
        return _myVal;
    }
    set
    {
        _myVal = value;
    }
}

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 . Значение по умолчанию элемента обычно является его начальным значением. Визуальный конструктор может использовать значение по умолчанию для сброса значения элемента. Генераторы кода могут также использовать значения по умолчанию, чтобы определить, следует ли создавать код для элемента.

Примечание

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

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

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

DefaultValueAttribute(Boolean)	Инициализирует новый экземпляр класса DefaultValueAttribute, используя указанное значение Boolean.
DefaultValueAttribute(Byte)	Инициализирует новый экземпляр класса DefaultValueAttribute, используя указанное 8-разрядное целое число без знака.
DefaultValueAttribute(Char)	Инициализирует новый экземпляр класса DefaultValueAttribute, используя указанный знак Юникода.
DefaultValueAttribute(Double)	Инициализирует новый экземпляр класса DefaultValueAttribute, используя указанное число с плавающей запятой с удвоенной точностью.
DefaultValueAttribute(Int16)	Инициализирует новый экземпляр класса DefaultValueAttribute, используя указанное 16-разрядное целое число со знаком.
DefaultValueAttribute(Int32)	Инициализирует новый экземпляр класса DefaultValueAttribute, используя указанное 32-разрядное целое число со знаком.
DefaultValueAttribute(Int64)	Инициализирует новый экземпляр класса DefaultValueAttribute, используя указанное 64-разрядное целое число со знаком.
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