XsdDataContractImporter Klasse
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Ermöglicht die Transformation einer Reihe von XML-Schemadateien (.xsd) in Common Language Runtime (CLR)-Typen.
public ref class XsdDataContractImporter
public class XsdDataContractImporter
type XsdDataContractImporter = class
Public Class XsdDataContractImporter
- Vererbung
-
XsdDataContractImporter
Beispiele
Im folgenden Beispiel wird ein XmlSchemaSet erstellt und die Import-Methode aufgerufen, um einen CodeCompileUnit zu erstellen. Der CodeCompileUnit wird dann verwendet, um sowohl Visual C#- als auch Visual Basic-Codedateien zu erstellen.
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
Hinweise
Verwenden Sie den XsdDataContractImporter, wenn Sie einen Webdienst erstellen, der mit einem bestehenden Webdienst zusammenarbeiten muss, oder um Datenvertragstypen aus XML-Schemas zu erstellen. XsdDataContractImportertransformiert einen Satz von XML-Schemas und erstellt die .NET Framework Typen, die den Datenvertrag in einer ausgewählten Programmiersprache darstellen. Um den Code zu erstellen, verwenden Sie die Klassen im System.CodeDom-Namespace.
Umgekehrt können Sie die XsdDataContractExporter-Klasse verwenden, wenn Sie einen Webdienst erstellt haben, der Daten enthält, die als CLR-Typen dargestellt werden, und wenn Sie für die von anderen Webdiensten zu verwendenden Datentypen XML-Schemas exportieren wollen. Dies bedeutet, dass XsdDataContractExporter einen Satz von CLR-Typen in einen Satz von XML-Schemas transformiert.
Hinweis
Verwenden Sie zum Generieren von CLR-Typen aus XML-Schemas zur Entwurfszeit das ServiceModel Metadata Utility Tool (Svcutil.exe). Um Code aus XSD-Dateien zu generieren, verwenden Sie den /dataContractOnly
Schalter des Tools. Sie können auch den XsdDataContractImporter verwenden, wenn Sie mehr Kontrolle über den Vorgang benötigen oder wenn dieser programmgesteuert sein muss.
Konstruktoren
XsdDataContractImporter() |
Initialisiert eine neue Instanz der XsdDataContractImporter-Klasse. |
XsdDataContractImporter(CodeCompileUnit) |
Initialisiert eine neue Instanz der XsdDataContractImporter-Klasse mit dem CodeCompileUnit, der zur Generierung von CLR-Code verwendet wird. |
Eigenschaften
CodeCompileUnit |
Ruft einen CodeCompileUnit auf, der zum Speichern der generierten CLR-Typen verwendet wird. |
Options |
Ruft einen ImportOptions auf, der festlegbare Optionen für den Importvorgang enthält, oder legt diesen fest. |
Methoden
CanImport(XmlSchemaSet) |
Ruft einen Wert ab, der angibt, ob die in einem XmlSchemaSet enthaltenen Schemas in einen CodeCompileUnit transformiert werden können. |
CanImport(XmlSchemaSet, ICollection<XmlQualifiedName>) |
Ruft einen Wert ab, der anzeigt, ob der in einem XmlSchemaSet enthaltene angegebene Typensatz in CLR-Typen transformiert werden kann, die in einen CodeCompileUnit generiert werden. |
CanImport(XmlSchemaSet, XmlQualifiedName) |
Ruft einen Wert ab, der angibt, ob die in einem XmlSchemaSet enthaltenen Schemas in einen CodeCompileUnit transformiert werden können. |
CanImport(XmlSchemaSet, XmlSchemaElement) |
Ruft einen Wert ab, der angibt, ob ein bestimmtes in einem XmlSchemaSet enthaltenes Schemaelement importiert werden kann. |
Equals(Object) |
Bestimmt, ob das angegebene Objekt gleich dem aktuellen Objekt ist. (Geerbt von Object) |
GetCodeTypeReference(XmlQualifiedName) |
Gibt einen CodeTypeReference an den CLR-Typ zurück, der für den Schematyp mit dem angegebenen XmlQualifiedName generiert wurde. |
GetCodeTypeReference(XmlQualifiedName, XmlSchemaElement) |
Gibt einen CodeTypeReference für das angegebene qualifizierte XML-Element und Schemaelement zurück. |
GetHashCode() |
Fungiert als Standardhashfunktion. (Geerbt von Object) |
GetKnownTypeReferences(XmlQualifiedName) |
Gibt eine Liste von CodeTypeReference-Objekten zurück, die die bekannten Typen darstellt, die bei der Generierung von Code für den angegebenen Schematyp erstellt wurden. |
GetType() |
Ruft den Type der aktuellen Instanz ab. (Geerbt von Object) |
Import(XmlSchemaSet) |
Transformiert den angegebenen Satz von XML-Schemas, die in einem XmlSchemaSet enthalten sind, in einen CodeCompileUnit. |
Import(XmlSchemaSet, ICollection<XmlQualifiedName>) |
Transformiert den angegebenen Satz von Schematypen, der in einem XmlSchemaSet enthalten ist, in CLR-Typen, die in einen CodeCompileUnit generiert werden. |
Import(XmlSchemaSet, XmlQualifiedName) |
Transformiert den angegebenen, in einem XmlSchemaSet enthaltenen XML-Schematyp in einen CodeCompileUnit. |
Import(XmlSchemaSet, XmlSchemaElement) |
Transformiert das angegebene Schemaelement in dem Satz angegebener XML-Schemas in einen CodeCompileUnit und gibt einen XmlQualifiedName zurück, der den Datenvertragsnamen für das angegebene Element darstellt. |
MemberwiseClone() |
Erstellt eine flache Kopie des aktuellen Object. (Geerbt von Object) |
ToString() |
Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt. (Geerbt von Object) |
Gilt für:
Weitere Informationen
Feedback
https://aka.ms/ContentUserFeedback.
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unterFeedback senden und anzeigen für