AmbientValueAttribute Klasse

Definition

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

Vererbung

Object

Attribute

AmbientValueAttribute

Attribute

AttributeUsageAttribute

Beispiele

Das folgende Codebeispiel veranschaulicht die Verwendung des AmbientValueAttribute Umgebungsverhaltens für eine Eigenschaft, die aufgerufen wird AlertForeColor. Eine vollständige Codeauflistung finden Sie unter 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 =>
        _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

Hinweise

Wenn eine Eigenschaft eines Steuerelements ein Umgebungsverhalten aufweist, muss dieses Attribut vorhanden sein. Umgebungseigenschaften fragen das übergeordnete Element nach ihrem Wert ab, z. B. eine Control.Font Eigenschaft oder eine Control.BackColor Eigenschaft.

In der Regel verwendet ein visueller Designer das AmbientValueAttribute Attribut, um zu entscheiden, welcher Wert für eine Eigenschaft beibehalten werden soll. Dies ist in der Regel ein Wert, der bewirkt, dass die Eigenschaft ihren Wert aus einer anderen Quelle erhält. Ein Beispiel für einen Umgebungswert ist Color.Empty der Umgebungswert für die BackColor Eigenschaft. Wenn Sie über ein Steuerelement in einem Formular verfügen und die BackColor Eigenschaft des Steuerelements auf eine andere Farbe als die BackColor Eigenschaft des Formulars festgelegt ist, können Sie die BackColor Eigenschaft des Steuerelements auf die des Formulars zurücksetzen, indem Sie das BackColor Steuerelement auf Color.Empty".