AmbientValueAttribute Constructor (Type, String)

AmbientValueAttribute Constructor (Type, String)


Initializes a new instance of the AmbientValueAttribute class, given the value and its type.

Namespace:   System.ComponentModel
Assembly:  System (in System.dll)

public AmbientValueAttribute(
	Type type,
	string value


Type: System.Type

The Type of the value parameter.

Type: System.String

The value for this attribute.

The following code example demonstrates using AmbientValueAttribute to enforce ambient behavior for a property called AlertForeColor. For a full code listing, see How to: Apply Attributes in Windows Forms Controls.

[AmbientValue(typeof(Color), "Empty")]
[DefaultValue(typeof(Color), "White")]
[Description("The color used for painting alert text.")]
public Color AlertForeColor
        if (this.alertForeColorValue == Color.Empty &&
            this.Parent != null)
            return Parent.ForeColor;

        return this.alertForeColorValue;

        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);

.NET Framework
Available since 1.1
Return to top
© 2015 Microsoft