XmlSchemaSet.Add Method

Definition

Добавляет заданную схему языка определения схем XML (XSD) в XmlSchemaSet.Adds the given XML Schema definition language (XSD) schema to the XmlSchemaSet.

Overloads

Add(XmlSchema)

Добавляет указанную XmlSchema в XmlSchemaSet.Adds the given XmlSchema to the XmlSchemaSet.

Add(XmlSchemaSet)

Добавляет все схемы языка определения схем XML (XSD), содержащиеся в заданном XmlSchemaSet, в XmlSchemaSet.Adds all the XML Schema definition language (XSD) schemas in the given XmlSchemaSet to the XmlSchemaSet.

Add(String, String)

Добавляет схему языка определения схем XML (XSD), расположенную по указанному URL-адресу, в XmlSchemaSet.Adds the XML Schema definition language (XSD) schema at the URL specified to the XmlSchemaSet.

Add(String, XmlReader)

Добавляет схему языка определения схем XML (XSD), содержащуюся в XmlReader, в XmlSchemaSet.Adds the XML Schema definition language (XSD) schema contained in the XmlReader to the XmlSchemaSet.

Add(XmlSchema)

Добавляет указанную XmlSchema в XmlSchemaSet.Adds the given XmlSchema to the XmlSchemaSet.

public:
 System::Xml::Schema::XmlSchema ^ Add(System::Xml::Schema::XmlSchema ^ schema);
public System.Xml.Schema.XmlSchema Add (System.Xml.Schema.XmlSchema schema);
member this.Add : System.Xml.Schema.XmlSchema -> System.Xml.Schema.XmlSchema
Public Function Add (schema As XmlSchema) As XmlSchema

Parameters

schema
XmlSchema

Объект XmlSchema, добавляемый в коллекцию XmlSchemaSet.The XmlSchema object to add to the XmlSchemaSet.

Returns

XmlSchema

Объект XmlSchema, если схема успешно прошла проверку.An XmlSchema object if the schema is valid. Если схема не прошла проверку и задан ValidationEventHandler, тогда возвращается null и возникает соответствующее событие проверки.If the schema is not valid and a ValidationEventHandler is specified, then null is returned and the appropriate validation event is raised. В противном случае возникает исключение XmlSchemaException.Otherwise, an XmlSchemaException is thrown.

Exceptions

Схема не прошла проверку.The schema is not valid.

Объект XmlSchema, переданный в качестве параметра, является null.The XmlSchema object passed as a parameter is null.

Remarks

Если объект XmlSchema уже существует в XmlSchemaSet, метод Add не выполняет никаких действий.If the XmlSchema object already exists in the XmlSchemaSet, the Add method does nothing.

Функциональность этого метода идентична функции метода Add.The functionality of this method is identical to that of the Add method.

Add(XmlSchemaSet)

Добавляет все схемы языка определения схем XML (XSD), содержащиеся в заданном XmlSchemaSet, в XmlSchemaSet.Adds all the XML Schema definition language (XSD) schemas in the given XmlSchemaSet to the XmlSchemaSet.

public:
 void Add(System::Xml::Schema::XmlSchemaSet ^ schemas);
public void Add (System.Xml.Schema.XmlSchemaSet schemas);
member this.Add : System.Xml.Schema.XmlSchemaSet -> unit
Public Sub Add (schemas As XmlSchemaSet)

Parameters

schemas
XmlSchemaSet

Объект XmlSchemaSet.The XmlSchemaSet object.

Exceptions

Схема в XmlSchemaSet недействительна.A schema in the XmlSchemaSet is not valid.

Объект XmlSchemaSet, переданный в качестве параметра, является null.The XmlSchemaSet object passed as a parameter is null.

Examples

В следующем примере кода показано добавление схем в XmlSchemaSet, а затем Добавление XmlSchemaSet в новый XmlSchemaSet с помощью метода Add.The following code example illustrates adding schemas to an XmlSchemaSet, then adding the XmlSchemaSet to a new XmlSchemaSet using the Add method.

Dim schemaSet1 As XmlSchemaSet = New XmlSchemaSet  
schemaSet1.Add("http://www.contoso.com/retail", "http://www.contoso.com/retail.xsd")  
schemaSet1.Add("http://www.contoso.com/books", "http://www.contoso.com/books.xsd")  
schemaSet1.Add("http://www.contoso.com/music", "http://www.contoso.com/music.xsd")  
  
Dim schemaSet2 As XmlSchemaSet = New XmlSchemaSet  
schemaSet2.Add(schemaSet1)  
XmlSchemaSet schemaSet1 = new XmlSchemaSet();  
schemaSet1.Add("http://www.contoso.com/retail", "http://www.contoso.com/retail.xsd");  
schemaSet1.Add("http://www.contoso.com/books", "http://www.contoso.com/books.xsd");  
schemaSet1.Add("http://www.contoso.com/music", "http://www.contoso.com/music.xsd");  
  
XmlSchemaSet schemaSet2 = new XmlSchemaSet();  
schemaSet2.Add(schemaSet1);  

Remarks

Прежде чем схему можно будет добавить в XmlSchemaSet, ее необходимо успешно обработать.Before a schema can be added to an XmlSchemaSet, it has to be successfully preprocessed. Предварительная обработка выполняет следующие основные задачи.Preprocessing performs the following basic tasks.

  1. Схема проверяется на соответствие структурной достоверности согласно правилам схемы W3C XML, но схема не полностью проверена.The schema is checked for structural validity according to the rules of W3C XML Schema, but the schema is not fully validated.

  2. Ссылки на внутренние и внешние компоненты схемы разрешаются.References to internal and external schema components are resolved. Все импортированные или включенные схемы, которые были успешно получены, также добавляются в XmlSchemaSet.Any imported or included schemas that are successfully retrieved are also added to the XmlSchemaSet. Импортированные схемы добавляются в виде отдельных объектов XmlSchema, а включенные схемы делаются частью, включающей в себя XmlSchema.Imported schemas are added as separate XmlSchema objects, and included schemas are made a part of the including XmlSchema.

Если свойство IsCompiled добавляемого XmlSchemaSet имеет значение true, все схемы в XmlSchemaSet для добавления добавляются в XmlSchemaSet.If the IsCompiled property of the XmlSchemaSet to add is true, all schemas in the XmlSchemaSet to add are added to the XmlSchemaSet. Если свойство IsCompiled добавляемого XmlSchemaSet является false, то каждая добавленная схема будет предварительно обработана перед добавлением.If the IsCompiled property of the XmlSchemaSet to add is false, each schema added is preprocessed before being added. Если любая из схем в вновь добавленной XmlSchemaSet не может быть предварительно обработана, схемы не добавляются; Вместо этого выдается XmlSchemaException.If any of the schemas in the newly added XmlSchemaSet fails to be preprocessed, no schemas are added; instead, an XmlSchemaException is thrown. В результате следующий два примера кода не эквивалентны.As a result, the following two code example are not equivalent.

' First example  
schemaSet.Add(schemaSet1)  
  
' Second example  
Dim schema As XmlSchema  
  
For Each schema in schemaSet.Schemas()  
  
    schemaSet.Add(schema)  
  
Next  
// First example  
schemaSet.Add(schemaSet1);  
  
// Second example  
foreach(XmlSchema schema in schemaSet.Schemas())  
{  
    schemaSet.Add(schema);  
}  

Предыдущие два примера кода не эквивалентны.The previous two code examples are not equivalent. В первом примере, если в schemaSet1 существует недопустимая схема, а ее свойство IsCompiled имеет значение false, схемы не добавляются в schemaSet.In the first example, if an invalid schema exists in schemaSet1 and its IsCompiled property is set to false, no schemas are added to schemaSet. Во втором примере можно добавить несколько схем в schemaSet, прежде чем будет обнаружена недопустимая схема, и будет создано исключение.In the second example, a number of schemas can be added to schemaSet before an invalid schema is encountered and an exception is thrown.

Add(String, String)

Добавляет схему языка определения схем XML (XSD), расположенную по указанному URL-адресу, в XmlSchemaSet.Adds the XML Schema definition language (XSD) schema at the URL specified to the XmlSchemaSet.

public:
 System::Xml::Schema::XmlSchema ^ Add(System::String ^ targetNamespace, System::String ^ schemaUri);
public System.Xml.Schema.XmlSchema Add (string targetNamespace, string schemaUri);
member this.Add : string * string -> System.Xml.Schema.XmlSchema
Public Function Add (targetNamespace As String, schemaUri As String) As XmlSchema

Parameters

targetNamespace
String

Свойство схемы targetNamespace или null, чтобы использовалось пространство имен targetNamespace, определенное в схеме.The schema targetNamespace property, or null to use the targetNamespace specified in the schema.

schemaUri
String

URL-адрес, ссылающийся на схему, которую необходимо загрузить.The URL that specifies the schema to load.

Returns

XmlSchema

Объект XmlSchema, если схема успешно прошла проверку.An XmlSchema object if the schema is valid. Если схема не прошла проверку и задан ValidationEventHandler, тогда возвращается null и возникает соответствующее событие проверки.If the schema is not valid and a ValidationEventHandler is specified, then null is returned and the appropriate validation event is raised. В противном случае возникает исключение XmlSchemaException.Otherwise, an XmlSchemaException is thrown.

Exceptions

Схема не прошла проверку.The schema is not valid.

URL-адрес, переданный в качестве параметра, равен null или Empty.The URL passed as a parameter is null or Empty.

Examples

В следующем примере кода в XmlSchemaSetдобавляется схема http://www.contoso.com/books.xsd с целевым пространством имен http://www.contoso.com/books.The following code example adds the http://www.contoso.com/books.xsd schema with a target namespace of http://www.contoso.com/books to the XmlSchemaSet.

Dim schemaSet As XmlSchemaSet = New XmlSchemaSet()  
schemaSet.Add("http://www.contoso.com/books", "http://www.contoso.com/books.xsd")  
XmlSchemaSet schemaSet = new XmlSchemaSet();  
schemaSet.Add("http://www.contoso.com/books", "http://www.contoso.com/books.xsd");  

В примере в качестве входных данных используется файл books.xsd.The example uses the books.xsd file as input.

<?xml version="1.0" encoding="utf-8"?>
<xs:schema attributeFormDefault="unqualified" elementFormDefault="qualified" targetNamespace="http://www.contoso.com/books" xmlns:xs="http://www.w3.org/2001/XMLSchema">
    <xs:element name="bookstore">
        <xs:complexType>
            <xs:sequence>
                <xs:element maxOccurs="unbounded" name="book">
                    <xs:complexType>
                        <xs:sequence>
                            <xs:element name="title" type="xs:string" />
                            <xs:element name="author">
                                <xs:complexType>
                                    <xs:sequence>
                                        <xs:element minOccurs="0" name="name" type="xs:string" />
                                        <xs:element minOccurs="0" name="first-name" type="xs:string" />
                                        <xs:element minOccurs="0" name="last-name" type="xs:string" />
                                    </xs:sequence>
                                </xs:complexType>
                            </xs:element>
                            <xs:element name="price" type="xs:decimal" />
                        </xs:sequence>
                        <xs:attribute name="genre" type="xs:string" use="required" />
                        <xs:attribute name="publicationdate" type="xs:unsignedShort" use="required" />
                        <xs:attribute name="ISBN" type="xs:string" use="required" />
                    </xs:complexType>
                </xs:element>
            </xs:sequence>
        </xs:complexType>
    </xs:element>
</xs:schema>

Remarks

Прежде чем схему можно будет добавить в XmlSchemaSet, ее необходимо успешно обработать.Before a schema can be added to an XmlSchemaSet, it has to be successfully preprocessed. Предварительная обработка выполняет следующие основные задачи.Preprocessing performs the following basic tasks.

  1. Схема проверяется на соответствие структурной достоверности согласно правилам схемы W3C XML, но схема не полностью проверена.The schema is checked for structural validity according to the rules of W3C XML Schema, but the schema is not fully validated.

  2. Ссылки на внутренние и внешние компоненты схемы разрешаются.References to internal and external schema components are resolved. Все импортированные или включенные схемы, которые были успешно получены, также добавляются в XmlSchemaSet.Any imported or included schemas that are successfully retrieved are also added to the XmlSchemaSet. Импортированные схемы добавляются в виде отдельных объектов XmlSchema, а включенные схемы делаются частью, включающей в себя XmlSchema.Imported schemas are added as separate XmlSchema objects, and included schemas are made a part of the including XmlSchema.

Ниже приведены важные замечания, которые следует учитывать при использовании метода Add.The following are important notes to consider when using the Add method.

  • Добавление схемы в XmlSchemaSet с тем же целевым пространством имен и URL-адресом расположения схемы, что и схема, уже содержащаяся в XmlSchemaSet, вернет исходный объект схемы.Adding a schema to the XmlSchemaSet with the same target namespace and schema location URL as a schema already contained within the XmlSchemaSet will return the original schema object.

  • При успешном добавлении новой схемы в XmlSchemaSetсвойству IsCompiled XmlSchemaSet присваивается значение false.When a new schema is successfully added to an XmlSchemaSet, the IsCompiled property of the XmlSchemaSet is set to false.

  • Любые элементы включения или импорта, обнаруженные в схеме XML, разрешаются при вызове метода Add.Any include or import elements encountered in an XML schema are resolved when the Add method is called. Сбой при разрешении элементов включения и импорта приводит к предупреждению проверки схемы. Если ValidationEventHandler не было указано для объекта XmlSchemaSet, эти предупреждения не будут выводиться.Failure to resolve include and import elements results in a schema validation warning and if no ValidationEventHandler has been specified for the XmlSchemaSet object, these warning will not be reported.

  • Если в XmlSchemaSetдобавляется схема с тем же целевым пространством имен, что и схема, которая уже существует в XmlSchemaSet, то добавляются обе схемы.If a schema with the same target namespace as a schema that already exists in the XmlSchemaSet is added to the XmlSchemaSet, both schemas are added.

    Note

    Это поведение отличается от устаревшего объекта XmlSchemaCollection.This behavior differs from the obsolete XmlSchemaCollection object.

  • Метод Add XmlSchemaSet имеет возможность использовать целевое пространство имен, определенное в схеме, вместо того чтобы указывать целевое пространство имен в качестве параметра при вызове метода Add.The Add method of the XmlSchemaSet has the ability to use the target namespace defined in a schema, rather than requiring the target namespace be specified as a parameter when the Add method is called. Указание null в параметре targetNamespace метода Add предписывает XmlSchemaSet использовать целевое пространство имен, определенное в схеме, как показано в следующем примере кода.Specifying null in the targetNamespace parameter of the Add method instructs the XmlSchemaSet to use the target namespace defined in the schema, as illustrated in the following code example.

Dim schemaSet As XmlSchemaSet = New XmlSchemaSet()  
schemaSet.Add(Nothing, "books.xsd")  
  
Dim schema As XmlSchema  
For Each schema In schemaSet.Schemas("http://www.contoso.com/books")  
    schema.Write(Console.Out)  
Next  
XmlSchemaSet schemaSet = new XmlSchemaSet();  
schemaSet.Add(null, "books.xsd");  
  
foreach(XmlSchema schema in schemaSet.Schemas("http://www.contoso.com/books"))  
{  
    schema.Write(Console.Out);  
}  

В приведенном выше примере кода null задается в качестве параметра targetNamespace метода Add.In the code example above, null is specified as the targetNamespace parameter to the Add method. В результате используется targetNamespace, определенный в файле books. XML.As a result, the targetNamespace defined in the books.xml file is used. В этом случае результат вызова метода Add будет идентичен, если http://www.contoso.com/books был указан в качестве параметра targetNamespace.In this case, the result of calling the Add method would be identical if http://www.contoso.com/books had been specified as the targetNamespace parameter.

  • Схема W3C XML позволяет включать схемы без целевого пространства имен в схемы с определенным целевым пространством имен.W3C XML Schema allows schemas without a target namespace to be included in schemas with a target namespace defined. В этом случае схема без определенного целевого пространства имен приводится к целевому пространству имен, включающему схему.In this case, the schema without a target namespace defined is coerced into the target namespace of the including schema. Включенная схема обрабатывается так, как если бы в ней было определено целевое пространство имен.The included schema is treated as if it had that target namespace defined. Аналогичным образом схемы без целевого пространства имен можно добавить в XmlSchemaSet и привести к целевому пространству имен, указанному методом Add, как показано в следующем примере.Similarly, schemas without a target namespace can be added to the XmlSchemaSet and coerced into the target namespace specified by the Add method, as illustrated in the following example.
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">  
    <xs:element name="A" type="xs:string" />  
</xs:schema>  

Если приведенная выше схема добавляется в XmlSchemaSet с целевым пространством имен http://www.contoso.com/new/targetnamespace (как показано в приведенном ниже коде), оно рассматривается как http://www.contoso.com/new/targetnamespaceцелевого пространства имен, объявленного в схеме.If the schema above is added to the XmlSchemaSet with the target namespace http://www.contoso.com/new/targetnamespace (as shown in the code below), it is treated as if the target namespace declared in the schema was http://www.contoso.com/new/targetnamespace.

Dim schemaSet As XmlSchemaSet = New XmlSchemaSet()  
schemaSet.Add("http://www.contoso.com/new/targetnamespace", "http://www.contoso.com/targetnamespace.xsd")  
  
Dim schema As XmlSchema  
  
For Each schema in schemaSet.Schemas()  
  
    Console.WriteLine(schema.TargetNamespace)     
  
Next  
XmlSchemaSet schemaSet = new XmlSchemaSet();  
schemaSet.Add("http://www.contoso.com/new/targetnamespace", "http://www.contoso.com/targetnamespace.xsd");  
foreach(XmlSchema schema in schemaSet.Schemas())  
{  
    Console.WriteLine(schema.TargetNamespace);  
}  

Add(String, XmlReader)

Добавляет схему языка определения схем XML (XSD), содержащуюся в XmlReader, в XmlSchemaSet.Adds the XML Schema definition language (XSD) schema contained in the XmlReader to the XmlSchemaSet.

public:
 System::Xml::Schema::XmlSchema ^ Add(System::String ^ targetNamespace, System::Xml::XmlReader ^ schemaDocument);
public System.Xml.Schema.XmlSchema Add (string targetNamespace, System.Xml.XmlReader schemaDocument);
member this.Add : string * System.Xml.XmlReader -> System.Xml.Schema.XmlSchema
Public Function Add (targetNamespace As String, schemaDocument As XmlReader) As XmlSchema

Parameters

targetNamespace
String

Свойство схемы targetNamespace или null, чтобы использовалось пространство имен targetNamespace, определенное в схеме.The schema targetNamespace property, or null to use the targetNamespace specified in the schema.

schemaDocument
XmlReader

Объект XmlReader.The XmlReader object.

Returns

XmlSchema

Объект XmlSchema, если схема успешно прошла проверку.An XmlSchema object if the schema is valid. Если схема не прошла проверку и задан ValidationEventHandler, тогда возвращается null и возникает соответствующее событие проверки.If the schema is not valid and a ValidationEventHandler is specified, then null is returned and the appropriate validation event is raised. В противном случае возникает исключение XmlSchemaException.Otherwise, an XmlSchemaException is thrown.

Exceptions

Схема не прошла проверку.The schema is not valid.

Объект XmlReader, переданный в качестве параметра, является null.The XmlReader object passed as a parameter is null.

Examples

В следующем примере кода добавляется схема books. xsd, содержащаяся в XmlTextReader с целевым пространством имен http://www.contoso.com/books в XmlSchemaSet.The following code example adds the books.xsd schema contained in the XmlTextReader with a target namespace of http://www.contoso.com/books to the XmlSchemaSet.

Dim schemaSet As XmlSchemaSet = New XmlSchemaSet()  
schemaSet.Add("http://www.contoso.com/books", New XmlTextReader("books.xsd")  
XmlSchemaSet schemaSet = new XmlSchemaSet();  
schemaSet.Add("http://www.contoso.com/books", new XmlTextReader("books.xsd");  

Remarks

Прежде чем схему можно будет добавить в XmlSchemaSet, ее необходимо успешно обработать.Before a schema can be added to an XmlSchemaSet, it has to be successfully preprocessed. Предварительная обработка выполняет следующие основные задачи.Preprocessing performs the following basic tasks.

  1. Схема проверяется на соответствие структурной достоверности согласно правилам схемы W3C XML, но схема не полностью проверена.The schema is checked for structural validity according to the rules of W3C XML Schema, but the schema is not fully validated.

  2. Ссылки на внутренние и внешние компоненты схемы разрешаются.References to internal and external schema components are resolved. Все импортированные или включенные схемы, которые были успешно получены, также добавляются в XmlSchemaSet.Any imported or included schemas that are successfully retrieved are also added to the XmlSchemaSet. Импортированные схемы добавляются в виде отдельных объектов XmlSchema, а включенные схемы делаются частью, включающей в себя XmlSchema.Imported schemas are added as separate XmlSchema objects, and included schemas are made a part of the including XmlSchema.

Ниже приведены важные замечания, которые следует учитывать при использовании метода Add.The following are important notes to consider when using the Add method.

  • Успешно извлеченные схемы, импортированные или включенные в схемы, содержащиеся в XmlReader, также добавляются в XmlSchemaSet.Successfully retrieved schemas imported or included by the schemas contained in the XmlReader are also added to the XmlSchemaSet.

  • Если XmlReader не находится в корневом элементе, создается исключение XmlSchemaException, если только текущий элемент не является элементом.If the XmlReader is not positioned on the root element, an XmlSchemaException is thrown unless the current item is an element. Если текущий элемент является элементом xs:schema, документ схемы считывается в XmlSchemaSet; в противном случае создается XmlSchemaException, так как схема недопустима.If the current item is an xs:schema element, the schema document is read into the XmlSchemaSet; otherwise, an XmlSchemaException is thrown because the schema is not valid.

  • Если XmlReader располагается на последовательности узлов XML, то добавляется только первый узел в последовательности.If the XmlReader is positioned over a sequence of XML nodes, only the first node in the sequence is added.

  • Если схема была создана на основе вызова метода XmlReader.Create, значение свойства ProcessInlineSchema игнорируется, так как встроенная обработка схемы не применяется к документам схемы W3C XML.If the schema was created from a XmlReader.Create method call, the value of the ProcessInlineSchema property is ignored, because inline schema processing is not applied for W3C XML Schema documents.

  • Свойство XmlResolver XmlReader не используется для разрешения ссылок на пространства имен или расположения схем в элементах include и Import.The XmlResolver property of the XmlReader is not used to resolve references to namespaces or schema locations in include and import elements. Вместо этого используется свойство XmlResolver XmlSchemaSet.Instead, the XmlResolver property of the XmlSchemaSet is used.

  • Метод Add XmlSchemaSet имеет возможность использовать целевое пространство имен, определенное в схеме, вместо того чтобы указывать целевое пространство имен в качестве параметра при вызове метода Add.The Add method of the XmlSchemaSet has the ability to use the target namespace defined in a schema, rather than requiring the target namespace be specified as a parameter when the Add method is called. Указание null или String.Empty метода Add предписывает XmlSchemaSet использовать целевое пространство имен, определенное в схеме.Specifying null or String.Empty to the Add method instructs the XmlSchemaSet to use the target namespace defined in the schema. Пример такого поведения см. в описании метода Add.For an example of this behavior, see the Add method.

Оставшаяся функциональность этого метода идентична функции метода Add.The remaining functionality of this method is identical to that of the Add method.

Applies to