ExportOptions ExportOptions ExportOptions ExportOptions Class

Definición

Representa las opciones que se pueden establecer para XsdDataContractExporter.Represents the options that can be set for an XsdDataContractExporter.

public ref class ExportOptions
public class ExportOptions
type ExportOptions = class
Public Class ExportOptions
Herencia
ExportOptionsExportOptionsExportOptionsExportOptions

Ejemplos

En el ejemplo siguiente se crea una instancia de la clase ExportOptions y se agrega un tipo (Possessions) a la colección que ha devuelto la propiedad KnownTypes.The following example creates an instance of the ExportOptions class and adds a type (Possessions) to the collection returned by the KnownTypes property.

A continuación XsdDataContractExporter exporta los esquemas de los tipos, incluso el tipo Possessions agregado a la colección.The XsdDataContractExporter then exports the schemas of the types, including the Possessions type added to the collection.

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

Comentarios

XsdDataContractExporter se utiliza para generar los esquemas XSD a partir de un tipo o ensamblado.The XsdDataContractExporter is used to generate XSD schemas from a type or assembly. También puede utilizar XsdDataContractImporter para generar el código .NET Framework.NET Framework a partir de un documento de esquema.You can also use the XsdDataContractImporter to generate .NET Framework.NET Framework code from a schema document.

Para obtener más información sobre la importación y exportación de esquemas, vea importación y exportación de esquemas a partir de clases.For more information about importing and exporting schemas, see Schema Import and Export and Exporting Schemas from Classes.

KnownTypes utiliza la propiedad DataContractSerializer para incluir tipos que pueden leerse en un gráfico de objetos.The KnownTypes property is used by the DataContractSerializer to include types that can be read in an object graph. Para obtener más información sobre el contrato de datos y los tipos conocidos, consulte Data Contract known Types.For more information about the data contract and known types, see Data Contract Known Types.

Para obtener más información sobre los contratos de datos, consulte uso de contratos de datos.For more information about data contracts, see Using Data Contracts.

Constructores

ExportOptions() ExportOptions() ExportOptions() ExportOptions()

Inicializa una nueva instancia de la clase ExportOptions.Initializes a new instance of the ExportOptions class.

Propiedades

DataContractSurrogate DataContractSurrogate DataContractSurrogate DataContractSurrogate

Obtiene o establece un suplente de serialización.Gets or sets a serialization surrogate.

KnownTypes KnownTypes KnownTypes KnownTypes

Obtiene la colección de tipos que se pueden encontrar durante la serialización o la deserialización.Gets the collection of types that may be encountered during serialization or deserialization.

Métodos

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determina si el objeto especificado es igual al objeto actual.Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Sirve como la función hash predeterminada.Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Obtiene el Type de la instancia actual.Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Crea una copia superficial del objeto Object actual.Creates a shallow copy of the current Object.

(Inherited from Object)
ToString() ToString() ToString() ToString()

Devuelve una cadena que representa el objeto actual.Returns a string that represents the current object.

(Inherited from Object)

Se aplica a

Consulte también: