XsdDataContractExporter Class

Definition

Allows the transformation of a set of .NET types that are used in data contracts into an XML schema file (.xsd).

C#
public class XsdDataContractExporter
Inheritance
XsdDataContractExporter

Examples

The following example creates an instance of the XsdDataContractExporter and calls the Export(Type) method.

C#
using System;
using System.Xml;
using System.Runtime.Serialization;
using System.Xml.Schema;

public class Program
{
    public static void Main()
    {
        try
        {
            ExportXSD();
        }
        catch (Exception exc)
        {
            Console.WriteLine("Message: {0} StackTrace:{1}", exc.Message, exc.StackTrace);
        }
        finally
        {
            Console.ReadLine();
        }
    }

    static void ExportXSD()
    {
        XsdDataContractExporter exporter = new XsdDataContractExporter();
        if (exporter.CanExport(typeof(Employee)))
        {
            exporter.Export(typeof(Employee));
            Console.WriteLine("number of schemas: {0}", exporter.Schemas.Count);
            Console.WriteLine();
            XmlSchemaSet mySchemas = exporter.Schemas;

            XmlQualifiedName XmlNameValue = exporter.GetRootElementName(typeof(Employee));
            string EmployeeNameSpace = XmlNameValue.Namespace;

            foreach (XmlSchema schema in mySchemas.Schemas(EmployeeNameSpace))
            {
                schema.Write(Console.Out);
            }
        }
    }

    static void GetXmlElementName()
    {
        XsdDataContractExporter myExporter = new XsdDataContractExporter();
        XmlQualifiedName xmlElementName =myExporter.GetRootElementName(typeof(Employee));
        Console.WriteLine("Namespace: {0}", xmlElementName.Namespace);
        Console.WriteLine("Name: {0}", xmlElementName.Name);
        Console.WriteLine("IsEmpty: {0}", xmlElementName.IsEmpty);
    }

    [DataContract(Namespace = "www.Contoso.com/Examples/")]
    public class Employee
    {
        [DataMember]
        public string EmployeeName;
        [DataMember]
        private string ID;
    }
}

Remarks

For more information about this API, see Supplemental API remarks for XsdDataContractExporter.

Constructors

XsdDataContractExporter()

Initializes a new instance of the XsdDataContractExporter class.

XsdDataContractExporter(XmlSchemaSet)

Initializes a new instance of the XsdDataContractExporter class with the specified set of schemas.

Properties

Options

Gets or sets an ExportOptions that contains options that can be set for the export operation.

Schemas

Gets the collection of exported XML schemas.

Methods

CanExport(ICollection<Assembly>)

Gets a value that indicates whether the set of .common language runtime (CLR) types contained in a set of assemblies can be exported.

CanExport(ICollection<Type>)

Gets a value that indicates whether the set of .common language runtime (CLR) types contained in a ICollection<T> can be exported.

CanExport(Type)

Gets a value that indicates whether the specified common language runtime (CLR) type can be exported.

Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
Export(ICollection<Assembly>)

Transforms the types contained in the specified collection of assemblies.

Export(ICollection<Type>)

Transforms the types contained in the ICollection<T> passed to this method.

Export(Type)

Transforms the specified .NET Framework type into an XML schema definition language (XSD) schema.

GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetRootElementName(Type)

Returns the top-level name and namespace for the Type.

GetSchemaType(Type)

Returns the XML schema type for the specified type.

GetSchemaTypeName(Type)

Returns the contract name and contract namespace for the Type.

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)

Applies to

Product Versions
.NET Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 2.0, 2.1

See also