AmbientValueAttribute Classe

Définition

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

Héritage

Object

Attribute

AmbientValueAttribute

Attributs

AttributeUsageAttribute

Exemples

L’exemple de code suivant illustre l’utilisation AmbientValueAttribute de pour appliquer un comportement ambiant à une propriété appelée AlertForeColor. Pour obtenir une liste de code complète, consultez 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

Remarques

Si une propriété sur un contrôle a un comportement ambiant, cet attribut doit être présent. Les propriétés ambiantes interrogent leur parent pour leur valeur, par exemple une Control.Font propriété ou une Control.BackColor propriété.

En règle générale, un concepteur visuel utilise l’attribut AmbientValueAttribute pour déterminer la valeur à conserver pour une propriété. Il s’agit généralement d’une valeur qui amène la propriété à obtenir sa valeur à partir d’une autre source. Un exemple de valeur ambiante est Color.Empty la valeur ambiante de la BackColor propriété . Si vous avez un contrôle sur un formulaire et que la BackColor propriété du contrôle est définie sur une couleur différente de celle de la BackColor propriété du formulaire, vous pouvez réinitialiser la BackColor propriété du contrôle à celle du formulaire en affectant la valeur à Color.Emptyla BackColor propriété du contrôle .

Constructeurs

Propriétés

Méthodes

Implémentations d’interfaces explicites

S’applique à