XsdDataContractImporter Klasa

Definicja

Umożliwia transformację zestawu plików schematu XML (XSD) do typów środowiska uruchomieniowego języka wspólnego (CLR).Allows the transformation of a set of XML schema files (.xsd) into common language runtime (CLR) types.

public ref class XsdDataContractImporter
public class XsdDataContractImporter
type XsdDataContractImporter = class
Public Class XsdDataContractImporter
Dziedziczenie
XsdDataContractImporter

Przykłady

Poniższy przykład tworzy XmlSchemaSet i wywołuje Import metodę w celu utworzenia CodeCompileUnit .The following example creates an XmlSchemaSet and calls the Import method to create a CodeCompileUnit. CodeCompileUnitJest następnie używany do tworzenia zarówno plików Visual C#, jak i kodu Visual Basic.The CodeCompileUnit is then used to create both Visual C# and Visual Basic code files.

using System;
using System.CodeDom.Compiler;
using System.CodeDom;
using System.Runtime.Serialization;
using System.IO;
using System.Xml;
using System.Xml.Schema;
using System.Globalization;

namespace XsdContractImporterExample
{
    class Program
    {
        static void Main(string[] args)
        {
            try
            {
                XmlSchemaSet schemas = Export();
                CodeCompileUnit ccu = Import(schemas);
                CompileCode(ccu, "Person.cs");
                CompileCode(ccu, "Person.vb");
            }
            catch (Exception exc)
            {
                Console.WriteLine("{0}: {1}", exc.Message, exc.StackTrace);
            }
            finally
            {
                Console.WriteLine("Press <Enter> to end....");
                Console.ReadLine();
            }
        }

        static XmlSchemaSet Export()
        {
            XsdDataContractExporter ex = new XsdDataContractExporter();
            ex.Export(typeof(Person));
            return ex.Schemas;
        }
        static CodeCompileUnit Import(XmlSchemaSet schemas)
        {

            XsdDataContractImporter imp = new XsdDataContractImporter();

            // The EnableDataBinding option adds a RaisePropertyChanged method to
            // the generated code. The GenerateInternal causes code access to be
            // set to internal.
            ImportOptions iOptions = new ImportOptions();
            iOptions.EnableDataBinding = true;
            iOptions.GenerateInternal = true;
            imp.Options = iOptions;

            if (imp.CanImport(schemas))
            {
                imp.Import(schemas);
                return imp.CodeCompileUnit;
            }
            else
            {
                return null;
            }
        }
        static void CompileCode(CodeCompileUnit ccu, string sourceName)
        {
            CodeDomProvider provider = null;
            FileInfo sourceFile = new FileInfo(sourceName);
            // Select the code provider based on the input file extension, either C# or Visual Basic.
            if (sourceFile.Extension.ToUpper(CultureInfo.InvariantCulture) == ".CS")
            {
                provider = new Microsoft.CSharp.CSharpCodeProvider();
            }
            else if (sourceFile.Extension.ToUpper(CultureInfo.InvariantCulture) == ".VB")
            {
                provider = new Microsoft.VisualBasic.VBCodeProvider();
            }
            else
            {
                Console.WriteLine("Source file must have a .cs or .vb extension");
            }
            if (provider != null)
            {
                CodeGeneratorOptions options = new CodeGeneratorOptions();
                // Set code formatting options to your preference.
                options.BlankLinesBetweenMembers = true;
                options.BracingStyle = "C";

                StreamWriter sw = new StreamWriter(sourceName);
                provider.GenerateCodeFromCompileUnit(ccu, sw, options);
                sw.Close();
            }
        }
    }

    [DataContract]
    public class Person
    {
        [DataMember]
        public string FirstName;

        [DataMember]
        public string LastName;

        public Person(string newFName, string newLName)
        {
            FirstName = newFName;
            LastName = newLName;
        }
    }
}
Imports System.CodeDom.Compiler
Imports System.CodeDom
Imports System.Runtime.Serialization
Imports System.IO
Imports System.Xml
Imports System.Xml.Schema
Imports System.Globalization

Class Program
   
    Shared Sub Main(ByVal args() As String) 
        Try
            Dim schemas As XmlSchemaSet = Export()
            Dim ccu As CodeCompileUnit = Import(schemas)
            CompileCode(ccu, "Person.cs")
            CompileCode(ccu, "Person.vb")
        Catch exc As Exception
            Console.WriteLine("{0}: {1}", exc.Message, exc.StackTrace)
        Finally
            Console.WriteLine("Press <Enter> to end....")
            Console.ReadLine()
        End Try
    
    End Sub 
    
    Shared Function Export() As XmlSchemaSet 
        Dim ex As New XsdDataContractExporter()
        ex.Export(GetType(Person))
        Return ex.Schemas
    End Function
    Shared Function Import(ByVal schemas As XmlSchemaSet) As CodeCompileUnit 

        Dim imp As New XsdDataContractImporter()
       ' The EnableDataBinding option adds a RaisePropertyChanged method to
       ' the generated code. The GenerateInternal causes code access to be
       ' set to internal.
       Dim iOptions As New ImportOptions()
       iOptions.EnableDataBinding = true
       iOptions.GenerateInternal = true
       imp.Options = IOptions

        If imp.CanImport(schemas) Then
            imp.Import(schemas)
            Return imp.CodeCompileUnit
        Else
            Return Nothing
        End If
    End Function

    Shared Sub CompileCode(ByVal ccu As CodeCompileUnit, ByVal sourceName As String) 
        Dim provider As CodeDomProvider = Nothing
        Dim sourceFile As New FileInfo(sourceName)
        ' Select the code provider based on the input file extension, either C# or Visual Basic.
        If sourceFile.Extension.ToUpper(CultureInfo.InvariantCulture) = ".CS" Then
            provider = New Microsoft.CSharp.CSharpCodeProvider()
        ElseIf sourceFile.Extension.ToUpper(CultureInfo.InvariantCulture) = ".VB" Then
            provider = New Microsoft.VisualBasic.VBCodeProvider()
        Else
            Console.WriteLine("Source file must have a .cs or .vb extension")
        End If
        If Not (provider Is Nothing) Then
            Dim options As New CodeGeneratorOptions()
            ' Set code formatting options to your preference. 
            options.BlankLinesBetweenMembers = True
            options.BracingStyle = "C"
            
            Dim sw As New StreamWriter(sourceName)
            provider.GenerateCodeFromCompileUnit(ccu, sw, options)
            sw.Close()
        End If
    
    End Sub
End Class

<DataContract()>  _
Public Class Person
    <DataMember()>  _
    Public FirstName As String
    
    <DataMember()>  _
    Public LastName As String
    
    
    Public Sub New(ByVal newFName As String, ByVal newLName As String) 
        FirstName = newFName
        LastName = newLName
    
    End Sub 
End Class 

Uwagi

Użyj w XsdDataContractImporter przypadku tworzenia usługi sieci Web, która musi współdziałać z istniejącą usługą sieci Web, lub tworzyć typy kontraktów danych z schematów XML.Use the XsdDataContractImporter if you are creating a Web service that must interoperate with an existing Web service, or to create data contract types from XML schemas. XsdDataContractImporter spowoduje przekształcenie zestawu schematów XML i utworzenie typów .NET Framework, które reprezentują kontrakt danych w wybranym języku programowania.XsdDataContractImporter will transform a set of XML schemas and create the .NET Framework types that represent the data contract in a selected programming language. Aby utworzyć kod, użyj klas w System.CodeDom przestrzeni nazw.To create the code, use the classes in the System.CodeDom namespace.

Z drugiej strony, należy użyć XsdDataContractExporter klasy po utworzeniu usługi sieci Web, która zawiera dane reprezentowane przez typy CLR i kiedy trzeba wyeksportować schematy XML dla każdego typu danych, który ma być używany przez inne usługi sieci Web.Conversely, use the XsdDataContractExporter class when you have created a Web service that incorporates data represented by CLR types and when you need to export XML schemas for each data type to be consumed by other Web services. Oznacza to, że program XsdDataContractExporter przekształca zestaw typów CLR w zestaw schematów XML.That is, XsdDataContractExporter transforms a set of CLR types into a set of XML schemas.

Uwaga

Aby generować typy CLR ze schematów XML w czasie projektowania, użyj Narzędzia metadanych ServiceModel (Svcutil.exe).To generate CLR types from XML schemas at design time, use the ServiceModel Metadata Utility Tool (Svcutil.exe). Aby wygenerować kod z plików XSD, użyj /dataContractOnly przełącznika narzędzia.To generated code from XSD files, use the /dataContractOnly switch of the tool. Można również użyć, XsdDataContractImporter Jeśli potrzebna jest większa kontrola nad procesem lub trzeba ją programowo.You can also use the XsdDataContractImporter if you need more control over the process or need to do it programmatically.

Konstruktory

XsdDataContractImporter()

Inicjuje nowe wystąpienie klasy XsdDataContractImporter.Initializes a new instance of the XsdDataContractImporter class.

XsdDataContractImporter(CodeCompileUnit)

Inicjuje nowe wystąpienie XsdDataContractImporter klasy za pomocą CodeCompileUnit , która zostanie użyta do wygenerowania kodu CLR.Initializes a new instance of the XsdDataContractImporter class with the CodeCompileUnit that will be used to generate CLR code.

Właściwości

CodeCompileUnit

Pobiera CodeCompileUnit używany do przechowywania typów CLR.Gets a CodeCompileUnit used for storing the CLR types generated.

Options

Pobiera lub ustawia element ImportOptions , który zawiera opcje settable dla operacji importowania.Gets or sets an ImportOptions that contains settable options for the import operation.

Metody

CanImport(XmlSchemaSet)

Pobiera wartość wskazującą, czy schematy zawarte w elemencie XmlSchemaSet można przekształcać w obiekt CodeCompileUnit .Gets a value that indicates whether the schemas contained in an XmlSchemaSet can be transformed into a CodeCompileUnit.

CanImport(XmlSchemaSet, ICollection<XmlQualifiedName>)

Pobiera wartość wskazującą, czy określony zestaw typów zawartych w elemencie XmlSchemaSet może być przekształcony na typy CLR generowane w CodeCompileUnit .Gets a value that indicates whether the specified set of types contained in an XmlSchemaSet can be transformed into CLR types generated into a CodeCompileUnit.

CanImport(XmlSchemaSet, XmlQualifiedName)

Pobiera wartość wskazującą, czy schematy zawarte w elemencie XmlSchemaSet można przekształcać w obiekt CodeCompileUnit .Gets a value that indicates whether the schemas contained in an XmlSchemaSet can be transformed into a CodeCompileUnit.

CanImport(XmlSchemaSet, XmlSchemaElement)

Pobiera wartość wskazującą, czy określony element schematu zawarty w elemencie XmlSchemaSet może zostać zaimportowany.Gets a value that indicates whether a specific schema element contained in an XmlSchemaSet can be imported.

Equals(Object)

Określa, czy dany obiekt jest taki sam, jak bieżący obiekt.Determines whether the specified object is equal to the current object.

(Odziedziczone po Object)
GetCodeTypeReference(XmlQualifiedName)

Zwraca CodeTypeReference do typu CLR wygenerowanego dla typu schematu z określonym XmlQualifiedName .Returns a CodeTypeReference to the CLR type generated for the schema type with the specified XmlQualifiedName.

GetCodeTypeReference(XmlQualifiedName, XmlSchemaElement)

Zwraca CodeTypeReference dla określonego elementu kwalifikowanego XML i elementu schematu.Returns a CodeTypeReference for the specified XML qualified element and schema element.

GetHashCode()

Służy jako domyślna funkcja skrótu.Serves as the default hash function.

(Odziedziczone po Object)
GetKnownTypeReferences(XmlQualifiedName)

Zwraca listę CodeTypeReference obiektów reprezentujących znane typy wygenerowane podczas generowania kodu dla określonego typu schematu.Returns a list of CodeTypeReference objects that represents the known types generated when generating code for the specified schema type.

GetType()

Pobiera Type bieżące wystąpienie.Gets the Type of the current instance.

(Odziedziczone po Object)
Import(XmlSchemaSet)

Przekształca określony zestaw schematów XML zawartych w w XmlSchemaSet CodeCompileUnit .Transforms the specified set of XML schemas contained in an XmlSchemaSet into a CodeCompileUnit.

Import(XmlSchemaSet, ICollection<XmlQualifiedName>)

Przekształca określony zestaw typów schematu zawartych w XmlSchemaSet do typów CLR, które są generowane w CodeCompileUnit .Transforms the specified set of schema types contained in an XmlSchemaSet into CLR types generated into a CodeCompileUnit.

Import(XmlSchemaSet, XmlQualifiedName)

Przekształca określony typ schematu XML zawarty w XmlSchemaSet CodeCompileUnit .Transforms the specified XML schema type contained in an XmlSchemaSet into a CodeCompileUnit.

Import(XmlSchemaSet, XmlSchemaElement)

Przekształca określony element schematu w zestawie określonych schematów XML na CodeCompileUnit a i zwraca element XmlQualifiedName reprezentujący nazwę kontraktu danych dla określonego elementu.Transforms the specified schema element in the set of specified XML schemas into a CodeCompileUnit and returns an XmlQualifiedName that represents the data contract name for the specified element.

MemberwiseClone()

Tworzy skróconą kopię bieżącego elementu Object .Creates a shallow copy of the current Object.

(Odziedziczone po Object)
ToString()

Zwraca ciąg reprezentujący bieżący obiekt.Returns a string that represents the current object.

(Odziedziczone po Object)

Dotyczy

Zobacz też