Attribute.IsDefaultAttribute 方法

定義

命名空間:

System

組件:

netstandard.dll, System.Runtime.dll

來源:

Attribute.cs

在衍生類別中覆寫時，表示這個執行個體的值是衍生類別的預設值。

C#

public virtual bool IsDefaultAttribute();

傳回

Boolean

如果這個執行個體為預設屬性的類別，則為 true；否則為 false。

範例

下列程式碼範例說明 如何使用 IsDefaultAttribute 。

C#

using System;
using System.Reflection;

namespace DefAttrCS
{
    // An enumeration of animals. Start at 1 (0 = uninitialized).
    public enum Animal
    {
        // Pets.
        Dog = 1,
        Cat,
        Bird,
    }

    // A custom attribute to allow a target to have a pet.
    public class AnimalTypeAttribute : Attribute
    {
        // The constructor is called when the attribute is set.
        public AnimalTypeAttribute(Animal pet)
        {
            thePet = pet;
        }

        // Provide a default constructor and make Dog the default.
        public AnimalTypeAttribute()
        {
            thePet = Animal.Dog;
        }

        // Keep a variable internally ...
        protected Animal thePet;

        // .. and show a copy to the outside world.
        public Animal Pet
        {
            get { return thePet; }
            set { thePet = Pet; }
        }

        // Override IsDefaultAttribute to return the correct response.
        public override bool IsDefaultAttribute()
        {
            if (thePet == Animal.Dog)
                return true;

            return false;
        }
    }

    public class TestClass
    {
        // Use the default constructor.
        [AnimalType]
        public void Method1()
        {}
    }

    class DemoClass
    {
        static void Main(string[] args)
        {
            // Get the class type to access its metadata.
            Type clsType = typeof(TestClass);
            // Get type information for the method.
            MethodInfo mInfo = clsType.GetMethod("Method1");
            // Get the AnimalType attribute for the method.
            AnimalTypeAttribute atAttr =
                (AnimalTypeAttribute)Attribute.GetCustomAttribute(mInfo,
                typeof(AnimalTypeAttribute));
            // Check to see if the default attribute is applied.
            Console.WriteLine("The attribute {0} for method {1} in class {2}",
                atAttr.Pet, mInfo.Name, clsType.Name);
            Console.WriteLine("{0} the default for the AnimalType attribute.",
                atAttr.IsDefaultAttribute() ? "is" : "is not");
        }
    }
}

備註

這個類別的預設實作會傳 false 回 ，而且必須在衍生類別中實作，才能對該類別很有用。

衍生類別中這個方法的實作會比較這個實例的值與標準預設值，然後傳回 Boolean 值，指出這個實例的值是否等於標準值。 標準值通常會編碼為實作中的常數，或以程式設計方式儲存在實作所使用的欄位中。

適用於