XmlSchemaSet XmlSchemaSet XmlSchemaSet XmlSchemaSet Class

Definición

Contiene una caché de esquemas del lenguaje de definición de esquemas XML (XSD).Contains a cache of XML Schema definition language (XSD) schemas.

public ref class XmlSchemaSet
public class XmlSchemaSet
type XmlSchemaSet = class
Public Class XmlSchemaSet
Herencia
XmlSchemaSetXmlSchemaSetXmlSchemaSetXmlSchemaSet

Ejemplos

El siguiente ejemplo valida un archivo XML utilizando los esquemas almacenados en el XmlSchemaSet.The following example validates an XML file using schemas stored in the XmlSchemaSet. El espacio de nombres del archivo XML, urn:bookstore-schema, identifica qué esquema del XmlSchemaSet se va a utilizar para la validación.The namespace in the XML file, urn:bookstore-schema, identifies which schema in the XmlSchemaSet to use for validation. Resultado del ejemplo muestra que el archivo XML tiene dos infracciones de esquema:Output from the example shows that the XML file has two schema violations:

  • La primera <book > elemento contiene un <Autor > elemento pero no <title > o <precio > elemento.The first <book> element contains an <author> element but no <title> or <price> element.

  • El <Autor > elemento en el último <book > Falta el elemento un <first-name > y <last-name > elemento y tiene en su lugar, no es válido <nombre > elemento.The <author> element in the last <book> element is missing a <first-name> and <last-name> element and instead has an invalid <name> element.

#using <System.Xml.dll>

using namespace System;
using namespace System::Xml;
using namespace System::Xml::Schema;
using namespace System::IO;

// Display any validation errors.
static void ValidationCallBack( Object^ /*sender*/, ValidationEventArgs^ e )
{
   Console::WriteLine( L"Validation Error:\n   {0}", e->Message );
   Console::WriteLine();
}

int main()
{
   // Create the XmlSchemaSet class.
   XmlSchemaSet^ sc = gcnew XmlSchemaSet;

   // Add the schema to the collection.
   sc->Add( L"urn:bookstore-schema", L"books.xsd" );

   // Set the validation settings.
   XmlReaderSettings^ settings = gcnew XmlReaderSettings;
   settings->ValidationType = ValidationType::Schema;
   settings->Schemas = sc;
   settings->ValidationEventHandler += gcnew ValidationEventHandler(ValidationCallBack);

   // Create the XmlReader object.
   XmlReader^ reader = XmlReader::Create( L"booksSchemaFail.xml", settings );

   // Parse the file. 
   while ( reader->Read() )
      ;

   return 1;
}
// The example displays output like the following:
//   Validation Error: 
//        The element 'book' in namespace 'urn:bookstore-schema' has invalid child element 'author' 
//        in namespace 'urn:bookstore-schema'. List of possible elements expected: 'title' in 
//        namespace 'urn:bookstore-schema'.
//
//    Validation Error: 
//       The element 'author' in namespace 'urn:bookstore-schema' has invalid child element 'name' 
//       in namespace 'urn:bookstore-schema'. List of possible elements expected: 'first-name' in 
//       namespace 'urn:bookstore-schema'.
using System;
using System.Xml;
using System.Xml.Schema;
using System.IO;

public class Sample 
{
  public static void Main() {

    // Create the XmlSchemaSet class.
    XmlSchemaSet sc = new XmlSchemaSet();

    // Add the schema to the collection.
    sc.Add("urn:bookstore-schema", "books.xsd");

    // Set the validation settings.
    XmlReaderSettings settings = new XmlReaderSettings();
    settings.ValidationType = ValidationType.Schema;
    settings.Schemas = sc;
    settings.ValidationEventHandler += ValidationCallBack;
 
    // Create the XmlReader object.
    XmlReader reader = XmlReader.Create("booksSchemaFail.xml", settings);

    // Parse the file. 
    while (reader.Read());
  }

  // Display any validation errors.
  private static void ValidationCallBack(object sender, ValidationEventArgs e) {
    Console.WriteLine($"Validation Error:\n   {e.Message}\n");
  }
}
// The example displays output like the following:
//   Validation Error: 
//        The element 'book' in namespace 'urn:bookstore-schema' has invalid child element 'author' 
//        in namespace 'urn:bookstore-schema'. List of possible elements expected: 'title' in 
//        namespace 'urn:bookstore-schema'.
//
//    Validation Error: 
//       The element 'author' in namespace 'urn:bookstore-schema' has invalid child element 'name' 
//       in namespace 'urn:bookstore-schema'. List of possible elements expected: 'first-name' in 
//       namespace 'urn:bookstore-schema'.
Imports System.Xml
Imports System.Xml.Schema
Imports System.IO

Public Module Sample 
  Public Sub Main() 

    ' Create the XmlSchemaSet class.
    Dim sc as XmlSchemaSet = new XmlSchemaSet()

    ' Add the schema to the collection.
    sc.Add("urn:bookstore-schema", "books.xsd")

    ' Set the validation settings.
    Dim settings as XmlReaderSettings = new XmlReaderSettings()
    settings.ValidationType = ValidationType.Schema
    settings.Schemas = sc
    AddHandler settings.ValidationEventHandler, AddressOf ValidationCallBack
 
    ' Create the XmlReader object.
    Dim reader as XmlReader = XmlReader.Create("booksSchemaFail.xml", settings)

    ' Parse the file. 
    While reader.Read()
    End While
    
  End Sub

  ' Display any validation errors.
  Private Sub ValidationCallBack(sender as object, e as ValidationEventArgs) 
    Console.WriteLine($"Validation Error:{vbCrLf}   {e.Message}")
    Console.WriteLine()
  End Sub
End Module
' The example displays output like the following:
'   Validation Error: 
'        The element 'book' in namespace 'urn:bookstore-schema' has invalid child element 'author' 
'        in namespace 'urn:bookstore-schema'. List of possible elements expected: 'title' in 
'        namespace 'urn:bookstore-schema'.
'
'    Validation Error: 
'       The element 'author' in namespace 'urn:bookstore-schema' has invalid child element 'name' 
'       in namespace 'urn:bookstore-schema'. List of possible elements expected: 'first-name' in 
'       namespace 'urn:bookstore-schema'.

EntradaInput

En el ejemplo se utilizan los dos archivos de entrada siguientes.The sample uses the following two input files.

booksSchemaFail.xml:booksSchemaFail.xml:

<?xml version='1.0'?>
<bookstore xmlns="urn:bookstore-schema">
  <book>
    <author>
      <first-name>Benjamin</first-name>
      <last-name>Franklin</last-name>
    </author>
  </book>
  <book genre="novel">
    <title>The Confidence Man</title>
    <author>
      <first-name>Herman</first-name>
      <last-name>Melville</last-name>
    </author>
    <price>11.99</price>
  </book>
  <book genre="philosophy">
    <title>The Gorgias</title>
    <author>
      <name>Plato</name>
    </author>
    <price>9.99</price>
  </book>
</bookstore>

books.xsd:books.xsd:

<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
    xmlns="urn:bookstore-schema"
    elementFormDefault="qualified"
    targetNamespace="urn:bookstore-schema">

 <xsd:element name="bookstore" type="bookstoreType"/>

 <xsd:complexType name="bookstoreType">
  <xsd:sequence maxOccurs="unbounded">
   <xsd:element name="book"  type="bookType"/>
  </xsd:sequence>
 </xsd:complexType>

 <xsd:complexType name="bookType">
  <xsd:sequence>
   <xsd:element name="title" type="xsd:string"/>
   <xsd:element name="author" type="authorName"/>
   <xsd:element name="price"  type="xsd:decimal"/>
  </xsd:sequence>
  <xsd:attribute name="genre" type="xsd:string"/>
 </xsd:complexType>

 <xsd:complexType name="authorName">
  <xsd:sequence>
   <xsd:element name="first-name"  type="xsd:string"/>
   <xsd:element name="last-name" type="xsd:string"/>
  </xsd:sequence>
 </xsd:complexType>

</xsd:schema>

Comentarios

Importante

  • No utilizar esquemas desde orígenes desconocidos o que no se confía o ubicaciones.Do not use schemas from unknown or untrusted sources or locations. Si lo hace, compromete la seguridad del código.Doing so will compromise the security of your code.
  • Esquemas XML (incluidos los esquemas en línea) son intrínsecamente vulnerables a la denegación de servicio; no los acepta en escenarios de confianza.XML schemas (including inline schemas) are inherently vulnerable to denial of service attacks; do not accept them in untrusted scenarios.
  • Excepciones y mensajes de error de validación de esquema pueden exponer información confidencial sobre el modelo de contenido o las rutas de acceso URI para el archivo de esquema.Schema validation error messages and exceptions may expose sensitive information about the content model or URI paths to the schema file. Tenga cuidado de no exponer esta información a los llamadores de confianza.Be careful not to expose this information to untrusted callers.
  • Consideraciones de seguridad adicionales se tratan en la sección "Consideraciones de seguridad".Additional security considerations are covered in the "Security Considerations" section.

XmlSchemaSet es una caché o biblioteca donde puede almacenar esquemas (XSD).XmlSchemaSet is a cache or library where you can store XML Schema definition language (XSD) schemas. XmlSchemaSet mejora el rendimiento al almacenar en memoria caché los esquemas, en lugar obtener acceso a ellos desde un archivo o dirección URL.XmlSchemaSet improves performance by caching schemas in memory instead of accessing them from a file or a URL. Cada esquema se identifica mediante el URI de espacio de nombres y ubicación que se ha especificado cuando el esquema se agregó al conjunto.Each schema is identified by the namespace URI and location that was specified when the schema was added to the set. Usa el XmlReaderSettings.Schemas propiedad para asignar el XmlSchemaSet debe usar un lector de XML para la validación de datos de objeto.You use the XmlReaderSettings.Schemas property to assign the XmlSchemaSet object an XML reader should use for data validation.

Consideraciones de seguridadSecurity Considerations

  • No utilizar esquemas de orígenes desconocidos o que no se confía.Do not use schemas from unknown or untrusted sources. Si lo hace, compromete la seguridad del código.Doing so will compromise the security of your code. Espacios de nombres externos o las ubicaciones que se hace referenciadas en incluyen, importación y elementos de redefinición de un esquema se resuelven con respecto a la URI base del esquema que incluye o importa.External namespaces or locations referenced in include, import, and redefine elements of a schema are resolved with respect to the base URI of the schema that includes or imports them. Por ejemplo, si el URI base de inclusión o importación de esquema está vacío o null, las ubicaciones externas se resuelven con respecto al directorio actual.For example, if the base URI of the including or importing schema is empty or null, the external locations are resolved with respect to the current directory. La XmlUrlResolver clase se utiliza para resolver los esquemas externos de forma predeterminada.The XmlUrlResolver class is used to resolve external schemas by default. Para deshabilitar la resolución de inclusión, importación y volver a definir los elementos de un esquema, establezca el XmlSchemaSet.XmlResolver propiedad null.To disable resolution of include, import, and redefine elements of a schema, set the XmlSchemaSet.XmlResolver property to null.

  • El XmlSchemaSet clase utiliza la System.Text.RegularExpressions.Regex clase para analizar y buscar coincidencias de expresiones regulares en un esquema XML.The XmlSchemaSet class uses the System.Text.RegularExpressions.Regex class to parse and match regular expressions in an XML schema. Validación de facetas de patrón con expresiones regulares en un esquema XML puede implicar un mayor uso de CPU y debe evitarse en escenarios de alta disponibilidad.Validation of pattern facets with regular expressions in an XML schema may involve increased CPU usage and should be avoided in high availability scenarios.

  • Las excepciones generadas como resultado de utilizar el XmlSchemaSet clase, como el XmlSchemaException clase puede contener información confidencial que no debe exponerse en escenarios de confianza.Exceptions raised as a result of using the XmlSchemaSet class, such as the XmlSchemaException class may contain sensitive information that should not be exposed in untrusted scenarios. Por ejemplo, el SourceUri propiedad de un XmlSchemaException devuelve la ruta de acceso URI para el archivo de esquema que produjo la excepción.For example, the SourceUri property of an XmlSchemaException returns the URI path to the schema file that caused the exception. El SourceUri propiedad no debe exponerse en escenarios de confianza.The SourceUri property should not be exposed in untrusted scenarios. Las excepciones se deben administrar correctamente para que esta información confidencial no se expone en escenarios de confianza.Exceptions should be properly handled so that this sensitive information is not exposed in untrusted scenarios.

Constructores

XmlSchemaSet() XmlSchemaSet() XmlSchemaSet() XmlSchemaSet()

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

XmlSchemaSet(XmlNameTable) XmlSchemaSet(XmlNameTable) XmlSchemaSet(XmlNameTable) XmlSchemaSet(XmlNameTable)

Inicializa una nueva instancia de la clase XmlSchemaSet con el objeto XmlNameTable especificado.Initializes a new instance of the XmlSchemaSet class with the specified XmlNameTable.

Propiedades

CompilationSettings CompilationSettings CompilationSettings CompilationSettings

Obtiene o establece el objeto XmlSchemaCompilationSettings para XmlSchemaSet.Gets or sets the XmlSchemaCompilationSettings for the XmlSchemaSet.

Count Count Count Count

Obtiene el número de esquemas lógicos del lenguaje de definición de esquemas XML (XSD) que hay en XmlSchemaSet.Gets the number of logical XML Schema definition language (XSD) schemas in the XmlSchemaSet.

GlobalAttributes GlobalAttributes GlobalAttributes GlobalAttributes

Obtiene todos los atributos globales de todos los esquemas del lenguaje de definición de esquemas XML (XSD) que hay en XmlSchemaSet.Gets all the global attributes in all the XML Schema definition language (XSD) schemas in the XmlSchemaSet.

GlobalElements GlobalElements GlobalElements GlobalElements

Obtiene todos los elementos globales de todos los esquemas del lenguaje de definición de esquemas XML (XSD) que hay en XmlSchemaSet.Gets all the global elements in all the XML Schema definition language (XSD) schemas in the XmlSchemaSet.

GlobalTypes GlobalTypes GlobalTypes GlobalTypes

Obtiene todos los tipos simples y complejos de los esquemas del lenguaje de definición de esquemas XML (XSD) que hay en XmlSchemaSet.Gets all of the global simple and complex types in all the XML Schema definition language (XSD) schemas in the XmlSchemaSet.

IsCompiled IsCompiled IsCompiled IsCompiled

Obtiene un valor que indica si los esquemas del lenguaje de definición de esquemas XML (XSD) que hay en XmlSchemaSet han sido compilados.Gets a value that indicates whether the XML Schema definition language (XSD) schemas in the XmlSchemaSet have been compiled.

NameTable NameTable NameTable NameTable

Obtiene el objeto XmlNameTable predeterminado que utiliza XmlSchemaSet al cargar los nuevos esquemas del lenguaje de definición de esquemas XML (XSD).Gets the default XmlNameTable used by the XmlSchemaSet when loading new XML Schema definition language (XSD) schemas.

XmlResolver XmlResolver XmlResolver XmlResolver

Establece el objeto XmlResolver utilizado para resolver espacios de nombres o ubicaciones a las que se hace referencia en los elementos de inclusión e importación de un esquema.Sets the XmlResolver used to resolve namespaces or locations referenced in include and import elements of a schema.

Métodos

Add(String, String) Add(String, String) Add(String, String) Add(String, String)

Agrega el esquema del lenguaje de definición de esquemas XML (XSD) de la dirección URL especificada a XmlSchemaSet.Adds the XML Schema definition language (XSD) schema at the URL specified to the XmlSchemaSet.

Add(String, XmlReader) Add(String, XmlReader) Add(String, XmlReader) Add(String, XmlReader)

Agrega el esquema del lenguaje de definición de esquemas XML (XSD) incluido en XmlReader a XmlSchemaSet.Adds the XML Schema definition language (XSD) schema contained in the XmlReader to the XmlSchemaSet.

Add(XmlSchema) Add(XmlSchema) Add(XmlSchema) Add(XmlSchema)

Agrega el XmlSchema predeterminado a XmlSchemaSet.Adds the given XmlSchema to the XmlSchemaSet.

Add(XmlSchemaSet) Add(XmlSchemaSet) Add(XmlSchemaSet) Add(XmlSchemaSet)

Agrega todos los esquemas del lenguaje de definición de esquemas XML (XSD) de la clase XmlSchemaSet especificada a XmlSchemaSet.Adds all the XML Schema definition language (XSD) schemas in the given XmlSchemaSet to the XmlSchemaSet.

Compile() Compile() Compile() Compile()

Compila los esquemas del lenguaje de definición de esquemas XML (XSD) agregados a XmlSchemaSet en un esquema lógico.Compiles the XML Schema definition language (XSD) schemas added to the XmlSchemaSet into one logical schema.

Contains(String) Contains(String) Contains(String) Contains(String)

Indica si un esquema del lenguaje de definición de esquemas XML (XSD) con el URI del espacio de nombres de destino especificado está en XmlSchemaSet.Indicates whether an XML Schema definition language (XSD) schema with the specified target namespace URI is in the XmlSchemaSet.

Contains(XmlSchema) Contains(XmlSchema) Contains(XmlSchema) Contains(XmlSchema)

Indica si el objeto XmlSchema especificado del lenguaje de definición de esquemas XML (XSD) está en XmlSchemaSet.Indicates whether the specified XML Schema definition language (XSD) XmlSchema object is in the XmlSchemaSet.

CopyTo(XmlSchema[], Int32) CopyTo(XmlSchema[], Int32) CopyTo(XmlSchema[], Int32) CopyTo(XmlSchema[], Int32)

Copia todos los objetos XmlSchema de XmlSchemaSet en la matriz especificada a partir del índice indicado.Copies all the XmlSchema objects from the XmlSchemaSet to the given array, starting at the given index.

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)
Remove(XmlSchema) Remove(XmlSchema) Remove(XmlSchema) Remove(XmlSchema)

Quita el esquema del lenguaje de definición de esquemas XML (XSD) especificado de XmlSchemaSet.Removes the specified XML Schema definition language (XSD) schema from the XmlSchemaSet.

RemoveRecursive(XmlSchema) RemoveRecursive(XmlSchema) RemoveRecursive(XmlSchema) RemoveRecursive(XmlSchema)

Quita el esquema del lenguaje de definición de esquemas XML (XSD) especificado y todos los esquemas que importa de XmlSchemaSet.Removes the specified XML Schema definition language (XSD) schema and all the schemas it imports from the XmlSchemaSet.

Reprocess(XmlSchema) Reprocess(XmlSchema) Reprocess(XmlSchema) Reprocess(XmlSchema)

Vuelve a procesar un esquema del lenguaje de definición de esquemas XML (XSD) que ya existe en XmlSchemaSet.Reprocesses an XML Schema definition language (XSD) schema that already exists in the XmlSchemaSet.

Schemas() Schemas() Schemas() Schemas()

Devuelve una colección de todos los esquemas del lenguaje de definición de esquemas XML (XSD) de XmlSchemaSet.Returns a collection of all the XML Schema definition language (XSD) schemas in the XmlSchemaSet.

Schemas(String) Schemas(String) Schemas(String) Schemas(String)

Devuelve una colección de todos los esquemas del lenguaje de definición de esquemas XML (XSD) que hay en XmlSchemaSet y que pertenecen al espacio de nombres especificado.Returns a collection of all the XML Schema definition language (XSD) schemas in the XmlSchemaSet that belong to the given namespace.

ToString() ToString() ToString() ToString()

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

(Inherited from Object)

Eventos

ValidationEventHandler ValidationEventHandler ValidationEventHandler ValidationEventHandler

Especifica un controlador de eventos para recibir información sobre los errores de validación de esquemas del lenguaje de definición de esquemas XML (XSD).Specifies an event handler for receiving information about XML Schema definition language (XSD) schema validation errors.

Se aplica a