AmbientValueAttribute Classe

Definizione

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

Ereditarietà

Object

Attribute

AmbientValueAttribute

Attributi

AttributeUsageAttribute

Esempio

Nell'esempio di codice seguente viene illustrato l'uso AmbientValueAttribute di per applicare il comportamento di ambiente per una proprietà denominata AlertForeColor. Per un elenco di codice completo, vedere Procedura: Applicare attributi nei controlli Windows Form.

[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

Commenti

Se una proprietà di un controllo ha un comportamento di ambiente, questo attributo deve essere presente. Le proprietà di ambiente eseguono una query sul relativo valore padre, ad esempio una Control.Font proprietà o una Control.BackColor proprietà.

In genere, una finestra di progettazione visiva usa l'attributo AmbientValueAttribute per decidere quale valore rendere persistente per una proprietà. Si tratta in genere di un valore che fa sì che la proprietà ottenga il relativo valore da un'altra origine. Un esempio di valore di ambiente è Color.Empty il valore di ambiente per la BackColor proprietà . Se si dispone di un controllo in una maschera e la BackColor proprietà del controllo è impostata su un colore diverso rispetto BackColor alla proprietà della maschera, è possibile reimpostare la BackColor proprietà del controllo su quella della maschera impostando l'oggetto BackColor del controllo su Color.Empty.