Export (0) Print
Expand All

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)

'Declaration
Public Sub New ( _
	type As Type, _
	value As String _
)

Parameters

type
Type: System.Type

The Type of the value parameter.

value
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(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

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Show:
© 2015 Microsoft