{"id":1318,"date":"2023-03-31T21:29:23","date_gmt":"2023-03-31T14:29:23","guid":{"rendered":"https:\/\/csharptutorial.net\/?page_id=1318"},"modified":"2023-04-01T18:50:46","modified_gmt":"2023-04-01T11:50:46","slug":"csharp-attributes","status":"publish","type":"page","link":"https:\/\/www.csharptutorial.net\/csharp-tutorial\/csharp-attributes\/","title":{"rendered":"C# Attributes"},"content":{"rendered":"\n

Summary<\/strong>: in this tutorial, you’ll learn how to C# attributes to add metadata to your code and how to write a custom attribute.<\/p>\n\n\n\n

Introduction to C# attributes<\/h2>\n\n\n\n

In C#, an attribute is a declarative tag that you can apply to classes<\/a>, methods, properties<\/a>, and other code elements.<\/p>\n\n\n\n

An attribute provides additional information about the code element to which it is applied. For example, you can use an attribute to indicate how an object should be serialized.<\/p>\n\n\n\n

All attributes class inherits from the System.Attribute<\/code> class. Besides providing built-in attributes, you can create custom attribute classes that extend the System.Attribute<\/code> class. <\/p>\n\n\n\n

The following example demonstrates how to use a built-in Serializable<\/code> attribute for the Person<\/code> class. The Serializable<\/code> attribute instructs .NET that the Person<\/code> class can be serialized into a binary format:<\/p>\n\n\n

[Serializable<\/span>]\nclass<\/span> Person<\/span>\n{\n    public<\/span> string<\/span>? Name { get<\/span>; set<\/span>; }\n    public<\/span> sbyte<\/span>? Age {  get<\/span>; set<\/span>; }\n}<\/code><\/span>Code language:<\/span> C#<\/span> (<\/span>cs<\/span>)<\/span><\/small><\/pre>\n\n\n
Why do you need C# attributes?<\/h2>\n\n\n\n
Attributes add metadata to your code so that .NET or other tools can use it at run time. For example, Visual Studio IDE uses attributes to provide IntelliSense and code completion suggestions. Also, the .NET runtime uses attributes to determine how to execute your code.<\/p>\n\n\n\n
Attributes can also be useful for enforcing coding conventions. For example, you can use the Obsolete<\/code> attribute to mark a method of a class obsolete. Then, Visual Studio can give a warning if you attempt to call the obsolete method.<\/p>\n\n\n\n
Creating a custom attribute<\/h2>\n\n\n\n
The following program demonstrates how to create a custom attribute called Author<\/code>:<\/p>\n\n\n
[AttributeUsage(AttributeTargets.Class)<\/span>]\nclass<\/span> Author<\/span> : Attribute<\/span>\n{\n    public<\/span> string<\/span> Name\n    {\n        get<\/span>; set<\/span>;\n    }\n\n    public<\/span> Author<\/span>(string<\/span> name<\/span>)<\/span>\n    {\n        Name = name;\n    }\n}\n\n[Author(\"John Doe\"<\/span>)<\/span>]\nclass<\/span> Person<\/span>\n{\n}\n\nclass<\/span> Program<\/span>\n{\n    public<\/span> static<\/span> void<\/span> Main<\/span>(string<\/span>[] args<\/span>)<\/span>\n    {\n        \/\/ get all custom attributes of the Person class<\/span>\n        var<\/span> attributes = Attribute.GetCustomAttributes(typeof<\/span>(Person));\n\n        \/\/ Retrieve the author attribute<\/span>\n        var<\/span> author = attributes.OfType<Author>().Single();\n        Console.WriteLine(author.Name);\n    }\n}<\/code><\/span>Code language:<\/span> C#<\/span> (<\/span>cs<\/span>)<\/span><\/small><\/pre>\n\n\n
Output:<\/p>\n\n\n
John Doe<\/code><\/span><\/pre>\n\n\n
How it works.<\/p>\n\n\n\n
First, define a custom attribute class named Author<\/code> that inherits from the  Attribute<\/code>  class:<\/p>\n\n\n
[AttributeUsage(AttributeTargets.Class)<\/span>]\nclass<\/span> Author<\/span> : Attribute<\/span>\n{\n    public<\/span> string<\/span> Name\n    {\n        get<\/span>; set<\/span>;\n    }\n\n    public<\/span> Author<\/span>(string<\/span> name<\/span>)<\/span>\n    {\n        Name = name;\n    }\n}<\/code><\/span>Code language:<\/span> C#<\/span> (<\/span>cs<\/span>)<\/span><\/small><\/pre>\n\n\n
The Author<\/code> class has a Name<\/code> property and a constructor that takes a name<\/code> parameter. <\/p>\n\n\n\n
Also, we decorate the Author<\/code> class with the [AttributeUsage(AttributeTargets.Class)]<\/code> attribute, which specifies that the Author attribute can only be applied to classes.<\/p>\n\n\n\n
Second, define a Person<\/code> class and use the Author<\/code> attribute to decorate it:<\/p>\n\n\n
[Author(\"John Doe\"<\/span>)<\/span>]\nclass<\/span> Person<\/span>\n{\n}\n<\/code><\/span>Code language:<\/span> C#<\/span> (<\/span>cs<\/span>)<\/span><\/small><\/pre>\n\n\n
In the Author<\/code> attribute, we set the Name<\/code> property to \"John Doe\"<\/code>. Later, you can retrieve this information at runtime.<\/p>\n\n\n\n
Third, show the Name<\/code> property of the Author<\/code> attribute applied to the Person<\/code> class:<\/p>\n\n\n
\/\/ Get all custom attributes of the Person class<\/span>\nvar<\/span> attributes = Attribute.GetCustomAttributes(typeof<\/span>(Person));\n\n\/\/ Retrieve the author attribute<\/span>\nvar<\/span> author = attributes.OfType<Author>().Single();\nConsole.WriteLine(author.Name);\n<\/code><\/span>Code language:<\/span> JavaScript<\/span> (<\/span>javascript<\/span>)<\/span><\/small><\/pre>\n\n\n
In the Main()<\/code> method, we use the Attribute.GetCustomAttributes<\/code> method to retrieve all custom attributes of the Person<\/code> class. <\/p>\n\n\n\n
Since the Person<\/code> class has only one Author<\/code> attribute, we use the Single<\/a><\/code> method to retrieve it and display its Name<\/code> property to the console.<\/p>\n\n\n\n
Summary<\/h2>\n\n\n\n
    \n
  • Attributes are declarative tags that you can apply to classes, methods, and properties.<\/li>\n\n\n\n
  • Attributes provide additional information to the code elements that it applies to.<\/li>\n\n\n\n
  • Attributes use System.Attribute<\/code> as the base class.<\/li>\n<\/ul>\n
    \n\t
    \n\t\t
    Was this tutorial helpful ?<\/div>\n\t\t
    \n\t\t\t\n\t\t\t\t\n\t\t\t\t\t<\/path>\n\t\t\t\t<\/svg>\n\t\t\t\t Yes <\/span>\n\t\t\t<\/button>\n\n\t\t\t\n\t\t\t\t\n\t\t\t\t\t<\/path>\n\t\t\t\t<\/svg>\n\t\t\t\t No <\/span>\n\t\t\t<\/button>\n\t\t<\/div>\n\t<\/header>\n\n\t
    \n\t\t
    \n\t\t\t
    <\/div>\n\t\t\t\n\t\t\t
Then, we use the OfType<\/code> LINQ<\/a> extension method to filter the list of attributes to get the one with the type Author<\/code>. <\/p>\n\n\n\n