GeneratorAttribute Class

Article
11/05/2012

Identifies the designer for the data generator to which it is applied.

Inheritance Hierarchy

System.Object
System.Attribute
Microsoft.Data.Schema.Tools.DataGenerator.GeneratorAttribute

Namespace: Microsoft.Data.Schema.Tools.DataGenerator
Assembly: Microsoft.Data.Schema.Tools (in Microsoft.Data.Schema.Tools.dll)

Syntax

'Declaration
<AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple := False, Inherited := True)> _
<CLSCompliantAttribute(True)> _
Public NotInheritable Class GeneratorAttribute _
    Inherits Attribute

[AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple = false, Inherited = true)]
[CLSCompliantAttribute(true)]
public sealed class GeneratorAttribute : Attribute

[AttributeUsageAttribute(AttributeTargets::Class, AllowMultiple = false, Inherited = true)]
[CLSCompliantAttribute(true)]
public ref class GeneratorAttribute sealed : public Attribute

[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Class, AllowMultiple = false, Inherited = true)>]
[<CLSCompliantAttribute(true)>]
type GeneratorAttribute =  
    class
        inherit Attribute
    end

public final class GeneratorAttribute extends Attribute

The GeneratorAttribute type exposes the following members.

Constructors

	Name	Description
	GeneratorAttribute	Initializes a new instance of the GeneratorAttribute class.

Top

Properties

	Name	Description
	DesignerType	Gets the designer type for the data generator.
	TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)

Top

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.)

Top

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.)

Top

Remarks

The Generator abstract base class has the GeneratorAttribute and specifies the DefaultGeneratorDesigner.

Use the GeneratorAttribute in the following case:

You want a data generator to use a custom designer.

You should not use the GeneratorAttribute in the following cases:

Your data generator class inherits from Generator and you want to use the DefaultGeneratorDesigner.
Your data generator class inherits from another data generator class that is already decorated with GeneratorAttribute and you are satisfied with the designer that is already specified.

Examples

The following example demonstrates how to decorate a class by using the GeneratorAttribute. In this example, the data generator is associated with a custom designer named CustomDesignerType.

[Generator(typeof(CustomDesignerType))]
public class TestGenerator:Generator
{
    . . .
}

<Generator(GetType(CustomDesignerType))> _
Public Class TestGenerator
    Inherits Generator
    . . .
End Class

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.