MaxOccurs 属性のバインディング サポート

このトピックの対象は、レガシ テクノロジに特定されています。XML Web サービスと XML Web サービス クライアントは以下を使用して作成してください。 Windows Communication Foundation.

.NET Framework では、maxOccurs 属性のバインドを一部サポートしています。

maxOccurs 属性を指定できるほとんどの要素について、Xsd.exe では値 0 は 1 と解釈され、配列フィールドではないフィールドが作成されます。1 を超える値は unbounded と解釈され、配列フィールドが作成されます。動作は要素によって異なります。

説明

maxOccurs 属性や minOccurs 属性を指定したエンティティでは、XML ドキュメントでこの属性に対応する位置にそのエンティティを連続して指定できる回数が制約されます。

これらの属性は、複合型定義でのみ使用できます。したがって、<element> 要素または <group> 要素でこれらの属性を使用するためには、これらの属性はローカル宣言にするか、(グローバル宣言そのものではなく) グローバル宣言への参照にする必要があります。

.NET Framework のプログラミング言語には、XML スキーマ複合型を持つバインディング クラスに対する maxOccurs 属性や minOccurs 属性に直接対応するソース コードの要素がありません。

Xsd.exe によって XML スキーマ ドキュメントからソース コードを生成する場合や逆変換を行う場合、maxOccurs 属性は、その属性が使用される XML スキーマ定義言語要素に応じて解釈が異なります。次の表に、要素ごとの解釈を示します。

Xsd.exe でアセンブリ内の一連のクラスから XML スキーマ ドキュメントを生成する場合には、上の変換とは逆の変換処理が行われ、単一のインスタンスからは値 1 の maxOccurs が作成され、配列からは値 unbounded の maxOccurs が作成されます。

Xsd.exe では、maxOccurs の値 unbounded は配列にバインドされますが、配列の親要素が存在する場合、maxOccurs の値 1 はその親要素にバインドされます。

既定の System.Xml.Serialization.XmlArrayAttribute 属性が配列に適用される場合、配列の親要素を表すために、名前が ArrayOf で始まるスキーマ データ型が作成されます。配列に対して、この属性ではなく System.Xml.Serialization.XmlElementAttribute 属性が適用される場合、その配列要素はインスタンス ドキュメント内で、クラスにバインドする要素の各子要素として表されます。配列のバインディングの詳細については、「属性を使用した XML シリアル化の制御」を参照してください。

配列のバインディングに関する補足説明 1 を超える値から配列への変換を理解するために、特定の型のオブジェクトを宣言する場合と、そのオブジェクトに値 (実際には、スタック内またはヒープ内のメモリの位置) を代入する場合の違いを考察します。次の XSD 要素を考えます。

<xsd:element minOccurs="5" maxOccurs="5" name="items" type="xsd:token" />

手動でコードを作成する場合は、public string[] items のように、型宣言時には配列サイズ 5 を表明しません。その代わり、items = new string[5] のように、値の割り当て時に配列のサイズを表明します。

Xsd.exe が XML スキーマから生成するソース コードの種類は、型宣言、フィールド宣言、および型やフィールドに属性として適用できるメタデータだけです。オブジェクトに値を割り当てると、そのスコープを超えて拡張されます。

1 よりも大きい値にする場合は、スキーマ オブジェクト モデル (SOM: Schema Object Model) で表された XML スキーマ ドキュメントに対して、XML ドキュメントを XmlValidatingReader クラスを使用して検証します。SOM では、System.Xml.Schema.XmlSchemaParticle.MaxOccurs プロパティおよび System.Xml.Schema.XmlSchemaParticle.MaxOccursString プロパティを使用します。これらのプロパティは、maxOccurs 属性を設定できるすべての要素に適用されます。

Example

複合型定義における入力 XML スキーマの <choice> 要素

<xsd:choice maxOccurs="unbounded">
    <xsd:element name="stringA" type="xsd:string"/>
    <xsd:element name="stringB" type="xsd:string"/>
</xsd:choice>

上の XML スキーマ ドキュメントから生成される C# クラスの関連部分と、この要素の選択肢を示す列挙型 (対象の名前空間が http://example.org/ であると仮定)

    [System.Xml.Serialization.XmlElementAttribute("stringA", typeof(string))]
    [System.Xml.Serialization.XmlElementAttribute("stringB", typeof(string))]
    [System.Xml.Serialization.XmlChoiceIdentifierAttribute("ItemsElementName")]
    public string[] Items;
        
    [System.Xml.Serialization.XmlElementAttribute("ItemsElementName")]
    [System.Xml.Serialization.XmlIgnoreAttribute()]
    public ItemsChoiceType[] ItemsElementName;
...
[System.Xml.Serialization.XmlTypeAttribute(Namespace="http://example.org/", IncludeInSchema=false)]
public enum ItemsChoiceType {
    stringA,
    stringB,
}

上の C# ソース コードをコンパイルして生成される複合型は、元の複合型と実質的に同一です。

<sequence>

Example

入力 XML スキーマ ドキュメントには、1 を超える値の maxOccurs が指定されたシーケンスが含まれます。

<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
      xmlns="http://example.org/" targetNamespace="http://example.org/" elementFormDefault="qualified">
  <xsd:element name="ComplexInstance">
   <xsd:complexType>
     <xsd:sequence maxOccurs="unbounded">
       <xsd:element name="Field1" type="xsd:token"/>
       <xsd:element name="Field2" type="xsd:int" />
     </xsd:sequence>
   </xsd:complexType>
  </xsd:element>
</xsd:schema>

上記の XML スキーマ ドキュメントからコマンド ライン オプションの指定なしで生成される C# クラス

[System.Xml.Serialization.XmlTypeAttribute(Namespace="http://example.org/")]
[System.Xml.Serialization.XmlRootAttribute(Namespace="http://example.org/", IsNullable=false)]
public class ComplexInstance {        
    [System.Xml.Serialization.XmlElementAttribute("Field1", DataType="token")]
    public string[] Field1;
        
    [System.Xml.Serialization.XmlElementAttribute("Field2")]
    public int[] Field2;
}

上記の C# ソースからコンパイルされたアセンブリから生成される XML スキーマ複合型

<xs:complexType name="ComplexInstance">
  <xs:sequence>
    <xs:element minOccurs="0" maxOccurs="unbounded" name="Field1" type="xs:token" />
    <xs:element minOccurs="0" maxOccurs="unbounded" name="Field2" type="xs:int" />
  </xs:sequence>
</xs:complexType>

このように、生成されるスキーマは元のスキーマに対応しません。1 を超える値の maxOccurs が指定されたシーケンスを含むスキーマを適切にインポートするには、/order コマンド ライン オプションを使います。この場合の結果を次に示します。

[System.Xml.Serialization.XmlTypeAttribute

(Namespace="http://example.org/")]

[System.Xml.Serialization.XmlRootAttribute

(Namespace="http://example.org/", IsNullable=false)]

public partial class ComplexInstance

{

/// <remarks/>

[System.Xml.Serialization.XmlElementAttribute

("Field1", typeof(string), DataType="token", Order=0)]

[System.Xml.Serialization.XmlElementAttribute("Field2",

typeof(int), Order=0)]

public object[] Items;

}

使用可能な子要素: <all>、<any>、<choice>、<element>、<group>、<sequence>

参照

リファレンス

System.Xml.Schema.XmlSchemaParticle.MaxOccurs
System.Xml.Schema.XmlSchemaParticle.MaxOccursString
XmlSchemaAll
XmlSchemaAny
XmlSchemaChoice
XmlSchemaElement
XmlSchemaGroupRef
XmlSchemaSequence