Export (0) Print
Expand All

Attribute.TypeId Property

When implemented in a derived class, gets a unique identifier for this Attribute.

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

public virtual Object TypeId { get; }
/** @property */
public Object get_TypeId ()

public function get TypeId () : Object

Not applicable.

Property Value

An Object that is a unique identifier for the attribute.

As implemented, this identifier is merely the Type of the attribute. However, it is intended that the unique identifier be used to identify two attributes of the same type.

The following code example implements the TypeId property in a custom parameter Attribute class and shows its use.

// Example for the Attribute.TypeId property.
using System;
using System.Reflection;

namespace NDP_UE_CS 
{
    // Define a custom parameter attribute that takes a single message argument.
    [AttributeUsage( AttributeTargets.Parameter )]
    public class ArgumentUsageAttribute : Attribute
    {
        // The constructor saves the message and creates a unique identifier.
        public ArgumentUsageAttribute( string UsageMsg )
        {
            this.usageMsg = UsageMsg;
            this.instanceGUID = Guid.NewGuid( );
        }

        // This is storage for the attribute message and unique ID.
        protected string usageMsg;
        protected Guid instanceGUID;

        // This is the Message property for the attribute.
        public string Message
        {
            get { return usageMsg; }
            set { usageMsg = value; }
        }

        // Override TypeId to provide a unique identifier for the instance.
        public override object TypeId
        {
            get { return (object)instanceGUID; }
        }

        // Override ToString() to append the message to what the base generates.
        public override string ToString( )
        {
            return base.ToString( ) + ":" + usageMsg;
        }
    }

    public class TestClass 
    {
        // Assign an ArgumentUsage attribute to each parameter.
        // Assign a ParamArray attribute to strList using the params keyword.
        public void TestMethod(
            [ArgumentUsage("Must pass an array here.")]
            String[] strArray,
            [ArgumentUsage("Can pass a param list or array here.")]
            params String[] strList)
        { }
    }

    class AttributeTypeIdDemo 
    {
        static void ShowAttributeTypeIds( ) 
        {
            // Get the class type, and then get the MethodInfo object 
            // for TestMethod to access its metadata.
            Type clsType = typeof( TestClass );
            MethodInfo mInfo = clsType.GetMethod("TestMethod");

            // There will be two elements in pInfoArray, one for each parameter.
            ParameterInfo[] pInfoArray = mInfo.GetParameters();
            if (pInfoArray != null) 
            {
                // Create an instance of the param array attribute on strList.
                ParamArrayAttribute listArrayAttr = (ParamArrayAttribute)
                    Attribute.GetCustomAttribute( pInfoArray[1], 
                        typeof(ParamArrayAttribute) );

                // Create an instance of the argument usage attribute on strArray.
                ArgumentUsageAttribute arrayUsageAttr1 = (ArgumentUsageAttribute)
                    Attribute.GetCustomAttribute( pInfoArray[0], 
                        typeof(ArgumentUsageAttribute) );

                // Create another instance of the argument usage attribute 
                // on strArray.
                ArgumentUsageAttribute arrayUsageAttr2 = (ArgumentUsageAttribute)
                    Attribute.GetCustomAttribute( pInfoArray[0], 
                        typeof(ArgumentUsageAttribute) );

                // Create an instance of the argument usage attribute on strList.
                ArgumentUsageAttribute listUsageAttr = (ArgumentUsageAttribute)
                    Attribute.GetCustomAttribute( pInfoArray[1], 
                        typeof(ArgumentUsageAttribute) );

                // Display the attributes and corresponding TypeId values.
                Console.WriteLine( "\n\"{0}\" \nTypeId: {1}",
                    listArrayAttr.ToString(), listArrayAttr.TypeId );
                Console.WriteLine( "\n\"{0}\" \nTypeId: {1}",
                    arrayUsageAttr1.ToString(), arrayUsageAttr1.TypeId );
                Console.WriteLine( "\n\"{0}\" \nTypeId: {1}",
                    arrayUsageAttr2.ToString(), arrayUsageAttr2.TypeId );
                Console.WriteLine( "\n\"{0}\" \nTypeId: {1}",
                    listUsageAttr.ToString(), listUsageAttr.TypeId );
            }
            else
                Console.WriteLine( "The parameters information could " +
                    "not be retrieved for method {0}.", mInfo.Name );
        }

        static void Main( ) 
        {
            Console.WriteLine( 
                "This example of the Attribute.TypeId property\n" +
                "generates the following output." );
            Console.WriteLine( 
                "\nCreate instances from a derived Attribute " +
                "class that implements TypeId, \nand then " +
                "display the attributes and corresponding TypeId values:" );

            ShowAttributeTypeIds( );
        }
    }
}

/*
This example of the Attribute.TypeId property
generates the following output.

Create instances from a derived Attribute class that implements TypeId,
and then display the attributes and corresponding TypeId values:

"System.ParamArrayAttribute"
TypeId: System.ParamArrayAttribute

"NDP_UE_CS.ArgumentUsageAttribute:Must pass an array here."
TypeId: d03a23f4-2536-4478-920f-8b0426dec7f1

"NDP_UE_CS.ArgumentUsageAttribute:Must pass an array here."
TypeId: a1b412e8-3047-49fa-8d03-7660d37ef718

"NDP_UE_CS.ArgumentUsageAttribute:Can pass a param list or array here."
TypeId: 7ac2bf61-0327-48d6-a07e-eb9aaf3dd45e
*/

// Example for the Attribute.TypeId property.

package NDP_UE_JSL;

import System.*;
import System.Reflection.*;

// Define a custom parameter attribute that takes a single message argument.
/** @attribute AttributeUsage(AttributeTargets.Parameter)
 */
public class ArgumentUsageAttribute extends Attribute
{
    // The constructor saves the message and creates a unique identifier.
    public ArgumentUsageAttribute(String usgMsg)
    {
        this.usageMsg = usgMsg;
        this.instanceGUID = Guid.NewGuid();
    } //ArgumentUsageAttribute

    // This is storage for the attribute message and unique ID.
    protected String usageMsg;
    protected Guid instanceGUID;

    // This is the Message property for the attribute.
    /** @property 
     */
    public String get_Message()
    {
        return usageMsg;
    } //get_Message

    /** @property 
     */
    public void set_Message(String value)
    {
        usageMsg = value;
    } //set_Message

    // Override TypeId to provide a unique identifier for the instance.
    /** @property 
     */
    public Object get_TypeId()
    {
        return (Object)instanceGUID;
    } //get_TypeId

    // Override ToString() to append the message to what the base generates.
    public String ToString()
    {
        return super.ToString() + ":" + usageMsg;
    } //ToString
} //ArgumentUsageAttribute

public class TestClass
{
    // Assign an ArgumentUsage attribute to each parameter.
    public void TestMethod(
        /** @attribute ArgumentUsage("Must pass an array here.")
        */
        String strArray[],
        /** @attribute ArgumentUsage("Can pass a param list or array here.")
         */
        /** @attribute System.ParamArray() 
         */
        String strList[])
    {
    } //TestMethod
} //TestClass

class AttributeTypeIdDemo
{
    static void ShowAttributeTypeIds()
    {
        // Get the class type, and then get the MethodInfo object 
        // for TestMethod to access its metadata.
        Type clsType = TestClass.class.ToType();
        MethodInfo mInfo = clsType.GetMethod("TestMethod");
        // There will be two elements in pInfoArray, one for each parameter.
        ParameterInfo pInfoArray[] = mInfo.GetParameters();

        if (pInfoArray != null) {
            // Create an instance of the param array attribute on strList.
            ParamArrayAttribute listArrayAttr = (ParamArrayAttribute)(
                Attribute.GetCustomAttribute(pInfoArray[1],
                ParamArrayAttribute.class.ToType()));
            // Create an instance of the argument usage attribute on strArray.
            ArgumentUsageAttribute arrayUsageAttr1 = (ArgumentUsageAttribute)(
                Attribute.GetCustomAttribute(pInfoArray[0], 
                ArgumentUsageAttribute.class.ToType()));
            // Create another instance of the argument usage attribute 
            // on strArray.
            ArgumentUsageAttribute arrayUsageAttr2 = (ArgumentUsageAttribute)(
                Attribute.GetCustomAttribute(pInfoArray[0], 
                ArgumentUsageAttribute.class.ToType()));
            // Create an instance of the argument usage attribute on strList.
            ArgumentUsageAttribute listUsageAttr = (ArgumentUsageAttribute)(
                Attribute.GetCustomAttribute(pInfoArray[1], 
                ArgumentUsageAttribute.class.ToType()));
            // Display the attributes and corresponding TypeId values.
            Console.WriteLine("\n\"{0}\" \nTypeId: {1}", 
                listArrayAttr.ToString(), listArrayAttr.get_TypeId());
            Console.WriteLine("\n\"{0}\" \nTypeId: {1}", 
                arrayUsageAttr1.ToString(), arrayUsageAttr1.get_TypeId());
            Console.WriteLine("\n\"{0}\" \nTypeId: {1}", 
                arrayUsageAttr2.ToString(), arrayUsageAttr2.get_TypeId());
            Console.WriteLine("\n\"{0}\" \nTypeId: {1}", 
                listUsageAttr.ToString(), listUsageAttr.get_TypeId());
        }
        else {
            Console.WriteLine("The parameters information could " 
                + "not be retrieved for method {0}.", mInfo.get_Name());
        }
    } //ShowAttributeTypeIds

    public static void main(String[] args)
    {
        Console.WriteLine("This example of the Attribute.TypeId property\n" 
            + "generates the following output.");
        Console.WriteLine("\nCreate instances from a derived Attribute " 
            + "class that implements TypeId, \nand then " 
            + "display the attributes and corresponding TypeId values:");
        ShowAttributeTypeIds();
    } //main
} //AttributeTypeIdDemo

/*
    This example of the Attribute.TypeId property
    generates the following output.

    Create instances from a derived Attribute class that implements TypeId,
    and then display the attributes and corresponding TypeId values:

    "System.ParamArrayAttribute"
    TypeId: System.ParamArrayAttribute

    "NDP_UE_JSL.ArgumentUsageAttribute@c10548ee:Must pass an array here."
    TypeId: b67bef05-6ef3-4583-876b-99c38b6b662a
    
    "NDP_UE_JSL.ArgumentUsageAttribute@c10548ee:Must pass an array here."
    TypeId: 5bf96750-d43c-457f-8210-802abdd37208
    
    "NDP_UE_JSL.ArgumentUsageAttribute@419634a1:Can pass a param list or array 
    here."
    TypeId: 2e4fb470-ede6-4c45-b7ab-15bd7545f556
*/

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

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft