InputAttribute Class

The attribute that identifies generator properties as input properties.

Inheritance Hierarchy

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

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

Syntax

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

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

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

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

public final class InputAttribute extends Attribute

The InputAttribute type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	AutoAssignedInput	Gets or sets the type of input property.
	DefaultValue	Gets or sets the default value of the input property.
	Description	Gets or sets the description of the input property.
	EditorType	Gets or sets the type of editor to be used for this property.
	Name	The name of the input attribute.
	ReadOnly	Gets or sets a value that indicates whether the input property is read-only in the Properties window.
	TypeConverter	Gets or sets the type converter that displays the input property.
	TypeId	When implemented in a derived class, gets a unique identifier for this Attribute. (Inherited from Attribute.)
	Visible	Gets or sets a value that indicates whether the input property appears in the Properties window.

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

Use this attribute to identify properties of custom data generators as input properties. These properties appear in the Properties window, where the user can set their values. The DefaultGeneratorDesigner uses this attribute to construct an array of InputDescriptor objects. This behavior is part of the declarative extensibility model. In this model, the author of a custom generator can specify inputs and outputs in attributes, instead of explicitly constructing designers that provide input and output data.

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

Reference

Microsoft.Data.Schema.Tools.DataGenerator Namespace

GetInputs

GetOutputs

Other Resources

How to: Add Input Properties to a Data Generator