InputDescriptor Class

Describes a single input of a data generator.

Inheritance Hierarchy

System.Object
  Microsoft.Data.Schema.Tools.DataGenerator.InputDescriptor

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

Syntax

'Declaration
<CLSCompliantAttribute(True)> _
Public NotInheritable Class InputDescriptor _
    Implements IXmlSerializable

[CLSCompliantAttribute(true)]
public sealed class InputDescriptor : IXmlSerializable

[CLSCompliantAttribute(true)]
public ref class InputDescriptor sealed : IXmlSerializable

[<Sealed>]
[<CLSCompliantAttribute(true)>]
type InputDescriptor =  
    class
        interface IXmlSerializable
    end

public final class InputDescriptor implements IXmlSerializable

The InputDescriptor type exposes the following members.

Constructors

	Name	Description
	InputDescriptor()	Initializes a new instance of the InputDescriptor class.
	InputDescriptor(String, Type)
	InputDescriptor(String, Type, String, String)	Initializes a new instance of the InputDescriptor class.
	InputDescriptor(String, Type, String, String, AutoAssignedInput)	Initializes a new instance of the InputDescriptor class by using the provided parameters.
	InputDescriptor(String, Type, String, String, AutoAssignedInput, Type, String)	Initializes a new instance of the InputDescriptor class by using the provided parameters.
	InputDescriptor(String, Type, String, String, AutoAssignedInput, Type, Type)	Initializes a new instance of the InputDescriptor class by using the provided parameters.

Top

Properties

	Name	Description
	AutoAssignedInput	Gets the type of input. This property is used to specify the type of the input for well-known input types.
	Description	Gets or sets the description of the input.
	EditorType	Gets or sets the type of editor for this input.
	EditorTypeName	The name of the editor type for this input.
	Key	Gets the string that uniquely identifies the input.
	Name	Gets or sets the friendly name of the input.
	ReadOnly	Gets or sets a value that indicates whether the input is read-only in the Properties window.
	Type	Gets or sets a value that indicates whether the input value is read-only in the Properties window.
	TypeConverter	Gets the type converter for this input.
	Value	Gets or sets the value of the input.
	Visible	Gets or sets a value that indicates whether the input appears in the Properties window.

Top

Methods

	Name	Description
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	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	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	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
	IXmlSerializable.GetSchema
	IXmlSerializable.ReadXml
	IXmlSerializable.WriteXml

Top

Remarks

An input descriptor corresponds to a data generator property that appears in the Properties window, where the user can set the value. Input descriptors can also correspond to the dynamically created (non-property) inputs of the data generator. The designer creates the input descriptors. The default designer creates input descriptors by using properties that are marked with the InputAttribute.

An InputDescriptor provides sufficient information for the designer to get or set the input values for a data generator without creating an instance of the generator.

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

InputAttribute

SetInputValues(IDictionary<String, Object>)

AutoAssignedInput

Other Resources

An Overview of Data Generator Extensibility

How to: Add Input Properties to a Data Generator