AmbientValueAttribute Класс

Определение

public ref class AmbientValueAttribute sealed : Attribute

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

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

Public NotInheritable Class AmbientValueAttribute
Inherits Attribute

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

Object

Attribute

AmbientValueAttribute

Атрибуты

AttributeUsageAttribute

Примеры

В следующем примере кода демонстрируется применение AmbientValueAttribute внешнего поведения для вызываемого AlertForeColorсвойства. Полный список кода см. в разделе "Практическое руководство. Применение атрибутов в элементах управления Windows Forms".

[AmbientValue(typeof(Color), "Empty")]
[Category("Appearance")]
[DefaultValue(typeof(Color), "White")]
[Description("The color used for painting alert text.")]
public Color AlertForeColor
{
    get =>
        _alertForeColorValue == Color.Empty &&
        Parent != null
            ? Parent.ForeColor
            : _alertForeColorValue;

    set => _alertForeColorValue = value;
}

// This method is used by designers to enable resetting the
// property to its default value.
public void ResetAlertForeColor() =>
    AlertForeColor = s_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.
bool ShouldSerializeAlertForeColor() =>
    _alertForeColorValue != s_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

Комментарии

Если свойство элемента управления имеет внешнее поведение, этот атрибут должен присутствовать. Внешние свойства запрашивают родительское Control.Font значение, например свойство или Control.BackColor свойство.

Как правило, визуальный конструктор использует AmbientValueAttribute атрибут для выбора значения, которое следует сохранить для свойства. Обычно это значение, которое приводит к получению свойства из другого источника. Примером внешнего значения является Color.Empty значение среды для BackColor свойства. Если у вас есть элемент управления в форме, а BackColor свойство элемента управления имеет другой цвет, отличный BackColor от свойства формы, можно сбросить BackColor свойство элемента управления в форму, задав BackColor для элемента управления значение Color.Empty.