AmbientValueAttribute Osztály

Definíció

Névtér:

System.ComponentModel

Szerelvények:

netstandard.dll, System.ComponentModel.TypeConverter.dll

Forrás:

AmbientValueAttribute.cs

Megadja a tulajdonságnak átadni kívánt értéket, amely miatt a tulajdonság egy másik forrásból szerzi be az értékét. Ezt nevezik hangulatnak. Ez az osztály nem örökölhető.

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

Öröklődés

Object

Attribute

AmbientValueAttribute

Attribútumok

AttributeUsageAttribute

Példák

Az alábbi példakód bemutatja, hogy a környezeti viselkedés kényszerítése egy úgynevezett tulajdonság esetében történik.a0> A teljes kódlistát a Az attribútumok alkalmazása Windows Forms vezérlőkben című témakörben talál.

[AmbientValue(typeof(Color), "Empty")]
[Category("Appearance")]
[DefaultValue(typeof(Color), "White")]
[Description("The color used for painting alert text.")]
public Color AlertForeColor
{
    get =>
        _alertForeColorValue == Color.Empty &&
        Parent != null
            ? Parent.ForeColor
            : _alertForeColorValue;

    set => _alertForeColorValue = value;
}

// This method is used by designers to enable resetting the
// property to its default value.
public void ResetAlertForeColor() =>
    AlertForeColor = s_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.
bool ShouldSerializeAlertForeColor() =>
    _alertForeColorValue != s_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

Megjegyzések

Ha egy vezérlő valamely tulajdonsága környezeti viselkedéssel rendelkezik, ennek az attribútumnak jelen kell lennie. A környezeti tulajdonságok lekérdezik a szülőjüket az értékükhöz, például egy Control.Font tulajdonsághoz vagy tulajdonsághoz Control.BackColor .

A vizualizációtervező általában az AmbientValueAttribute attribútum használatával dönti el, hogy melyik érték legyen megőrzve egy tulajdonsághoz. Ez általában olyan érték, amely miatt a tulajdonság egy másik forrásból szerzi be az értékét. A környezeti érték Color.Empty például a tulajdonság környezeti értéke BackColor . Ha egy űrlap vezérlőeleme van, és a BackColor vezérlőelem tulajdonsága az űrlap tulajdonságától BackColor eltérő színűre van állítva, a vezérlőelem BackColortulajdonságát visszaállíthatja BackColor az űrlaphozColor.Empty.

Konstruktorok

Name	Description
AmbientValueAttribute(Boolean)	Inicializálja az AmbientValueAttribute osztály új példányát, és logikai értéket ad az értékéhez.
AmbientValueAttribute(Byte)	Inicializálja az AmbientValueAttribute osztály új példányát, amelynek értéke 8 bites, aláíratlan egész szám.
AmbientValueAttribute(Char)	Inicializálja az AmbientValueAttribute osztály új példányát, és unicode karaktert ad az értékéhez.
AmbientValueAttribute(Double)	Inicializálja az AmbientValueAttribute osztály egy új példányát, és dupla pontosságú lebegőpontos számot ad meg az értékéhez.
AmbientValueAttribute(Int16)	Inicializálja az AmbientValueAttribute osztály új példányát, amelynek értéke 16 bites aláírt egész szám.
AmbientValueAttribute(Int32)	Inicializálja az AmbientValueAttribute osztály egy új példányát, amelynek értéke 32 bites aláírt egész szám.
AmbientValueAttribute(Int64)	Inicializálja az AmbientValueAttribute osztály egy új példányát, amelynek értéke 64 bites aláírt egész szám.
AmbientValueAttribute(Object)	Inicializálja az AmbientValueAttribute osztály egy új példányát, amely egy objektumot ad az értékéhez.
AmbientValueAttribute(Single)	Inicializálja az AmbientValueAttribute osztály egy új példányát, amely egy pontosságú lebegőpontos számot ad meg az értékéhez.
AmbientValueAttribute(String)	Inicializálja az AmbientValueAttribute osztály egy új példányát, amely egy sztringet ad az értékéhez.
AmbientValueAttribute(Type, String)	Inicializálja az AmbientValueAttribute osztály új példányát az érték és a típus alapján.

Tulajdonságok

Name	Description
TypeId	Ha származtatott osztályban implementálják, ehhez egy egyedi azonosítót Attributekap. (Öröklődés forrása Attribute)
Value	Lekéri az objektumot, amely ennek az értéknek AmbientValueAttributeaz értéke.

Metódusok

Name	Description
Equals(Object)	Meghatározza, hogy a megadott AmbientValueAttribute érték megegyezik-e az aktuális AmbientValueAttributeértékével.
GetHashCode()	A példány kivonatkódját adja vissza.
GetType()	Lekéri az Type aktuális példányt. (Öröklődés forrása Object)
IsDefaultAttribute()	Ha egy származtatott osztályban felül van bírálva, azt jelzi, hogy a példány értéke-e a származtatott osztály alapértelmezett értéke. (Öröklődés forrása Attribute)
Match(Object)	Származtatott osztály felülírásakor egy olyan értéket ad vissza, amely jelzi, hogy ez a példány egy adott objektummal egyenlő-e. (Öröklődés forrása Attribute)
MemberwiseClone()	Az aktuális Objectpéldány sekély másolatát hozza létre. (Öröklődés forrása Object)
ToString()	Az aktuális objektumot jelképező sztringet ad vissza. (Öröklődés forrása Object)