AmbientValueAttribute Sınıf

Tanım

Ad Alanı:

System.ComponentModel

Bütünleştirilmiş Kod:

System.ComponentModel.TypeConverter.dll

Kaynak:

AmbientValueAttribute.cs

Özelliğin değerini başka bir kaynaktan almasına neden olmak için özelliğe geçirecek değeri belirtir. Bu ambiyans olarak bilinir. Bu sınıf devralınamaz.

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

Devralma

Object

Attribute

AmbientValueAttribute

Öznitelikler

AttributeUsageAttribute

Örnekler

Aşağıdaki kod örneğinde adlı AlertForeColorbir özellik için ortam davranışını zorlamak için kullanma AmbientValueAttribute gösterilmektedir. Tam kod listesi için bkz. Nasıl yapılır: Windows Forms Denetimlerinde Öznitelikleri Uygulama.

[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

Açıklamalar

Denetimdeki bir özelliğin ortam davranışı varsa, bu özniteliğin mevcut olması gerekir. Ortam özellikleri, üst öğelerini değerleri (örneğin, bir Control.Font özellik veya Control.BackColor özellik) için sorgular.

Genellikle, bir görsel tasarımcı özelliği için hangi değerin AmbientValueAttribute kalıcı hale gerektiğine karar vermek için özniteliğini kullanır. Bu genellikle özelliğin değerini başka bir kaynaktan almasına neden olan bir değerdir. Ortam değerinin bir örneği, Color.Empty özelliğin BackColor ortam değeridir. Formda bir denetiminiz varsa ve BackColor denetimin özelliği formun özelliğinden BackColor farklı bir renge ayarlanmışsa, denetimin özelliğini olarak ayarlayarak BackColor denetimin özelliğini formun özelliğine Color.EmptysıfırlayabilirsinizBackColor.

Oluşturucular

AmbientValueAttribute(Boolean)	Değeri için bir Boole değeri verilip sınıfının yeni bir örneğini AmbientValueAttribute başlatır.
AmbientValueAttribute(Byte)	Değeri için 8 bit işaretsiz bir tamsayı verildiğinde sınıfının yeni bir örneğini AmbientValueAttribute başlatır.
AmbientValueAttribute(Char)	Değeri için bir Unicode karakteri verilip sınıfının yeni bir örneğini AmbientValueAttribute başlatır.
AmbientValueAttribute(Double)	Değeri için çift duyarlıklı kayan AmbientValueAttribute nokta sayısı verilip sınıfın yeni bir örneğini başlatır.
AmbientValueAttribute(Int16)	Değeri için 16 bit imzalı bir tamsayı verilip sınıfın yeni bir örneğini AmbientValueAttribute başlatır.
AmbientValueAttribute(Int32)	Değeri için 32 bit imzalı bir tamsayı verilip sınıfın yeni bir örneğini AmbientValueAttribute başlatır.
AmbientValueAttribute(Int64)	Değeri için 64 bit imzalı bir tamsayı verilip sınıfın yeni bir örneğini AmbientValueAttribute başlatır.
AmbientValueAttribute(Object)	Değeri için bir nesne verilip sınıfının yeni bir örneğini AmbientValueAttribute başlatır.
AmbientValueAttribute(Single)	Değeri için tek duyarlıklı kayan AmbientValueAttribute nokta sayısı verilip sınıfın yeni bir örneğini başlatır.
AmbientValueAttribute(String)	Değeri için bir dize verilip sınıfının yeni bir örneğini AmbientValueAttribute başlatır.
AmbientValueAttribute(Type, String)	değeri ve türü göz önünde bulundurularak sınıfının yeni bir örneğini AmbientValueAttribute başlatır.

Özellikler

TypeId	Türetilmiş bir sınıfta uygulandığında, bu Attributeiçin benzersiz bir tanımlayıcı alır. (Devralındığı yer: Attribute)
Value	Bu AmbientValueAttributeöğesinin değeri olan nesnesini alır.

Yöntemler

Equals(Object)	Belirtilen AmbientValueAttribute öğesinin geçerli AmbientValueAttributeöğesine eşit olup olmadığını belirler.
GetHashCode()	Bu örneğe ilişkin karma kodu döndürür.
GetType()	Type Geçerli örneğini alır. (Devralındığı yer: Object)
IsDefaultAttribute()	Türetilmiş bir sınıfta geçersiz kılındığında, bu örneğin değerinin türetilmiş sınıf için varsayılan değer olup olmadığını gösterir. (Devralındığı yer: Attribute)
Match(Object)	Türetilmiş bir sınıfta geçersiz kılındığında, bu örneğin belirtilen bir nesneye eşit olup olmadığını gösteren bir değer döndürür. (Devralındığı yer: Attribute)
MemberwiseClone()	Geçerli Objectöğesinin sığ bir kopyasını oluşturur. (Devralındığı yer: Object)
ToString()	Geçerli nesneyi temsil eden dizeyi döndürür. (Devralındığı yer: Object)