.NET Framework Class Library
GeneratedCodeAttribute Class
Identifies code generated by a tool. This class cannot be inherited.
Inheritance Hierarchy
System.Object
System.Attribute
System.CodeDom.Compiler.GeneratedCodeAttribute
Namespace: System.CodeDom.Compiler
Assembly: System (in System.dll)
Syntax
Visual Basic
<AttributeUsageAttribute(AttributeTargets.All, Inherited := False, AllowMultiple := False)> _ Public NotInheritable Class GeneratedCodeAttribute _ Inherits Attribute
C#
[AttributeUsageAttribute(AttributeTargets.All, Inherited = false, AllowMultiple = false)] public sealed class GeneratedCodeAttribute : Attribute
Visual C++
[AttributeUsageAttribute(AttributeTargets::All, Inherited = false, AllowMultiple = false)] public ref class GeneratedCodeAttribute sealed : public Attribute
F#
[<Sealed>] [<AttributeUsageAttribute(AttributeTargets.All, Inherited = false, AllowMultiple = false)>] type GeneratedCodeAttribute = class inherit Attribute end
The GeneratedCodeAttribute type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
|
GeneratedCodeAttribute | Initializes a new instance of the GeneratedCodeAttribute class specifying the name and version of the tool that generated the code. |
Properties
| Name | Description | |
|---|---|---|
|
Tool | Gets the name of the tool that generated the code. |
|
TypeId | When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.) |
|
Version | Gets the version of the tool that generated the code. |
Methods
| Name | Description | |
|---|---|---|
|
Equals | Infrastructure. Returns a value that indicates whether this instance is equal to a specified object. (Inherited from Attribute.) |
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
GetHashCode | Returns the hash code for this instance. (Inherited from Attribute.) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
IsDefaultAttribute | When overridden in a derived class, indicates whether the value of this instance is the default value for the derived class. (Inherited from Attribute.) |
|
Match | When overridden in a derived class, returns a value that indicates whether this instance equals a specified object. (Inherited from Attribute.) |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
|
_Attribute.GetIDsOfNames | Maps a set of names to a corresponding set of dispatch identifiers. (Inherited from Attribute.) |
|
_Attribute.GetTypeInfo | Retrieves the type information for an object, which can be used to get the type information for an interface. (Inherited from Attribute.) |
|
_Attribute.GetTypeInfoCount | Retrieves the number of type information interfaces that an object provides (either 0 or 1). (Inherited from Attribute.) |
|
_Attribute.Invoke | Provides access to properties and methods exposed by an object. (Inherited from Attribute.) |
Remarks
The GeneratedCodeAttribute class can be used by code analysis tools to identify computer-generated code, and to provide an analysis based on the tool and the version of the tool that generated the code.
Examples
The following code example shows the use of the GeneratedCodeAttribute class to identify computer-generated code.
Visual Basic
Imports System Imports System.CodeDom Imports System.CodeDom.Compiler Public Class CodeGenExample Shared Sub Main ' Declare a new type called Class1. Dim class1 as New CodeTypeDeclaration("Class1") ' Declare a new generated code attribute Dim generatedCodeAttribute As _ New GeneratedCodeAttribute("SampleCodeGenerator", "2.0.0.0") ' Use the generated code attribute members in the attribute declaration Dim codeAttrDecl As _ New CodeAttributeDeclaration(generatedCodeAttribute.GetType().Name, New CodeAttributeArgument( New CodePrimitiveExpression(generatedCodeAttribute.Tool)), New CodeAttributeArgument( New CodePrimitiveExpression(generatedCodeAttribute.Version))) class1.CustomAttributes.Add(codeAttrDecl) ' Create a Visual Basic code provider Dim provider As CodeDomProvider = CodeDomProvider.CreateProvider("VisualBasic") ' Generate code and send the output to the console provider.GenerateCodeFromType(class1, Console.Out, New CodeGeneratorOptions()) End Sub End Class ' The Visual Basic code generator produces the following source code for the preceeding example code: ' ' <GeneratedCodeAttribute("SampleCodeGenerator", "2.0.0.0")> _ ' Public Class Class1 ' End Class
C#
using System; using System.CodeDom; using System.CodeDom.Compiler; public class CodeGenExample { static void Main() { // Declare a new type called Class1. CodeTypeDeclaration class1 = new CodeTypeDeclaration("Class1"); // Declare a new generated code attribute GeneratedCodeAttribute generatedCodeAttribute = new GeneratedCodeAttribute("SampleCodeGenerator", "2.0.0.0"); // Use the generated code attribute members in the attribute declaration CodeAttributeDeclaration codeAttrDecl = new CodeAttributeDeclaration(generatedCodeAttribute.GetType().Name, new CodeAttributeArgument( new CodePrimitiveExpression(generatedCodeAttribute.Tool)), new CodeAttributeArgument( new CodePrimitiveExpression(generatedCodeAttribute.Version))); class1.CustomAttributes.Add(codeAttrDecl); // Create a C# code provider CodeDomProvider provider = CodeDomProvider.CreateProvider("CSharp"); // Generate code and send the output to the console provider.GenerateCodeFromType(class1, Console.Out, new CodeGeneratorOptions()); } } // The C# code generator produces the following source code for the preceeding example code: // // [GeneratedCodeAttribute("SampleCodeGenerator", "2.0.0.0")] // public class Class1 { // }
Visual C++
#using <System.dll> #using <System.Xml.dll> using namespace System; using namespace System::CodeDom; using namespace System::CodeDom::Compiler; int main() { // Declare a new type called Class1. CodeTypeDeclaration^ class1 = gcnew CodeTypeDeclaration("Class1"); // Declare a new generated code attribute GeneratedCodeAttribute^ generatedCodeAttribute = gcnew GeneratedCodeAttribute("SampleCodeGenerator", "2.0.0.0"); // Use the generated code attribute members in the attribute declaration CodeAttributeDeclaration^ codeAttrDecl = gcnew CodeAttributeDeclaration(generatedCodeAttribute->GetType()->Name, gcnew CodeAttributeArgument( gcnew CodePrimitiveExpression(generatedCodeAttribute->Tool)), gcnew CodeAttributeArgument( gcnew CodePrimitiveExpression(generatedCodeAttribute->Version))); class1->CustomAttributes->Add(codeAttrDecl); // Create a C# code provider CodeDomProvider^ provider = CodeDomProvider::CreateProvider("CSharp"); // Generate code and send the output to the console provider->GenerateCodeFromType(class1, Console::Out, gcnew CodeGeneratorOptions()); } // The CPP code generator produces the following source code for the preceeding example code: // // [GeneratedCodeAttribute("SampleCodeGenerator", "2.0.0.0")] // public class Class1 { // }
Version Information
.NET Framework
Supported in: 4, 3.5, 3.0, 2.0.NET Framework Client Profile
Supported in: 4, 3.5 SP1Portable Class Library
Supported in: Portable Class LibraryPlatforms
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.See Also