XsdDataContractExporter Класс

Определение

Позволяет преобразовать набор типов .NET, которые используются в контрактах данных в XML-файл схемы (XSD).

public ref class XsdDataContractExporter
public class XsdDataContractExporter
type XsdDataContractExporter = class
Public Class XsdDataContractExporter
Наследование
XsdDataContractExporter

Примеры

В следующем примере создается экземпляр XsdDataContractExporter метода и вызывается Export(Type) метод.

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;
    }
}
Imports System.Collections
Imports System.Xml
Imports System.Runtime.Serialization
Imports System.Xml.Schema

Public Class Program
    Public Shared Sub Main() 
        Try
            ExportXSD()
        Catch exc As Exception
            Console.WriteLine("Message: {0} StackTrace:{1}", exc.Message, exc.StackTrace)
        Finally
            Console.ReadLine()
        End Try
    
    End Sub 
    
    
    Shared Sub ExportXSD() 

        Dim exporter As New XsdDataContractExporter()

        ' Use the ExportOptions to add the Possessions type to the 
        ' collection of KnownTypes. 
        Dim eOptions As New ExportOptions()
        eOptions.KnownTypes.Add(GetType(Possessions))        
        exporter.Options = eOptions

        If exporter.CanExport(GetType(Employee)) Then
            exporter.Export(GetType(Employee))
            Console.WriteLine("number of schemas: {0}", exporter.Schemas.Count)
            Console.WriteLine()
            Dim mySchemas As XmlSchemaSet = exporter.Schemas
            
            Dim XmlNameValue As XmlQualifiedName = _
               exporter.GetRootElementName(GetType(Employee))
            Dim EmployeeNameSpace As String = XmlNameValue.Namespace
            
            Dim schema As XmlSchema
            For Each schema In  mySchemas.Schemas(EmployeeNameSpace)
                schema.Write(Console.Out)
            Next schema
        End If
    
    End Sub 
    
    
    Shared Sub GetXmlElementName() 
        Dim myExporter As New XsdDataContractExporter()
        Dim xmlElementName As XmlQualifiedName = myExporter. _
            GetRootElementName(GetType(Employee))
        Console.WriteLine("Namespace: {0}", xmlElementName.Namespace)
        Console.WriteLine("Name: {0}", xmlElementName.Name)
        Console.WriteLine("IsEmpty: {0}", xmlElementName.IsEmpty)
    
    End Sub 
    
    <DataContract([Namespace] := "www.Contoso.com/Examples/")>  _
    Public Class Employee

        <DataMember()>  _
        Public EmployeeName As String
        <DataMember()>  _
        Private ID As String
        ' This member may return a Possessions type.
        <DataMember> _
        public Miscellaneous As Hashtable 

    End Class 

    <DataContract> _
    Public Class Possessions

        <DataMember> _
        Public ItemName As String
    End Class

End Class

Комментарии

Дополнительные сведения об этом API см. в дополнительных примечаниях API для XsdDataContractExporter.

Конструкторы

Имя Описание
XsdDataContractExporter()

Инициализирует новый экземпляр класса XsdDataContractExporter.

XsdDataContractExporter(XmlSchemaSet)

Инициализирует новый экземпляр XsdDataContractExporter класса с указанным набором схем.

Свойства

Имя Описание
Options

Возвращает или задает объект ExportOptions , содержащий параметры, которые можно задать для операции экспорта.

Schemas

Возвращает коллекцию экспортированных XML-схем.

Методы

Имя Описание
CanExport(ICollection<Assembly>)

Возвращает значение, указывающее, можно ли экспортировать набор типов среды CLR, содержащихся в наборе сборок.

CanExport(ICollection<Type>)

Возвращает значение, указывающее, можно ли экспортировать набор типов среды CLR, содержащихся в объекте ICollection<T> .

CanExport(Type)

Возвращает значение, указывающее, можно ли экспортировать указанный тип среды CLR.

Equals(Object)

Определяет, равен ли указанный объект текущему объекту.

(Унаследовано от Object)
Export(ICollection<Assembly>)

Преобразует типы, содержащиеся в указанной коллекции сборок.

Export(ICollection<Type>)

Преобразует типы, содержащиеся в переданном методе ICollection<T> .

Export(Type)

Преобразует указанный тип .NET в схему языка определения XML-схемы (XSD).

GetHashCode()

Служит хэш-функцией по умолчанию.

(Унаследовано от Object)
GetRootElementName(Type)

Возвращает имя верхнего уровня и пространство имен для объекта Type.

GetSchemaType(Type)

Возвращает тип схемы XML для указанного типа.

GetSchemaTypeName(Type)

Возвращает имя контракта и пространство имен контракта для объекта Type.

GetType()

Возвращает Type текущего экземпляра.

(Унаследовано от Object)
MemberwiseClone()

Создает неглубокую копию текущей Object.

(Унаследовано от Object)
ToString()

Возвращает строку, представляющую текущий объект.

(Унаследовано от Object)

Применяется к

См. также раздел