XsdDataContractImporter Класс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Позволяет преобразовать набор файлов схемы XML (XSD) в типы среды CLR.
public ref class XsdDataContractImporter
public class XsdDataContractImporter
type XsdDataContractImporter = class
Public Class XsdDataContractImporter
- Наследование
-
XsdDataContractImporter
Примеры
В следующем примере создается экземпляр класса XmlSchemaSet и вызывается метод Import для создания экземпляра класса CodeCompileUnit. Объект CodeCompileUnit затем используется для создания файлов кода на языках Visual C# и Visual Basic.
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
Комментарии
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преобразует набор xml-схем и создает типы платформа .NET Framework, представляющие контракт данных на выбранном языке программирования. Для создания кода используйте классы в пространстве имен System.CodeDom.
И наоборот, если была создана веб-служба, которая добавляет данные, представленные типами среды CLR, и требуется экспортировать схемы XML для каждого типа данных, используемого другими веб-службами, используйте класс XsdDataContractExporter. Таким образом, XsdDataContractExporter преобразует набор типов среды CLR в набор схем XML.
Примечание
Чтобы создать типы CLR на основе XML-схем во время разработки, используйте служебную программу метаданных ServiceModel (Svcutil.exe). Чтобы создать код из XSD-файлов, используйте /dataContractOnly
параметр средства . Кроме того, класс XsdDataContractImporter можно использовать при необходимости дополнительных средств управления процессом или необходимости программного управления.
Конструкторы
XsdDataContractImporter() |
Инициализирует новый экземпляр класса XsdDataContractImporter. |
XsdDataContractImporter(CodeCompileUnit) |
Инициализирует новый экземпляр класса XsdDataContractImporter с CodeCompileUnit, который будет использоваться для создания кода среды CLR. |
Свойства
CodeCompileUnit |
Возвращает объект CodeCompileUnit, используемый для хранения созданных типов среды CLR. |
Options |
Получает или задает объект ImportOptions, содержащий параметры, которые могут быть заданы для операции импорта. |
Методы
CanImport(XmlSchemaSet) |
Возвращает значение, указывающее, можно ли преобразовать схемы, содержащиеся в XmlSchemaSet, в объект CodeCompileUnit. |
CanImport(XmlSchemaSet, ICollection<XmlQualifiedName>) |
Возвращает значение, указывающее, возможно ли преобразование набора типов, содержащегося в объекте XmlSchemaSet, в типы CLR, созданные в объекте CodeCompileUnit. |
CanImport(XmlSchemaSet, XmlQualifiedName) |
Возвращает значение, указывающее, можно ли преобразовать схемы, содержащиеся в XmlSchemaSet, в объект CodeCompileUnit. |
CanImport(XmlSchemaSet, XmlSchemaElement) |
Возвращает значение, указывающее, можно ли импортировать конкретный элемент схемы, содержащийся в объекте XmlSchemaSet. |
Equals(Object) |
Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object) |
GetCodeTypeReference(XmlQualifiedName) |
Возвращает CodeTypeReference типу среды CLR, созданному для типа схемы с указанным XmlQualifiedName. |
GetCodeTypeReference(XmlQualifiedName, XmlSchemaElement) |
Возвращает объект CodeTypeReference для указанного полного XML-элемента и элемента схемы XML. |
GetHashCode() |
Служит хэш-функцией по умолчанию. (Унаследовано от Object) |
GetKnownTypeReferences(XmlQualifiedName) |
Возвращает список объектов CodeTypeReference, представляющий известные типы, созданные при создании кода для указанного типа схемы. |
GetType() |
Возвращает объект Type для текущего экземпляра. (Унаследовано от Object) |
Import(XmlSchemaSet) |
Преобразует указанный набор схем XML, содержащийся в объекте XmlSchemaSet, в объект CodeCompileUnit. |
Import(XmlSchemaSet, ICollection<XmlQualifiedName>) |
Преобразует указанный набор типов схемы XML, содержащийся в объекте XmlSchemaSet, в типы CLR, созданные в объекте CodeCompileUnit. |
Import(XmlSchemaSet, XmlQualifiedName) |
Преобразует указанный тип схемы XML, содержащийся в объекте XmlSchemaSet, в объект CodeCompileUnit. |
Import(XmlSchemaSet, XmlSchemaElement) |
Преобразует указанный элемент схемы из набора указанных схем XML в объект CodeCompileUnit и возвращает XmlQualifiedName, представляющий имя контракта данных для указанного элемента. |
MemberwiseClone() |
Создает неполную копию текущего объекта Object. (Унаследовано от Object) |
ToString() |
Возвращает строку, представляющую текущий объект. (Унаследовано от Object) |
Применяется к
См. также раздел
Обратная связь
https://aka.ms/ContentUserFeedback.
Ожидается в ближайшее время: в течение 2024 года мы постепенно откажемся от GitHub Issues как механизма обратной связи для контента и заменим его новой системой обратной связи. Дополнительные сведения см. в разделеОтправить и просмотреть отзыв по