AmbientValueAttribute Třída

Definice

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

Dědičnost

Object

Attribute

AmbientValueAttribute

Atributy

AttributeUsageAttribute

Příklady

Následující příklad kódu ukazuje použití AmbientValueAttribute k vynucení chování okolí pro vlastnost s názvem AlertForeColor. Úplný výpis kódu najdete v tématu Postupy: Použití atributů v ovládacích prvcích model Windows Forms.

[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

Poznámky

Pokud vlastnost ovládacího prvku má chování okolí, musí být tento atribut přítomen. Vlastnosti okolí se dotazují nadřazeného objektu Control.Font na jejich hodnotu, například vlastnost nebo Control.BackColor vlastnost.

Vizuální návrhář obvykle používá AmbientValueAttribute atribut k rozhodnutí, která hodnota se má zachovat pro vlastnost. Obvykle se jedná o hodnotu, která způsobí, že vlastnost získá svou hodnotu z jiného zdroje. Příkladem hodnoty okolí je Color.Empty hodnota okolí pro BackColor vlastnost. Pokud máte ovládací prvek ve formuláři a BackColor vlastnost ovládacího prvku je nastavená na jinou barvu než BackColor vlastnost formuláře, můžete vlastnost ovládacího prvku obnovit BackColor na vlastnost formuláře nastavením BackColor ovládacího prvku na Color.Emptyhodnotu .

Konstruktory

Vlastnosti

Metody

Explicitní implementace rozhraní

Platí pro