AmbientValueAttribute Klass

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

Arv

Object

Attribute

AmbientValueAttribute

Attribut

AttributeUsageAttribute

Exempel

Följande kodexempel visar hur du använder AmbientValueAttribute för att framtvinga omgivande beteende för en egenskap som heter AlertForeColor. En fullständig kodlista finns i 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

Kommentarer

Om en egenskap på en kontroll har omgivande beteende måste det här attributet finnas. Omgivande egenskaper frågar sin överordnade om värdet, till exempel en Control.Font egenskap eller en Control.BackColor egenskap.

Vanligtvis använder AmbientValueAttribute en visuell designer attributet för att bestämma vilket värde som ska sparas för en egenskap. Det här är vanligtvis ett värde som gör att egenskapen får sitt värde från en annan källa. Ett exempel på ett omgivande värde är Color.Empty som omgivande värde för BackColor egenskapen. Om du har en kontroll i ett formulär och BackColor kontrollens egenskap är inställd på en annan färg än BackColor formulärets egenskap, kan du återställa BackColor kontrollens egenskap till formulärets genom att ställa in BackColor kontrollen på Color.Empty.