DefaultValueAttribute Class

Definition

Указывает значение свойства по умолчанию.Specifies the default value for a property.

public ref class DefaultValueAttribute : Attribute
public ref class DefaultValueAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.All)]
public class DefaultValueAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.All)]
public sealed class DefaultValueAttribute : Attribute
type DefaultValueAttribute = class
    inherit Attribute
Public Class DefaultValueAttribute
Inherits Attribute
Public NotInheritable Class DefaultValueAttribute
Inherits Attribute
Inheritance
DefaultValueAttribute
Attributes

Examples

В следующем примере задается значение по умолчанию MyProperty равным false.The following example sets the default value of MyProperty to false.

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.The next example checks the default value of 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.

Затем пример выводит значение по умолчанию, получая DefaultValueAttribute из AttributeCollectionи записывая его имя на экран консоли.The example then prints the default value by retrieving the DefaultValueAttribute from the AttributeCollection, and writing its name to the console screen.

// 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()))

Remarks

Можно создать DefaultValueAttribute с любым значением.You can create a DefaultValueAttribute with any value. Значением по умолчанию для элемента обычно является его начальное значение.A member's default value is typically its initial value. Визуальный конструктор может использовать значение по умолчанию для сброса значения элемента.A visual designer can use the default value to reset the member's value. Генераторы кода могут также использовать значения по умолчанию, чтобы определить, следует ли создавать код для элемента.Code generators can use the default values also to determine whether code should be generated for the member.

Note

DefaultValueAttribute не приведет к автоматической инициализации элемента со значением атрибута.A DefaultValueAttribute will not cause a member to be automatically initialized with the attribute's value. Необходимо задать начальное значение в коде.You must set the initial value in your code.

Дополнительные сведения см. в разделе Атрибуты.For more information, see Attributes.

Constructors

DefaultValueAttribute(Boolean)

Инициализирует новый экземпляр класса DefaultValueAttribute, используя указанное значение Boolean.Initializes a new instance of the DefaultValueAttribute class using a Boolean value.

DefaultValueAttribute(Byte)

Инициализирует новый экземпляр класса DefaultValueAttribute, используя указанное 8-разрядное целое число без знака.Initializes a new instance of the DefaultValueAttribute class using an 8-bit unsigned integer.

DefaultValueAttribute(Char)

Инициализирует новый экземпляр класса DefaultValueAttribute, используя указанный знак Юникода.Initializes a new instance of the DefaultValueAttribute class using a Unicode character.

DefaultValueAttribute(Double)

Инициализирует новый экземпляр класса DefaultValueAttribute, используя указанное число с плавающей запятой с удвоенной точностью.Initializes a new instance of the DefaultValueAttribute class using a double-precision floating point number.

DefaultValueAttribute(Int16)

Инициализирует новый экземпляр класса DefaultValueAttribute, используя указанное 16-разрядное целое число со знаком.Initializes a new instance of the DefaultValueAttribute class using a 16-bit signed integer.

DefaultValueAttribute(Int32)

Инициализирует новый экземпляр класса DefaultValueAttribute, используя указанное 32-разрядное целое число со знаком.Initializes a new instance of the DefaultValueAttribute class using a 32-bit signed integer.

DefaultValueAttribute(Int64)

Инициализирует новый экземпляр класса DefaultValueAttribute, используя указанное 64-разрядное целое число со знаком.Initializes a new instance of the DefaultValueAttribute class using a 64-bit signed integer.

DefaultValueAttribute(Object)

Инициализирует новый экземпляр класса DefaultValueAttribute.Initializes a new instance of the DefaultValueAttribute class.

DefaultValueAttribute(SByte)

Инициализирует новый экземпляр класса DefaultValueAttribute, используя указанное значение SByte.Initializes a new instance of the DefaultValueAttribute class using a SByte value.

DefaultValueAttribute(Single)

Инициализирует новый экземпляр класса DefaultValueAttribute, используя указанное число с плавающей запятой с обычной точностью.Initializes a new instance of the DefaultValueAttribute class using a single-precision floating point number.

DefaultValueAttribute(String)

Инициализирует новый экземпляр класса DefaultValueAttribute, используя оператор String.Initializes a new instance of the DefaultValueAttribute class using a String.

DefaultValueAttribute(Type, String)

Инициализирует новый экземпляр класса DefaultValueAttribute, преобразуя при этом указанное значение к указанному типу. В качестве контекста перевода используется нейтральные настройки языка и региональных параметров.Initializes a new instance of the DefaultValueAttribute class, converting the specified value to the specified type, and using an invariant culture as the translation context.

DefaultValueAttribute(UInt16)

Инициализирует новый экземпляр класса DefaultValueAttribute, используя указанное значение UInt16.Initializes a new instance of the DefaultValueAttribute class using a UInt16 value.

DefaultValueAttribute(UInt32)

Инициализирует новый экземпляр класса DefaultValueAttribute, используя указанное значение UInt32.Initializes a new instance of the DefaultValueAttribute class using a UInt32 value.

DefaultValueAttribute(UInt64)

Инициализирует новый экземпляр класса DefaultValueAttribute, используя указанное значение UInt64.Initializes a new instance of the DefaultValueAttribute class using a UInt64 value.

Properties

TypeId

В случае реализации в производном классе возвращает уникальный идентификатор для этого атрибута Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)
Value

Возвращает значение по умолчанию для свойства, с которым связан этот атрибут.Gets the default value of the property this attribute is bound to.

Methods

Equals(Object)

Возвращает значение, показывающее, равно ли значение данного объекта текущему атрибуту DefaultValueAttribute.Returns whether the value of the given object is equal to the current DefaultValueAttribute.

GetHashCode()

Возвращает хэш-код для этого экземпляра.Returns the hash code for this instance.

GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute()

При переопределении в производном классе указывает, является ли значение этого экземпляра значением по умолчанию для производного класса.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Inherited from Attribute)
Match(Object)

При переопределении в производном классе возвращает значение, указывающее, является ли этот экземпляр равным заданному объекту.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Inherited from Object)

Explicit Interface Implementations

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

Сопоставляет набор имен соответствующему набору идентификаторов диспетчеризации.Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from 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.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Возвращает количество предоставляемых объектом интерфейсов для доступа к сведениям о типе (0 или 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Предоставляет доступ к открытым свойствам и методам объекта.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Applies to

See also