XsdDataContractExporter Класс

Определение

Предоставляет возможность преобразования набора типов .NET Framework, используемых в контрактах данных, в файл схемы XML (XSD).Allows the transformation of a set of .NET Framework types that are used in data contracts into an XML schema file (.xsd).

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

Примеры

В следующем примере создается экземпляр класса XsdDataContractExporter и вызывается метод Export(Type).The following example creates an instance of the XsdDataContractExporter and calls the Export(Type) method.

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

Комментарии

Если была создана веб-служба, которая добавляет данные, представленные типами среды CLR, и требуется экспортировать схемы XML для каждого типа, используемого другими веб-службами, используйте класс XsdDataContractExporter.Use the XsdDataContractExporter class when you have created a Web service that incorporates data represented by common language runtime (CLR) types and when you need to export XML schemas for each type to be consumed by other Web services. Таким образом, XsdDataContractExporter преобразует набор типов среды CLR в схемы XML.That is, XsdDataContractExporter transforms a set of CLR types into XML schemas. (Дополнительные сведения о типах, которые можно использовать, см. в разделе типы, поддерживаемые сериализатором контрактов данных.) Затем схемы могут быть предоставлены через документ языка описания веб-служб (WSDL) для использования другими пользователями, которым требуется взаимодействие со службой.(For more information about the types that can be used, see Types Supported by the Data Contract Serializer.) The schemas can then be exposed through a Web Services Description Language (WSDL) document for use by others who need to interoperate with your service.

И наоборот, при создании веб-службы, которая должна будет взаимодействовать с существующей службой, используйте XsdDataContractImporter для преобразования схем XML и создания типов среды CLR, представляющих данные в выбранном языке программирования.Conversely, if you are creating a Web service that must interoperate with an existing Web service, use the XsdDataContractImporter to transform XML schemas and create the CLR types that represent the data in a selected programming language.

XsdDataContractExporter создает объект XmlSchemaSet, содержащий коллекцию схем.The XsdDataContractExporter generates an XmlSchemaSet object that contains the collection of schemas. Доступ к набору схем осуществляется через свойство Schemas.Access the set of schemas through the Schemas property.

Примечание

Для быстрого создания файлов определения схемы XML (файлов XSD), которые могут использовать другие веб-службы, используйте XsdDataContractExporter.To quickly generate XML schema definition (XSD) files that other Web services can consume, use the XsdDataContractExporter.

Экспорт схем в XmlSchemaSetExporting Schemas Into an XmlSchemaSet

Для создания экземпляра класса XmlSchemaSet, содержащего файлы схемы XML, необходимо знать следующее.To create an instance of the XmlSchemaSet class that contains XML schema files, you should be aware of the following.

Набор экспортируемых типов записывается как внутренний набор контрактов данных.The set of types you are exporting are recorded as an internal set of data contracts. Таким образом, можно вызвать метод CanExport несколько раз, чтобы добавить новые типы в набор схем; это не снизит производительность, так как в набор будут добавлены только новые типы.Thus, you can call the CanExport method multiple times to add new types to the schema set without degrading performance because only the new types will be added to the set. При выполнении операции Export существующие схемы сравниваются с добавляемыми новыми схемами.During the Export operation, the existing schemas are compared to the new schemas being added. При возникновении конфликтов будет выдано исключение.If there are conflicts, an exception will be thrown. Обычно конфликт возникает, когда два типа с одним и тем же именем контракта данных, но разными контрактами (разными элементами), экспортируются одним и тем же экземпляром XsdDataContractExporter.A conflict is usually detected if two types with the same data contract name but different contracts (different members) are exported by the same XsdDataContractExporter instance.

Использование средства экспортаUsing the Exporter

Рекомендуется использовать этот класс следующим образом.A recommended way of using this class is as follows:

  1. Используйте одну из перегрузок CanExport, чтобы определить, возможен ли экспорт указанного типа или набора типов.Use one of the CanExport overloads to determine whether the specified type or set of types can be exported. Используйте одну из перегрузок, соответствующую предъявляемым требованиям.Use one of the overloads that is appropriate to your requirements.

  2. Вызовите соответствующий метод Export.Call the corresponding Export method.

  3. Извлеките схемы из свойства Schemas.Retrieve the schemas from the Schemas property.

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

XsdDataContractExporter()

Инициализирует новый экземпляр класса XsdDataContractExporter.Initializes a new instance of the XsdDataContractExporter class.

XsdDataContractExporter(XmlSchemaSet)

Инициализирует новый экземпляр класса XsdDataContractExporter с указанным набором схем.Initializes a new instance of the XsdDataContractExporter class with the specified set of schemas.

Свойства

Options

Возвращает или задает объект ExportOptions, содержащий параметры, которые могут быть заданы для операции экспорта.Gets or sets an ExportOptions that contains options that can be set for the export operation.

Schemas

Возвращает коллекцию экспортированных схем XML.Gets the collection of exported XML schemas.

Методы

CanExport(ICollection<Assembly>)

Возвращает значение, указывающее, возможен ли экспорт набора типов среды CLR, содержащегося в наборе сборок.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>)

Возвращает значение, указывающее, возможен ли экспорт набора типов среды CLR, содержащегося в ICollection<T>.Gets a value that indicates whether the set of .common language runtime (CLR) types contained in a ICollection<T> can be exported.

CanExport(Type)

Возвращает значение, указывающее, возможен ли экспорт заданного типа среды CLR.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.

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

Преобразует типы, содержащиеся в указанной коллекции сборок.Transforms the types contained in the specified collection of assemblies.

Export(ICollection<Type>)

Преобразует типы, содержащиеся в ICollection<T>, переданной в этот метод.Transforms the types contained in the ICollection<T> passed to this method.

Export(Type)

Преобразует указанный тип .NET Framework.NET Framework в схему языка определения схемы XML (XSD).Transforms the specified .NET Framework.NET Framework type into an XML schema definition language (XSD) schema.

GetHashCode()

Служит хэш-функцией по умолчанию.Serves as the default hash function.

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

Возвращает имя верхнего уровня и пространство имен для типа Type.Returns the top-level name and namespace for the Type.

GetSchemaType(Type)

Возвращает схему XML для заданного типа.Returns the XML schema type for the specified type.

GetSchemaTypeName(Type)

Возвращает имя контракта и пространство имен контракта для типа Type.Returns the contract name and contract namespace for the Type.

GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

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

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

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

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

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

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

Дополнительно