C# で XML ツリーを作成する (LINQ to XML)

  • [アーティクル]

この記事では、C# での XML ツリーの作成に関する情報を提供します。

LINQ クエリの結果を XElement のコンテンツとして使用する方法については、「関数型構築」を参照してください。

要素の構築

XElement コンストラクターと XAttribute コンストラクターのシグネチャを使用すると、要素または属性のコンテンツを引数としてコンストラクターに渡すことができます。 いずれかのコンストラクターは任意の数の引数を受け取るため、任意の数の子要素を渡すことができます。 もちろん、それらの子要素のそれぞれに、さらに子要素を含めることもできます。 いずれの要素にも、任意の数の属性を追加できます。

XNode オブジェクト (XElement を含む) や XAttribute オブジェクトの追加時に、新しいコンテンツに親がない場合、単にオブジェクトが XML ツリーにアタッチされます。 新しいコンテンツに既に親があり、別の XML ツリーの一部となっている場合は、新しいコンテンツが複製され、新しく複製されたコンテンツが XML ツリーにアタッチされます。 この記事の最後の例では、この動作について説明します。

contactsXElement を作成するには、次のコードを使用できます。

XElement contacts =
    new XElement("Contacts",
        new XElement("Contact",
            new XElement("Name", "Patrick Hines"),
            new XElement("Phone", "206-555-0144"),
            new XElement("Address",
                new XElement("Street1", "123 Main St"),
                new XElement("City", "Mercer Island"),
                new XElement("State", "WA"),
                new XElement("Postal", "68042")
            )
        )
    );

適切にインデントされていれば、XElement オブジェクトを構築するコードは、基になる XML の構造によく似ています。

XElement コンストラクター

XElement クラスは、関数型構築で次のコンストラクターを使用します。 XElement のコンストラクターはこれ以外にも存在しますが、関数型構築に使用されないものはこの一覧に示していません。

コンストラクター 説明
XElement(XName name, object content) XElement を作成します。 name パラメーターには要素の名前を指定し、content には要素のコンテンツを指定します。
XElement(XName name) 指定した名前で XElement を初期化して、XName を作成します。
XElement(XName name, params object[] content) 指定した名前で XElement を初期化して、XName を作成します。 属性や子要素が、パラメーター リストのコンテンツから作成されます。

content パラメーターは非常に柔軟です。 XElement の有効な子オブジェクトの型すべてがサポートされています。 このパラメーターで渡されるさまざまな型のオブジェクトには、次の規則が適用されます。

  • 文字列はテキスト コンテンツとして追加されます。
  • XElement は子要素として追加されます。
  • XAttribute は属性として追加されます。
  • XProcessingInstruction、XComment、または XText は、子コンテンツとして追加されます。
  • IEnumerable は列挙され、その結果にこれらの規則が再帰的に適用されます。
  • その他の型に対しては ToString メソッドが呼び出され、その結果がテキスト コンテンツとして追加されます。

例: コンテンツを含む XElement を作成する

単純コンテンツが含まれる XElement は、1 回のメソッド呼び出しで作成できます。 そのためには、次のように、コンテンツを 2 番目のパラメーターとして指定します。

XElement n = new XElement("Customer", "Adventure Works");
Console.WriteLine(n);

この例を実行すると、次の出力が生成されます。

<Customer>Adventure Works</Customer>

任意の型のオブジェクトをコンテンツとして渡すことができます。 たとえば、次のコードでは、浮動小数点数がコンテンツとして含まれる要素を作成します。

XElement n = new XElement("Cost", 324.50);
Console.WriteLine(n);

この例を実行すると、次の出力が生成されます。

<Cost>324.5</Cost>

浮動小数点数はボックス化されてコンストラクターに渡されます。 ボックス化された数は文字列に変換され、要素のコンテンツとして使用されます。

例: 子要素を持つ XElement を作成する

XElement クラスのインスタンスをコンテンツ引数として渡すと、コンストラクターによって、子要素を持つ要素が作成されます。

XElement shippingUnit = new XElement("ShippingUnit",
    new XElement("Cost", 324.50)
);
Console.WriteLine(shippingUnit);

この例を実行すると、次の出力が生成されます。

<ShippingUnit>
  <Cost>324.5</Cost>
</ShippingUnit>

例: 複数の子要素を持つ XElement を作成する

複数の XElement オブジェクトをコンテンツとして渡すことができます。 各 XElement オブジェクトは、子要素として格納されます。

XElement address = new XElement("Address",
    new XElement("Street1", "123 Main St"),
    new XElement("City", "Mercer Island"),
    new XElement("State", "WA"),
    new XElement("Postal", "68042")
);
Console.WriteLine(address);

この例を実行すると、次の出力が生成されます。

<Address>
  <Street1>123 Main St</Street1>
  <City>Mercer Island</City>
  <State>WA</State>
  <Postal>68042</Postal>
</Address>

上の例を次のように拡張すると、完全な XML ツリーを作成できます。

XElement contacts =
    new XElement("Contacts",
        new XElement("Contact",
            new XElement("Name", "Patrick Hines"),
            new XElement("Phone", "206-555-0144"),
            new XElement("Address",
                new XElement("Street1", "123 Main St"),
                new XElement("City", "Mercer Island"),
                new XElement("State", "WA"),
                new XElement("Postal", "68042")
            )
        )
    );
Console.WriteLine(contacts);

この例を実行すると、次の出力が生成されます。

<Contacts>
  <Contact>
    <Name>Patrick Hines</Name>
    <Phone>206-555-0144</Phone>
    <Address>
      <Street1>123 Main St</Street1>
      <City>Mercer Island</City>
      <State>WA</State>
      <Postal>68042</Postal>
    </Address>
  </Contact>
</Contacts>

例: XAttribute を持つ XElement を作成する

XAttribute クラスのインスタンスをコンテンツ引数として渡すと、コンストラクターによって、属性がある要素が作成されます。

XElement phone = new XElement("Phone",
    new XAttribute("Type", "Home"),
    "555-555-5555");
Console.WriteLine(phone);

この例を実行すると、次の出力が生成されます。

<Phone Type="Home">555-555-5555</Phone>

例: 空の要素を作成する

空の XElement を作成するには、コンストラクターにコンテンツを渡さないでください。 次の例では、空要素を作成します。

XElement n = new XElement("Customer");
Console.WriteLine(n);

この例を実行すると、次の出力が生成されます。

<Customer />

例: アタッチと複製

既に説明したように、XNode オブジェクト (XElement を含む) や XAttribute オブジェクトの追加時に、新しいコンテンツに親がない場合、単にオブジェクトが XML ツリーにアタッチされます。 新しいコンテンツに既に親があり、別の XML ツリーの一部となっている場合は、新しいコンテンツが複製され、新しく複製されたコンテンツが XML ツリーにアタッチされます。

次の例では、親を持つ要素をツリーに追加する場合と親を持たない要素をツリーに追加する場合の動作を示します。

// Create a tree with a child element.
XElement xmlTree1 = new XElement("Root",
    new XElement("Child1", 1)
);

// Create an element that's not parented.
XElement child2 = new XElement("Child2", 2);

// Create a tree and add Child1 and Child2 to it.
XElement xmlTree2 = new XElement("Root",
    xmlTree1.Element("Child1"),
    child2
);

// Compare Child1 identity.
Console.WriteLine("Child1 was {0}",
    xmlTree1.Element("Child1") == xmlTree2.Element("Child1") ?
    "attached" : "cloned");

// Compare Child2 identity.
Console.WriteLine("Child2 was {0}",
    child2 == xmlTree2.Element("Child2") ?
    "attached" : "cloned");

// This example produces the following output:
//    Child1 was cloned
//    Child2 was attached

関連項目