AmbientValueAttribute Clase

Definición

Especifica el valor para pasar a una propiedad que hace que esta obtenga su valor de otro origen.Specifies the value to pass to a property to cause the property to get its value from another source. Esto se conoce como ambiente.This is known as ambience. Esta clase no puede heredarse.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
Herencia
AmbientValueAttribute
Atributos

Ejemplos

En el ejemplo de código siguiente AmbientValueAttribute se muestra cómo usar para aplicar el comportamiento AlertForeColorambiente para una propiedad denominada.The following code example demonstrates using AmbientValueAttribute to enforce ambient behavior for a property called AlertForeColor. Para obtener una lista de código completa , consulte Cómo: Aplicar atributos en controlesde Windows Forms.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

Comentarios

Si una propiedad de un control tiene un comportamiento ambiente, este atributo debe estar presente.If a property on a control has ambient behavior, this attribute must be present. Las propiedades de ambiente consultan su valor primario, por ejemplo, Control.Font una propiedad o Control.BackColor una propiedad.Ambient properties query their parent for their value, for example, a Control.Font property or a Control.BackColor property.

Normalmente, un diseñador visual utiliza el AmbientValueAttribute atributo para decidir qué valor se va a conservar para una propiedad.Typically, a visual designer uses the AmbientValueAttribute attribute to decide which value to persist for a property. Suele ser un valor que hace que la propiedad obtenga su valor de otro origen.This is usually a value that causes the property to get its value from another source. Un ejemplo de un valor ambiente es Color.Empty como el valor ambiente de la BackColor propiedad.An example of an ambient value is Color.Empty as the ambient value for the BackColor property. Si tiene un control en BackColor un formulario y la 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 en Color.Empty.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.

Constructores

AmbientValueAttribute(Boolean)

Inicializa una nueva instancia de la clase AmbientValueAttribute, dado un valor booleano como valor.Initializes a new instance of the AmbientValueAttribute class, given a Boolean value for its value.

AmbientValueAttribute(Byte)

Inicializa una nueva instancia de la clase AmbientValueAttribute, dado un entero de 8 bits sin signo como valor.Initializes a new instance of the AmbientValueAttribute class, given an 8-bit unsigned integer for its value.

AmbientValueAttribute(Char)

Inicializa una nueva instancia de la clase AmbientValueAttribute, dado un carácter Unicode como valor.Initializes a new instance of the AmbientValueAttribute class, given a Unicode character for its value.

AmbientValueAttribute(Double)

Inicializa una nueva instancia de la clase AmbientValueAttribute, dado un número de punto flotante de precisión doble como valor.Initializes a new instance of the AmbientValueAttribute class, given a double-precision floating-point number for its value.

AmbientValueAttribute(Int16)

Inicializa una nueva instancia de la clase AmbientValueAttribute, dado un entero de 16 bits con signo como valor.Initializes a new instance of the AmbientValueAttribute class, given a 16-bit signed integer for its value.

AmbientValueAttribute(Int32)

Inicializa una nueva instancia de la clase AmbientValueAttribute, dado un entero de 32 bits con signo como valor.Initializes a new instance of the AmbientValueAttribute class, given a 32-bit signed integer for its value.

AmbientValueAttribute(Int64)

Inicializa una nueva instancia de la clase AmbientValueAttribute, dado un entero de 64 bits con signo como valor.Initializes a new instance of the AmbientValueAttribute class, given a 64-bit signed integer for its value.

AmbientValueAttribute(Object)

Inicializa una nueva instancia de la clase AmbientValueAttribute, dado un objeto como valor.Initializes a new instance of the AmbientValueAttribute class, given an object for its value.

AmbientValueAttribute(Single)

Inicializa una nueva instancia de la clase AmbientValueAttribute, dado un número de punto flotante de precisión sencilla como valor.Initializes a new instance of the AmbientValueAttribute class, given a single-precision floating point number for its value.

AmbientValueAttribute(String)

Inicializa una nueva instancia de la clase AmbientValueAttribute, dada una cadena como valor.Initializes a new instance of the AmbientValueAttribute class, given a string for its value.

AmbientValueAttribute(Type, String)

Inicializa una nueva instancia de la clase AmbientValueAttribute, dados el valor y su tipo.Initializes a new instance of the AmbientValueAttribute class, given the value and its type.

Propiedades

TypeId

Cuando se implementa en una clase derivada, obtiene un identificador único para este Attribute.When implemented in a derived class, gets a unique identifier for this Attribute.

(Heredado de Attribute)
Value

Obtiene el objeto que es el valor de AmbientValueAttribute.Gets the object that is the value of this AmbientValueAttribute.

Métodos

Equals(Object)

Determina si el objeto AmbientValueAttribute especificado es igual al objeto AmbientValueAttribute actual.Determines whether the specified AmbientValueAttribute is equal to the current AmbientValueAttribute.

GetHashCode()

Devuelve el código hash de esta instancia.Returns the hash code for this instance.

GetType()

Obtiene el Type de la instancia actual.Gets the Type of the current instance.

(Heredado de Object)
IsDefaultAttribute()

Si se reemplaza en una clase derivada, indica si el valor de esta instancia es el valor predeterminado de la clase derivada.When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

(Heredado de Attribute)
Match(Object)

Cuando se invalida en una clase derivada, devuelve un valor que indica si esta instancia es igual a un objeto especificado.When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(Heredado de Attribute)
MemberwiseClone()

Crea una copia superficial del Object actual.Creates a shallow copy of the current Object.

(Heredado de Object)
ToString()

Devuelve un valor de tipo string que representa el objeto actual.Returns a string that represents the current object.

(Heredado de Object)

Implementaciones de interfaz explícitas

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

Asigna un conjunto de nombres a un conjunto correspondiente de identificadores de envío.Maps a set of names to a corresponding set of dispatch identifiers.

(Heredado de Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

Obtiene la información de tipos de un objeto, que puede utilizarse para obtener la información de tipos de una interfaz.Retrieves the type information for an object, which can be used to get the type information for an interface.

(Heredado de Attribute)
_Attribute.GetTypeInfoCount(UInt32)

Recupera el número de interfaces de información de tipo que proporciona un objeto (0 ó 1).Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(Heredado de Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

Proporciona acceso a las propiedades y los métodos expuestos por un objeto.Provides access to properties and methods exposed by an object.

(Heredado de Attribute)

Se aplica a