AmbientValueAttribute Classe

Definição

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

Herança

Object

Attribute

AmbientValueAttribute

Atributos

AttributeUsageAttribute

Exemplos

O exemplo de código a seguir demonstra o uso AmbientValueAttribute para impor o comportamento ambiente para uma propriedade chamada AlertForeColor. Para obter uma listagem de código completa, consulte Como aplicar atributos em controles do 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

Comentários

Se uma propriedade em um controle tiver um comportamento ambiente, esse atributo deverá estar presente. As propriedades de ambiente consultam seu pai quanto ao seu valor, por exemplo, uma Control.Font propriedade ou uma Control.BackColor propriedade.

Normalmente, um designer visual usa o AmbientValueAttribute atributo para decidir qual valor persistir para uma propriedade. Geralmente, esse é um valor que faz com que a propriedade obtenha seu valor de outra fonte. Um exemplo de um valor ambiente é Color.Empty como o valor ambiente da BackColor propriedade. Se você tiver um controle em um formulário e a BackColor propriedade do controle for definida como uma cor BackColor diferente da propriedade do formulário, você poderá redefinir a BackColor propriedade do controle para a do formulário definindo o BackColor controle como Color.Empty.