AmbientValueAttribute AmbientValueAttribute AmbientValueAttribute AmbientValueAttribute Class

Определение

Указывает значение, которое нужно передать в свойство, чтобы свойство получило свое значение из другого источника.Specifies the value to pass to a property to cause the property to get its value from another source. Это называется окружением.This is known as ambience. Этот класс не наследуется.This class cannot be inherited.

public ref class AmbientValueAttribute sealed : Attribute
[System.AttributeUsage(System.AttributeTargets.All)]
public sealed class AmbientValueAttribute : Attribute
type AmbientValueAttribute = class
    inherit Attribute
Public NotInheritable Class AmbientValueAttribute
Inherits Attribute
Наследование
AmbientValueAttributeAmbientValueAttributeAmbientValueAttributeAmbientValueAttribute
Атрибуты

Примеры

В следующем примере кода показано использование AmbientValueAttribute для принудительного поведения окружения для свойства AlertForeColorс именем.The following code example demonstrates using AmbientValueAttribute to enforce ambient behavior for a property called AlertForeColor. Полный листинг кода см. в разделе как Применение атрибутов в элементахуправления Windows Forms.For a full code listing, see How to: Apply Attributes in Windows Forms Controls.

[AmbientValue(typeof(Color), "Empty")]
[Category("Appearance")]
[DefaultValue(typeof(Color), "White")]
[Description("The color used for painting alert text.")]
public Color AlertForeColor
{
    get
    {
        if (this.alertForeColorValue == Color.Empty &&
            this.Parent != null)
        {
            return Parent.ForeColor;
        }

        return this.alertForeColorValue;
    }

    set
    {
        this.alertForeColorValue = value;
    }
}

// This method is used by designers to enable resetting the
// property to its default value.
public void ResetAlertForeColor()
{
    this.AlertForeColor = AttributesDemoControl.defaultAlertForeColorValue;
}

// This method indicates to designers whether the property
// value is different from the ambient value, in which case
// the designer should persist the value.
private bool ShouldSerializeAlertForeColor()
{
    return (this.alertForeColorValue != AttributesDemoControl.ambientColorValue);
}
<AmbientValue(GetType(Color), "Empty"), _
Category("Appearance"), _
DefaultValue(GetType(Color), "White"), _
Description("The color used for painting alert text.")> _
Public Property AlertForeColor() As Color
    Get
        If Me.alertForeColorValue = Color.Empty AndAlso (Me.Parent IsNot Nothing) Then
            Return Parent.ForeColor
        End If

        Return Me.alertForeColorValue
    End Get

    Set(ByVal value As Color)
        Me.alertForeColorValue = value
    End Set
End Property

' This method is used by designers to enable resetting the
' property to its default value.
Public Sub ResetAlertForeColor()
    Me.AlertForeColor = AttributesDemoControl.defaultAlertForeColorValue
End Sub

' This method indicates to designers whether the property
' value is different from the ambient value, in which case
' the designer should persist the value.
Private Function ShouldSerializeAlertForeColor() As Boolean
    Return Me.alertForeColorValue <> AttributesDemoControl.ambientColorValue
End Function

Комментарии

Если свойство элемента управления имеет внешнее поведение, этот атрибут должен присутствовать.If a property on a control has ambient behavior, this attribute must be present. Свойства окружения запрашивают свой родительский элемент для их значения, Control.Font например свойства Control.BackColor или свойства.Ambient properties query their parent for their value, for example, a Control.Font property or a Control.BackColor property.

Как правило, визуальный конструктор использует AmbientValueAttribute атрибут, чтобы решить, какое значение следует сохранить для свойства.Typically, a visual designer uses the AmbientValueAttribute attribute to decide which value to persist for a property. Обычно это значение, которое заставляет свойство получить свое значение из другого источника.This is usually a value that causes the property to get its value from another source. Примером внешнего значения является Color.Empty значение окружения BackColor для свойства.An example of an ambient value is Color.Empty as the ambient value for the BackColor property. Если у вас есть элемент управления в форме, а BackColor свойство элемента управления имеет цвет BackColor , BackColor отличный от цвета свойства формы, можно сбросить свойство элемента управления BackColor в соответствии с формой, установив для свойства для Color.Emptyэлемента управления.If you have a control on a form and the BackColor property of the control is set to a different color than the BackColor property of the form, you can reset the BackColor property of the control to that of the form by setting the BackColor of the control to Color.Empty.

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

AmbientValueAttribute(Boolean) AmbientValueAttribute(Boolean) AmbientValueAttribute(Boolean) AmbientValueAttribute(Boolean)

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

AmbientValueAttribute(Byte) AmbientValueAttribute(Byte) AmbientValueAttribute(Byte) AmbientValueAttribute(Byte)

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

AmbientValueAttribute(Char) AmbientValueAttribute(Char) AmbientValueAttribute(Char) AmbientValueAttribute(Char)

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

AmbientValueAttribute(Double) AmbientValueAttribute(Double) AmbientValueAttribute(Double) AmbientValueAttribute(Double)

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

AmbientValueAttribute(Int16) AmbientValueAttribute(Int16) AmbientValueAttribute(Int16) AmbientValueAttribute(Int16)

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

AmbientValueAttribute(Int32) AmbientValueAttribute(Int32) AmbientValueAttribute(Int32) AmbientValueAttribute(Int32)

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

AmbientValueAttribute(Int64) AmbientValueAttribute(Int64) AmbientValueAttribute(Int64) AmbientValueAttribute(Int64)

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

AmbientValueAttribute(Object) AmbientValueAttribute(Object) AmbientValueAttribute(Object) AmbientValueAttribute(Object)

Инициализирует новый экземпляр класса AmbientValueAttribute, используя в качестве значения заданный объект.Initializes a new instance of the AmbientValueAttribute class, given an object for its value.

AmbientValueAttribute(Single) AmbientValueAttribute(Single) AmbientValueAttribute(Single) AmbientValueAttribute(Single)

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

AmbientValueAttribute(String) AmbientValueAttribute(String) AmbientValueAttribute(String) AmbientValueAttribute(String)

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

AmbientValueAttribute(Type, String) AmbientValueAttribute(Type, String) AmbientValueAttribute(Type, String) AmbientValueAttribute(Type, String)

Инициализирует новый экземпляр класса AmbientValueAttribute, используя заданные значение и тип.Initializes a new instance of the AmbientValueAttribute class, given the value and its type.

Свойства

TypeId TypeId TypeId TypeId

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

(Inherited from Attribute)
Value Value Value Value

Возвращает объект, который является значением этого атрибута AmbientValueAttribute.Gets the object that is the value of this AmbientValueAttribute.

Методы

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Определяет, равен ли указанный объект AmbientValueAttribute текущему объекту AmbientValueAttribute.Determines whether the specified AmbientValueAttribute is equal to the current AmbientValueAttribute.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

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

GetType() GetType() GetType() GetType()

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

(Inherited from Object)
IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute() 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) Match(Object) Match(Object) Match(Object)

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

(Inherited from Attribute)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

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

(Inherited from Object)
ToString() ToString() ToString() ToString()

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

(Inherited from Object)

Явные реализации интерфейса

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr) _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) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _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) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _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) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

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

(Inherited from Attribute)

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