AmbientValueAttribute クラス

定義

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

継承

Object

Attribute

AmbientValueAttribute

属性

AttributeUsageAttribute

例

次のコード例では、 を使用 AmbientValueAttribute して、 という AlertForeColorプロパティにアンビエント動作を適用する方法を示します。 完全なコード一覧については、「方法: Windows フォーム コントロールで属性を適用する」を参照してください。

[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

注釈

コントロールのプロパティにアンビエント動作がある場合は、この属性が存在する必要があります。 アンビエント プロパティは、親の値 (プロパティやプロパティなど) に対して Control.Font クエリを Control.BackColor 実行します。

通常、ビジュアル デザイナーは 属性を AmbientValueAttribute 使用して、プロパティに保持する値を決定します。 これは通常、 プロパティが別のソースから値を取得する値です。 アンビエント値の例は、 Color.Empty プロパティのアンビエント値 BackColor です。 フォームにコントロールがあり、コントロールの BackColor プロパティがフォームの プロパティとは異なる色BackColorに設定されている場合は、コントロールの の を に設定BackColorすることで、コントロールの プロパティをフォームのプロパティにColor.EmptyリセットBackColorできます。

コンストラクター

プロパティ

メソッド

明示的なインターフェイスの実装

適用対象