XmlSchemaSet Clase

Referencia

Definición

Espacio de nombres:: System.Xml.Schema

Ensamblado:: System.Xml.ReaderWriter.dll

Ensamblado:: System.Xml.dll

Ensamblado:: netstandard.dll

Importante

Parte de la información hace referencia a la versión preliminar del producto, que puede haberse modificado sustancialmente antes de lanzar la versión definitiva. Microsoft no otorga ninguna garantía, explícita o implícita, con respecto a la información proporcionada aquí.

Contiene una caché de esquemas del lenguaje de definición de esquemas XML (XSD).

public ref class XmlSchemaSet

public class XmlSchemaSet

type XmlSchemaSet = class

Public Class XmlSchemaSet

Herencia: Object
XmlSchemaSet

Ejemplos

El siguiente ejemplo valida un archivo XML utilizando los esquemas almacenados en el XmlSchemaSet. El espacio de nombres del archivo XML, urn:bookstore-schema, identifica qué esquema del XmlSchemaSet se va a utilizar para la validación. La salida del ejemplo muestra que el archivo XML tiene dos infracciones de esquema:

El primer <book> elemento contiene un <author> elemento pero ningún <title> elemento o <price> .
El <author> elemento del último <book> elemento falta un <first-name> elemento y y <last-name> , en su lugar, tiene un elemento no válido <name> .

#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'.

Entrada

En el ejemplo se utilizan los dos archivos de entrada siguientes.

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:

<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 use esquemas de orígenes o ubicaciones desconocidos o que no sean de confianza. Si lo hace, se pondrá en peligro la seguridad del código.
Los esquemas XML (incluidos los esquemas insertados) son intrínsecamente vulnerables a ataques de denegación de servicio; no los acepte en escenarios que no son de confianza.
Los mensajes de error y las excepciones de validación de esquemas pueden exponer información confidencial sobre el modelo de contenido o las rutas de acceso de URI al archivo de esquema. Tenga cuidado de no exponer esta información a los autores de llamadas que no son de confianza.
En la sección "Consideraciones de seguridad" se tratan consideraciones de seguridad adicionales.

XmlSchemaSet es una memoria caché o biblioteca donde puede almacenar esquemas del lenguaje de definición de esquemas XML (XSD). XmlSchemaSet mejora el rendimiento mediante el almacenamiento en caché de esquemas en la memoria en lugar de acceder a ellos desde un archivo o una dirección URL. Cada esquema se identifica mediante el URI del espacio de nombres y la ubicación que se especificó cuando se agregó el esquema al conjunto. La propiedad se usa XmlReaderSettings.Schemas para asignar el XmlSchemaSet objeto que debe usar un lector XML para la validación de datos.

Consideraciones sobre la seguridad

No use esquemas de orígenes desconocidos o que no son de confianza. Si lo hace, se pondrá en peligro la seguridad del código. Los espacios de nombres externos o las ubicaciones a las que se hace referencia en incluyen, importan y vuelven a definir elementos de un esquema se resuelven con respecto al URI base del esquema que los incluye o importa. Por ejemplo, si el URI base del esquema de inclusión o importación está vacío o null, las ubicaciones externas se resuelven con respecto al directorio actual. La XmlUrlResolver clase se usa para resolver esquemas externos de forma predeterminada. Para deshabilitar la resolución de inclusión, importación y redefinición de elementos de un esquema, establezca la XmlSchemaSet.XmlResolver propiedad nullen .
La XmlSchemaSet clase usa la System.Text.RegularExpressions.Regex clase para analizar y buscar coincidencias con expresiones regulares en un esquema XML. La 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.
Las excepciones generadas como resultado del uso de la XmlSchemaSet clase , como la XmlSchemaException clase , pueden contener información confidencial que no se debe exponer en escenarios que no son de confianza. Por ejemplo, la SourceUri propiedad de devuelve XmlSchemaException la ruta de acceso del URI al archivo de esquema que provocó la excepción. La SourceUri propiedad no debe exponerse en escenarios que no son de confianza. Las excepciones deben controlarse correctamente para que esta información confidencial no se exponga en escenarios que no son de confianza.

Constructores

XmlSchemaSet()	Inicializa una nueva instancia de la clase XmlSchemaSet.
XmlSchemaSet(XmlNameTable)	Inicializa una nueva instancia de la clase XmlSchemaSet con el objeto XmlNameTable especificado.

Propiedades

CompilationSettings	Obtiene o establece el objeto XmlSchemaCompilationSettings para XmlSchemaSet.
Count	Obtiene el número de esquemas lógicos del lenguaje de definición de esquemas XML (XSD) que hay en XmlSchemaSet.
GlobalAttributes	Obtiene todos los atributos globales de todos los esquemas del lenguaje de definición de esquemas XML (XSD) que hay en XmlSchemaSet.
GlobalElements	Obtiene todos los elementos globales de todos los esquemas del lenguaje de definición de esquemas XML (XSD) que hay en XmlSchemaSet.
GlobalTypes	Obtiene todos los tipos simples y complejos de los esquemas del lenguaje de definición de esquemas XML (XSD) que hay en XmlSchemaSet.
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.
NameTable	Obtiene el objeto XmlNameTable predeterminado que utiliza XmlSchemaSet al cargar los nuevos esquemas del lenguaje de definición de esquemas XML (XSD).
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.

Métodos

Add(String, String)	Agrega el esquema del lenguaje de definición de esquemas XML (XSD) de la dirección URL especificada a XmlSchemaSet.
Add(String, XmlReader)	Agrega el esquema del lenguaje de definición de esquemas XML (XSD) incluido en XmlReader a XmlSchemaSet.
Add(XmlSchema)	Agrega el XmlSchema predeterminado a XmlSchemaSet.
Add(XmlSchemaSet)	Agrega todos los esquemas del lenguaje de definición de esquemas XML (XSD) de la clase XmlSchemaSet especificada a XmlSchemaSet.
Compile()	Compila los esquemas del lenguaje de definición de esquemas XML (XSD) agregados a XmlSchemaSet en un esquema lógico.
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.
Contains(XmlSchema)	Indica si el objeto XmlSchema especificado del lenguaje de definición de esquemas XML (XSD) está en XmlSchemaSet.
CopyTo(XmlSchema[], Int32)	Copia todos los objetos XmlSchema de XmlSchemaSet en la matriz especificada a partir del índice indicado.
Equals(Object)	Determina si el objeto especificado es igual que el objeto actual. (Heredado de Object)
GetHashCode()	Sirve como la función hash predeterminada. (Heredado de Object)
GetType()	Obtiene el Type de la instancia actual. (Heredado de Object)
MemberwiseClone()	Crea una copia superficial del Object actual. (Heredado de Object)
Remove(XmlSchema)	Quita el esquema del lenguaje de definición de esquemas XML (XSD) especificado de XmlSchemaSet.
RemoveRecursive(XmlSchema)	Quita el esquema del lenguaje de definición de esquemas XML (XSD) especificado y todos los esquemas que importa de XmlSchemaSet.
Reprocess(XmlSchema)	Vuelve a procesar un esquema del lenguaje de definición de esquemas XML (XSD) que ya existe en XmlSchemaSet.
Schemas()	Devuelve una colección de todos los esquemas del lenguaje de definición de esquemas XML (XSD) de XmlSchemaSet.
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.
ToString()	Devuelve una cadena que representa el objeto actual. (Heredado de Object)

Eventos

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).

Se aplica a