XmlSchemaSet.Add メソッド

定義

指定された XML スキーマ定義言語 (XSD) スキーマを XmlSchemaSet に追加します。Adds the given XML Schema definition language (XSD) schema to the XmlSchemaSet.

オーバーロード

Add(XmlSchema)

指定された XmlSchemaXmlSchemaSet に追加します。Adds the given XmlSchema to the XmlSchemaSet.

Add(XmlSchemaSet)

指定された XmlSchemaSet 内のすべての XML スキーマ定義言語 (XSD) スキーマを XmlSchemaSet に追加します。Adds all the XML Schema definition language (XSD) schemas in the given XmlSchemaSet to the XmlSchemaSet.

Add(String, String)

指定された URL の XML スキーマ定義言語 (XSD) スキーマを XmlSchemaSet に追加します。Adds the XML Schema definition language (XSD) schema at the URL specified to the XmlSchemaSet.

Add(String, XmlReader)

XmlReader に格納されている XML スキーマ定義言語 (XSD) スキーマを XmlSchemaSet に追加します。Adds the XML Schema definition language (XSD) schema contained in the XmlReader to the XmlSchemaSet.

Add(XmlSchema)

指定された XmlSchemaXmlSchemaSet に追加します。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

パラメーター

schema
XmlSchema

XmlSchemaSet に追加する XmlSchema オブジェクト。The XmlSchema object to add to the XmlSchemaSet.

戻り値

スキーマが有効な場合は 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.

例外

スキーマが有効ではありません。The schema is not valid.

パラメーターとして渡される XmlSchema オブジェクトは null です。The XmlSchema object passed as a parameter is null.

注釈

オブジェクトが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)

指定された XmlSchemaSet 内のすべての XML スキーマ定義言語 (XSD) スキーマを 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)

パラメーター

schemas
XmlSchemaSet

XmlSchemaSet オブジェクト。The XmlSchemaSet object.

例外

XmlSchemaSet のスキーマが有効ではありません。A schema in the XmlSchemaSet is not valid.

パラメーターとして渡される XmlSchemaSet オブジェクトは null です。The XmlSchemaSet object passed as a parameter is null.

次のコード例でXmlSchemaSetは、にスキーマを追加し、 XmlSchemaSet Addメソッドを使用XmlSchemaSetしてを新しいに追加する方法を示します。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);  

注釈

スキーマをに追加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.

XmlSchemaSet true XmlSchemaSet追加するのXmlSchemaSetプロパティがの場合は、追加するのすべてのスキーマがに追加されます。 IsCompiledIf the IsCompiled property of the XmlSchemaSet to add is true, all schemas in the XmlSchemaSet to add are added to the XmlSchemaSet. 追加するのプロパティがfalseの場合、追加される前に、追加される各スキーマが前処理されます。 IsCompiled XmlSchemaSetIf 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. その結果、次の2つのコード例は等価ではありません。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);  
}  

前の2つのコード例は、同じではありません。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. 2番目の例では、無効なスキーマが検出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)

指定された URL の XML スキーマ定義言語 (XSD) スキーマを 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

パラメーター

targetNamespace
String

スキーマの targetNamespace プロパティ。またはスキーマの指定された targetNamespace を使用する場合は nullThe schema targetNamespace property, or null to use the targetNamespace specified in the schema.

schemaUri
String

読み込むスキーマを指定する URL。The URL that specifies the schema to load.

戻り値

スキーマが有効な場合は 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.

例外

スキーマが有効ではありません。The schema is not valid.

パラメーターとして渡された URL が null または Empty です。The URL passed as a parameter is null or Empty.

次のコード例ではhttp://www.contoso.com/books.xsd 、の対象のhttp://www.contoso.com/books名前空間を持つXmlSchemaSetスキーマをに追加します。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>

注釈

スキーマをに追加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 XmlSchemaSetれているスキーマと同じターゲット名前空間およびスキーマ位置 URL を持つにスキーマを追加すると、元のスキーマオブジェクトが返されます。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. Include 要素と import 要素の解決に失敗すると、スキーマ検証警告が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.

    注意

    この動作は、互換性のXmlSchemaCollectionために残されているオブジェクトとは異なります。This behavior differs from the obsolete XmlSchemaCollection object.

  • のメソッドは、スキーマで定義されたターゲットの名前空間を使用できます。 Addメソッドを呼び出すときに、ターゲットの名前空間をパラメーターとして指定する必要はありません。XmlSchemaSet AddThe 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パラメーターでを指定すると、 XmlSchemaSet次のコード例に示すように、スキーマで定義されているターゲットの名前空間を使用するようにに指示します。 AddSpecifying 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 targetNamespaceパラメーターとしてを指定した場合http://www.contoso.com/books 、メソッドを呼び出した結果は同じになります。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)

XmlReader に格納されている XML スキーマ定義言語 (XSD) スキーマを 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

パラメーター

targetNamespace
String

スキーマの targetNamespace プロパティ。またはスキーマの指定された targetNamespace を使用する場合は nullThe schema targetNamespace property, or null to use the targetNamespace specified in the schema.

schemaDocument
XmlReader

XmlReader オブジェクト。The XmlReader object.

戻り値

スキーマが有効な場合は 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.

例外

スキーマが有効ではありません。The schema is not valid.

パラメーターとして渡される XmlReader オブジェクトは null です。The XmlReader object passed as a parameter is null.

次のコード例では、のXmlTextReader http://www.contoso.com/books XmlSchemaSet対象の名前空間を持つに含まれる books.xml スキーマをに追加します。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");  

注釈

スキーマをに追加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.

  • がルート要素に配置されていない場合XmlSchemaException 、現在の項目が要素でない限り、がスローされます。 XmlReaderIf 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.

  • インクルード要素およびインポートXmlReader要素では、のプロパティは、名前空間またはスキーマの場所への参照を解決するためには使用されません。XmlResolverThe XmlResolver property of the XmlReader is not used to resolve references to namespaces or schema locations in include and import elements. 代わりに、XmlSchemaSetのプロパティがXmlResolver使用されます。Instead, the XmlResolver property of the XmlSchemaSet is used.

  • のメソッドは、スキーマで定義されたターゲットの名前空間を使用できます。 Addメソッドを呼び出すときに、ターゲットの名前空間をパラメーターとして指定する必要はありません。XmlSchemaSet AddThe 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. メソッドにString.Emptyまたはをnull XmlSchemaSet指定すると、は、スキーマで定義されている対象の名前空間を使用するようにに指示します。 AddSpecifying 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.

適用対象