AmbientValueAttribute AmbientValueAttribute AmbientValueAttribute AmbientValueAttribute Class

Definition

Gibt den an eine Eigenschaft zu übergebenden Wert an, durch den die Eigenschaft ihren Wert von einer anderen Quelle bezieht.Specifies the value to pass to a property to cause the property to get its value from another source. Dies wird als Umgebung bezeichnet.This is known as ambience. Diese Klasse kann nicht vererbt werden.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
Vererbung
AmbientValueAttributeAmbientValueAttributeAmbientValueAttributeAmbientValueAttribute
Attribute

Beispiele

Im folgenden Codebeispiel wird die AmbientValueAttribute Verwendung von zum Erzwingen des Ambient-Verhaltens AlertForeColorfür eine Eigenschaft mit dem Namen veranschaulicht.The following code example demonstrates using AmbientValueAttribute to enforce ambient behavior for a property called AlertForeColor. Eine vollständige Code Auflistung finden Sie unter Gewusst wie: Anwenden von Attributen in Windows Forms-Steuerelementen.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

Hinweise

Wenn eine Eigenschaft für ein Steuerelement Ambient-Verhalten aufweist, muss dieses Attribut vorhanden sein.If a property on a control has ambient behavior, this attribute must be present. Ambient-Eigenschaften Fragen Ihr übergeordnetes Element nach dem Wert ab, Control.Font z. b Control.BackColor . eine Eigenschaft oder eine Eigenschaft.Ambient properties query their parent for their value, for example, a Control.Font property or a Control.BackColor property.

In der Regel verwendet ein visueller Designer AmbientValueAttribute das-Attribut, um zu entscheiden, welcher Wert für eine Eigenschaft beibehalten werden soll.Typically, a visual designer uses the AmbientValueAttribute attribute to decide which value to persist for a property. Dies ist normalerweise ein Wert, der bewirkt, dass die-Eigenschaft den Wert aus einer anderen Quelle erhält.This is usually a value that causes the property to get its value from another source. Ein Beispiel für einen Ambient-Wert Color.Empty ist der Ambient-Wert für BackColor die-Eigenschaft.An example of an ambient value is Color.Empty as the ambient value for the BackColor property. Wenn Sie ein-Steuerelement in einem Formular haben BackColor und die-Eigenschaft des-Steuer Elements auf eine andere Farbe BackColor als die-Eigenschaft des Formulars festgelegt ist BackColor , können Sie die-Eigenschaft des-Steuer Elements auf die BackColor des Formulars zurücksetzen, indem Sie die der Steuerelement Color.Emptyan.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.

Konstruktoren

AmbientValueAttribute(Boolean) AmbientValueAttribute(Boolean) AmbientValueAttribute(Boolean) AmbientValueAttribute(Boolean)

Initialisiert eine neue Instanz der AmbientValueAttribute-Klasse, sofern für ihren Wert ein boolescher Wert angegeben ist.Initializes a new instance of the AmbientValueAttribute class, given a Boolean value for its value.

AmbientValueAttribute(Byte) AmbientValueAttribute(Byte) AmbientValueAttribute(Byte) AmbientValueAttribute(Byte)

Initialisiert eine neue Instanz der AmbientValueAttribute-Klasse, sofern für ihren Wert eine vorzeichenlose 8-Bit-Ganzzahl angegeben ist.Initializes a new instance of the AmbientValueAttribute class, given an 8-bit unsigned integer for its value.

AmbientValueAttribute(Char) AmbientValueAttribute(Char) AmbientValueAttribute(Char) AmbientValueAttribute(Char)

Initialisiert eine neue Instanz der AmbientValueAttribute-Klasse, sofern für ihren Wert ein Unicode-Zeichen angegeben ist.Initializes a new instance of the AmbientValueAttribute class, given a Unicode character for its value.

AmbientValueAttribute(Double) AmbientValueAttribute(Double) AmbientValueAttribute(Double) AmbientValueAttribute(Double)

Initialisiert eine neue Instanz der AmbientValueAttribute-Klasse, sofern für ihren Wert eine Gleitkommazahl mit doppelter Genauigkeit angegeben ist.Initializes a new instance of the AmbientValueAttribute class, given a double-precision floating-point number for its value.

AmbientValueAttribute(Int16) AmbientValueAttribute(Int16) AmbientValueAttribute(Int16) AmbientValueAttribute(Int16)

Initialisiert eine neue Instanz der AmbientValueAttribute-Klasse, sofern für ihren Wert eine 16-Bit-Ganzzahl mit Vorzeichen angegeben ist.Initializes a new instance of the AmbientValueAttribute class, given a 16-bit signed integer for its value.

AmbientValueAttribute(Int32) AmbientValueAttribute(Int32) AmbientValueAttribute(Int32) AmbientValueAttribute(Int32)

Initialisiert eine neue Instanz der AmbientValueAttribute-Klasse, sofern für ihren Wert eine 32-Bit-Ganzzahl mit Vorzeichen angegeben ist.Initializes a new instance of the AmbientValueAttribute class, given a 32-bit signed integer for its value.

AmbientValueAttribute(Int64) AmbientValueAttribute(Int64) AmbientValueAttribute(Int64) AmbientValueAttribute(Int64)

Initialisiert eine neue Instanz der AmbientValueAttribute-Klasse, sofern für ihren Wert eine 64-Bit-Ganzzahl mit Vorzeichen angegeben ist.Initializes a new instance of the AmbientValueAttribute class, given a 64-bit signed integer for its value.

AmbientValueAttribute(Object) AmbientValueAttribute(Object) AmbientValueAttribute(Object) AmbientValueAttribute(Object)

Initialisiert eine neue Instanz der AmbientValueAttribute-Klasse, sofern für ihren Wert ein Objekt angegeben ist.Initializes a new instance of the AmbientValueAttribute class, given an object for its value.

AmbientValueAttribute(Single) AmbientValueAttribute(Single) AmbientValueAttribute(Single) AmbientValueAttribute(Single)

Initialisiert eine neue Instanz der AmbientValueAttribute-Klasse, sofern für ihren Wert eine Gleitkommazahl mit einfacher Genauigkeit angegeben ist.Initializes a new instance of the AmbientValueAttribute class, given a single-precision floating point number for its value.

AmbientValueAttribute(String) AmbientValueAttribute(String) AmbientValueAttribute(String) AmbientValueAttribute(String)

Initialisiert eine neue Instanz der AmbientValueAttribute-Klasse, sofern für ihren Wert eine Zeichenfolge angegeben ist.Initializes a new instance of the AmbientValueAttribute class, given a string for its value.

AmbientValueAttribute(Type, String) AmbientValueAttribute(Type, String) AmbientValueAttribute(Type, String) AmbientValueAttribute(Type, String)

Initialisiert eine neue Instanz der AmbientValueAttribute-Klasse, sofern der Wert und dessen Typ angegeben sind.Initializes a new instance of the AmbientValueAttribute class, given the value and its type.

Eigenschaften

TypeId TypeId TypeId TypeId

Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab.When implemented in a derived class, gets a unique identifier for this Attribute.

(Inherited from Attribute)
Value Value Value Value

Ruft das Objekt ab, das der Wert dieses AmbientValueAttribute ist.Gets the object that is the value of this AmbientValueAttribute.

Methoden

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Bestimmt, ob das angegebene AmbientValueAttribute und das aktuelle AmbientValueAttribute gleich sind.Determines whether the specified AmbientValueAttribute is equal to the current AmbientValueAttribute.

GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Gibt den Hashcode für diese Instanz zurück.Returns the hash code for this instance.

GetType() GetType() GetType() GetType()

Ruft den Type der aktuellen Instanz ab.Gets the Type of the current instance.

(Inherited from Object)
IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute() IsDefaultAttribute()

Gibt beim Überschreiben in einer abgeleiteten Klasse an, ob der Wert der Instanz der Standardwert für die abgeleitete Klasse ist.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Inherited from Attribute)
Match(Object) Match(Object) Match(Object) Match(Object)

Beim Überschreiben in einer abgeleiteten Klasse wird ein Wert zurückgegeben, der angibt, ob diese Instanz einem bestimmten Objekt entspricht.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Inherited from Attribute)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.Returns a string that represents the current object.

(Inherited from Object)

Explizite Schnittstellenimplementierungen

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

Ordnet eine Reihe von Namen einer entsprechenden Reihe von Dispatchbezeichnern zu.Maps a set of names to a corresponding set of dispatch identifiers.

(Inherited from Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr) _Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Ruft die Typinformationen für ein Objekt ab, mit deren Hilfe die Typinformationen für eine Schnittstelle abgerufen werden können.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Inherited from Attribute)
_Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32) _Attribute.GetTypeInfoCount(UInt32)

Ruft die Anzahl der Schnittstellen mit Typinformationen ab, die von einem Objekt bereitgestellt werden (0 oder 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Inherited from Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr) _Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Stellt den Zugriff auf von einem Objekt verfügbar gemachte Eigenschaften und Methoden bereit.Provides access to properties and methods exposed by an object.

(Inherited from Attribute)

Gilt für: