AmbientValueAttribute Clase

Definición

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

Herencia

Object

Attribute

AmbientValueAttribute

Atributos

AttributeUsageAttribute

Ejemplos

En el ejemplo de código siguiente se muestra cómo usar AmbientValueAttribute para aplicar el comportamiento ambiental de una propiedad denominada AlertForeColor. Para obtener una lista de código completa, vea 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

Comentarios

Si una propiedad de un control tiene un comportamiento ambiente, este atributo debe estar presente. Las propiedades ambientales consultan a su elemento primario su valor, por ejemplo, una Control.Font propiedad o una Control.BackColor propiedad .

Normalmente, un diseñador visual usa el AmbientValueAttribute atributo para decidir qué valor conservar para una propiedad. Suele ser un valor que hace que la propiedad obtenga su valor de otro origen. Un ejemplo de un valor ambiente es Color.Empty como el valor ambiente de la BackColor propiedad . Si tiene un control en un formulario y la BackColor propiedad del control se establece en un color diferente al de la BackColor propiedad del formulario, puede restablecer la BackColor propiedad del control a la del formulario estableciendo el BackColor del control Color.Emptyen .

Constructores

Propiedades

Métodos

Implementaciones de interfaz explícitas

Se aplica a