This documentation is archived and is not being maintained.

Attribute.IsDefaultAttribute Method

When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.

Namespace:  System
Assembly:  mscorlib (in mscorlib.dll)

Public Overridable Function IsDefaultAttribute As Boolean
Dim instance As Attribute 
Dim returnValue As Boolean 

returnValue = instance.IsDefaultAttribute()

Return Value

Type: System.Boolean
true if this instance is the default attribute for the class; otherwise, false.

The default implementation of this class returns false, and must be implemented in the derived class to be useful to that class.

The implementation of this method in a derived class compares the value of this instance to a standard default value, then returns a Boolean value that indicates whether the value of this instance is equal to the standard value. The standard value is typically coded as a constant in the implementation, or stored programmatically in a field used by the implementation.

The following code example illustrates the use of IsDefaultAttribute.

Imports System
Imports System.Reflection

Module DemoModule

    ' An enumeration of animals. Start at 1 (0 = uninitialized). 
    Enum Animal
        ' Pets
        Dog = 1
    End Enum 

    ' Visual Basic requires that the AttributeUsage be specified. 
    ' A custom attribute to allow a target to have a pet.
    <AttributeUsage(AttributeTargets.Method)> _
    Public Class AnimalTypeAttribute
        Inherits Attribute

        ' The constructor is called when the attribute is set. 
        Public Sub New(ByVal animal As Animal)
            Me.thePet = animal
        End Sub 

        ' Provide a default constructor and make Dog the default. 
        Public Sub New()
            thePet = Animal.Dog
        End Sub 

        ' Keep a variable internally ... 
        Protected thePet As Animal

        ' .. and show a copy to the outside world. 
        Public Property Pet() As Animal
                Return thePet
            End Get 
            Set(ByVal Value As Animal)
                thePet = Value
            End Set 
        End Property 

        ' Override IsDefaultAttribute to return the correct response. 
        Public Overrides Function IsDefaultAttribute() As Boolean 
            If thePet = Animal.Dog Then 
                Return True 
                Return False 
            End If 
        End Function 

    End Class 

    Public Class TestClass
        ' Use the default constructor.
        <AnimalType()> _
        Public Sub Method1()
        End Sub 

    End Class 

    Sub Main()
        ' Get the class type to access its metadata. 
        Dim clsType As Type = GetType(TestClass)
        ' Get type information for the method. 
        Dim mInfo As MethodInfo = clsType.GetMethod("Method1")
        ' Get the AnimalType attribute for the method. 
        Dim attr As Attribute = Attribute.GetCustomAttribute(mInfo, _
        If Not attr Is Nothing And TypeOf attr Is AnimalTypeAttribute Then 
            ' Convert the attribute to the required type. 
            Dim atAttr As AnimalTypeAttribute = _
                CType(attr, AnimalTypeAttribute)
            Dim strDef As String 
            ' Check to see if the default attribute is applied. 
            If atAttr.IsDefaultAttribute() Then
                strDef = "is" 
                strDef = "is not" 
            End If 
            ' Display the result.
            Console.WriteLine("The attribute {0} for method {1} " & _
                    "in class {2}", atAttr.Pet.ToString(), mInfo.Name, _
            Console.WriteLine("{0} the default for the AnimalType " & _
                    "attribute.", strDef)
        End If 
    End Sub 
End Module

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0