XsdDataContractExporter 类

  • 参考

定义

命名空间:
System.Runtime.Serialization
程序集:
System.Runtime.Serialization.Xml.dll
程序集:
System.Runtime.Serialization.dll
程序集:
netstandard.dll
Source:
XsdDataContractExporter.cs
Source:
XsdDataContractExporter.cs
Source:
XsdDataContractExporter.cs

用于将数据协定中使用的一组 .NET 类型转换成 XML 架构文件 (.xsd)。

public ref class XsdDataContractExporter
public class XsdDataContractExporter
type XsdDataContractExporter = class
Public Class XsdDataContractExporter
继承
Object
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 的详细信息，请参阅 XsdDataContractExporter 的补充 API 备注。

构造函数

XsdDataContractExporter()

初始化 XsdDataContractExporter 类的新实例。
XsdDataContractExporter(XmlSchemaSet)

使用指定的架构集初始化 XsdDataContractExporter 类的新实例。

属性

Options

获取或设置一个 ExportOptions，其中包含可为导出操作设置的选项。
Schemas

获取导出的 XML 架构的集合。

方法

CanExport(ICollection<Assembly>)

获取一个值，该值指示一组程序集中包含的公共语言运行库 (CLR) 类型集是否可以导出。
CanExport(ICollection<Type>)

获取一个值，该值指示 ICollection<T> 中包含的公共语言运行时 (CLR) 类型集是否可以导出。
CanExport(Type)

获取一个值，该值指示指定的公共语言运行时 (CLR) 类型是否可以导出。
Equals(Object)

确定指定对象是否等于当前对象。

(继承自 Object)
Export(ICollection<Assembly>)

对指定的程序集集合中包含的类型进行转换。
Export(ICollection<Type>)

对传递给该方法的 ICollection<T> 中包含的类型进行转换。
Export(Type)

将指定的.NET Framework类型转换为 XML 架构定义语言 (XSD) 架构。
GetHashCode()

作为默认哈希函数。

(继承自 Object)
GetRootElementName(Type)

返回 Type 的顶级名称和命名空间。
GetSchemaType(Type)

返回指定类型的 XML 架构类型。
GetSchemaTypeName(Type)

返回 Type 的协定名称和协定命名空间。
GetType()

获取当前实例的 Type。

(继承自 Object)
MemberwiseClone()

创建当前 Object 的浅表副本。

(继承自 Object)
ToString()

返回表示当前对象的字符串。

(继承自 Object)

适用于

另请参阅