AmbientValueAttribute Classe

Définition

Spécifie la valeur à passer à une propriété pour que celle-ci obtienne sa valeur à partir d’une autre source.Specifies the value to pass to a property to cause the property to get its value from another source. On appelle cela l’ambiance.This is known as ambience. Cette classe ne peut pas être héritée.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
Héritage
AmbientValueAttribute
Attributs

Exemples

L’exemple de code suivant illustre AmbientValueAttribute l’utilisation de pour appliquer le comportement ambiant AlertForeColorpour une propriété appelée.The following code example demonstrates using AmbientValueAttribute to enforce ambient behavior for a property called AlertForeColor. Pour obtenir une liste complète du code , consultez Procédure: Appliquez des attributs dans lescontrôles 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

Remarques

Si une propriété sur un contrôle a un comportement ambiant, cet attribut doit être présent.If a property on a control has ambient behavior, this attribute must be present. Les propriétés ambiantes interrogent leur parent pour leur valeur, par Control.Font exemple, une Control.BackColor propriété ou une propriété.Ambient properties query their parent for their value, for example, a Control.Font property or a Control.BackColor property.

En général, un concepteur visuel utilise AmbientValueAttribute l’attribut pour déterminer la valeur à rendre persistante pour une propriété.Typically, a visual designer uses the AmbientValueAttribute attribute to decide which value to persist for a property. Il s’agit généralement d’une valeur qui amène la propriété à obtenir sa valeur d’une autre source.This is usually a value that causes the property to get its value from another source. La valeur ambiante pour la Color.Empty BackColor propriété est un exemple de valeur ambiante.An example of an ambient value is Color.Empty as the ambient value for the BackColor property. Si vous avez un contrôle sur un formulaire et que BackColor la propriété du contrôle est définie sur une couleur BackColor différente de celle de la propriété du formulaire, vous pouvez réinitialiser BackColor la propriété du contrôle sur celle du formulaire en définissant le BackColor du contrôle à 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.

Constructeurs

AmbientValueAttribute(Boolean)

Initialise une nouvelle instance de la classe AmbientValueAttribute avec une valeur Boolean comme valeur.Initializes a new instance of the AmbientValueAttribute class, given a Boolean value for its value.

AmbientValueAttribute(Byte)

Initialise une nouvelle instance de la classe AmbientValueAttribute avec un entier non signé 8 bits comme valeur.Initializes a new instance of the AmbientValueAttribute class, given an 8-bit unsigned integer for its value.

AmbientValueAttribute(Char)

Initialise une nouvelle instance de la classe AmbientValueAttribute avec un caractère Unicode comme valeur.Initializes a new instance of the AmbientValueAttribute class, given a Unicode character for its value.

AmbientValueAttribute(Double)

Initialise une nouvelle instance de la classe AmbientValueAttribute avec un nombre à virgule flottante double précision comme valeur.Initializes a new instance of the AmbientValueAttribute class, given a double-precision floating-point number for its value.

AmbientValueAttribute(Int16)

Initialise une nouvelle instance de la classe AmbientValueAttribute avec un entier signé 16 bits comme valeur.Initializes a new instance of the AmbientValueAttribute class, given a 16-bit signed integer for its value.

AmbientValueAttribute(Int32)

Initialise une nouvelle instance de la classe AmbientValueAttribute avec un entier signé 32 bits comme valeur.Initializes a new instance of the AmbientValueAttribute class, given a 32-bit signed integer for its value.

AmbientValueAttribute(Int64)

Initialise une nouvelle instance de la classe AmbientValueAttribute avec un entier signé 64 bits comme valeur.Initializes a new instance of the AmbientValueAttribute class, given a 64-bit signed integer for its value.

AmbientValueAttribute(Object)

Initialise une nouvelle instance de la classe AmbientValueAttribute avec un objet comme valeur.Initializes a new instance of the AmbientValueAttribute class, given an object for its value.

AmbientValueAttribute(Single)

Initialise une nouvelle instance de la classe AmbientValueAttribute avec un nombre à virgule flottante simple précision comme valeur.Initializes a new instance of the AmbientValueAttribute class, given a single-precision floating point number for its value.

AmbientValueAttribute(String)

Initialise une nouvelle instance de la classe AmbientValueAttribute avec une chaîne comme valeur.Initializes a new instance of the AmbientValueAttribute class, given a string for its value.

AmbientValueAttribute(Type, String)

Initialise une nouvelle instance de la classe AmbientValueAttribute avec sa valeur et son type.Initializes a new instance of the AmbientValueAttribute class, given the value and its type.

Propriétés

TypeId

Lors de l'implémentation dans une classe dérivée, obtient un identificateur unique pour l'objet Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Hérité de Attribute)
Value

Obtient l'objet qui est la valeur de ce AmbientValueAttribute.Gets the object that is the value of this AmbientValueAttribute.

Méthodes

Equals(Object)

Détermine si l'objet AmbientValueAttribute spécifié est égal à l'objet AmbientValueAttribute actuel.Determines whether the specified AmbientValueAttribute is equal to the current AmbientValueAttribute.

GetHashCode()

Retourne le code de hachage de cette instance.Returns the hash code for this instance.

GetType()

Obtient le Type de l'instance actuelle.Gets the Type of the current instance.

(Hérité de Object)
IsDefaultAttribute()

En cas de substitution dans une classe dérivée, indique si la valeur de cette instance est la valeur par défaut pour la classe dérivée.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Hérité de Attribute)
Match(Object)

En cas de substitution dans une classe dérivée, retourne une valeur indiquant si cette instance équivaut à un objet spécifié.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Hérité de Attribute)
MemberwiseClone()

Crée une copie superficielle de l'objet Object actuel.Creates a shallow copy of the current Object.

(Hérité de Object)
ToString()

Retourne une chaîne qui représente l'objet actuel.Returns a string that represents the current object.

(Hérité de Object)

Implémentations d’interfaces explicites

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

Mappe un jeu de noms avec un jeu correspondant d'identificateurs de dispatch.Maps a set of names to a corresponding set of dispatch identifiers.

(Hérité de Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Récupère les informations de type pour un objet, qui peuvent être utilisées pour obtenir les informations de type d'une interface.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Hérité de Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Récupère le nombre d'interfaces d'informations de type fourni par un objet (0 ou 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Hérité de Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Fournit l'accès aux propriétés et aux méthodes exposées par un objet.Provides access to properties and methods exposed by an object.

(Hérité de Attribute)

S’applique à