Share via


OutputDescriptor Class

Describes a single output of a data generator.

Inheritance Hierarchy

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

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

Syntax

'Declaration
<CLSCompliantAttribute(True)> _
Public NotInheritable Class OutputDescriptor _
    Implements IXmlSerializable
[CLSCompliantAttribute(true)]
public sealed class OutputDescriptor : IXmlSerializable
[CLSCompliantAttribute(true)]
public ref class OutputDescriptor sealed : IXmlSerializable
[<Sealed>]
[<CLSCompliantAttribute(true)>]
type OutputDescriptor =  
    class
        interface IXmlSerializable
    end
public final class OutputDescriptor implements IXmlSerializable

The OutputDescriptor type exposes the following members.

Constructors

  Name Description
Public method OutputDescriptor() Initializes a new instance of the OutputDescriptor class.
Public method OutputDescriptor(String, Type) Initializes a new instance of the OutputDescriptor class by using the provided key and data type.
Public method OutputDescriptor(String, Type, String, String) Initializes a new instance of the OutputDescriptor class by using the provided key, data type, name, and description.

Top

Properties

  Name Description
Public property DBTypeExtension Gets or sets the database type extension property.
Public property Description Gets or sets the description of the output.
Public property Key Gets or sets the key that uniquely identifies the output.
Public property Name Gets or sets the friendly name of the output.
Public property Type Gets the data type of the output.

Top

Methods

  Name Description
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IXmlSerializable.GetSchema
Explicit interface implemetationPrivate method IXmlSerializable.ReadXml
Explicit interface implemetationPrivate method IXmlSerializable.WriteXml

Top

Remarks

Output descriptors correspond to the outputs that a data generator produces. The outputs appear in the Generator Output column in the Column Details window, where the user can view and select them.

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

InputDescriptor

GetOutputValue()

OutputAttribute

InputDescriptor

Other Resources

How to: Add Output Properties to a Data Generator

Walkthrough: Creating a Custom Data Generator