弱く型指定された拡張のサンプル

[アーティクル]
05/09/2023

LooselyTypedExtensions のサンプルでは、拡張データを処理する基本的な方法を示します。

配信オブジェクトモデルでは、拡張データをさまざまな方法で処理できます。拡張データとは、配信フィードの XML 表現に含まれているが、SyndicationFeed や SyndicationItem などのクラスによって明示的に公開されない情報のことです。

このサンプルでは、例を示す目的で SyndicationFeed クラスを使用します。ただし、このサンプルで示すパターンは、拡張データをサポートするすべての配信クラスで使用できます。

サンプル XML

このサンプルで使用される XML ドキュメントは次のとおりです。

<?xml version="1.0" encoding="IBM437"?>
<feed myAttribute="someValue" xmlns="http://www.w3.org/2005/Atom">
  <title type="text"></title>
  <id>uuid:8f60c7b3-a3c0-4de7-a642-2165d77ce3c1;id=1</id>
  <updated>2007-09-07T22:15:34Z</updated>
  <simpleString xmlns="">hello, world!</simpleString>
  <simpleString xmlns="">another simple string</simpleString>
  <DataContractExtension xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.d
atacontract.org/2004/07/Microsoft.Syndication.Samples">
    <Key>X</Key>
    <Value>4</Value>
  </DataContractExtension>
  <XmlSerializerExtension xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://ww
w.w3.org/2001/XMLSchema" xmlns="">
    <Key>Y</Key>
    <Value>8</Value>
  </XmlSerializerExtension>
  <xElementExtension xmlns="">
    <Key attr1="someValue">Z</Key>
    <Value attr1="someValue">15</Value>
  </xElementExtension>
</feed>

このドキュメントには、次の拡張データが含まれています。

myAttribute 要素の <feed> 属性。
<simpleString> 要素。
<DataContractExtension> 要素。
<XmlSerializerExtension> 要素。
<xElementExtension> 要素。

拡張データの書き込み

属性の拡張は、次のサンプルコードに示すように、エントリを AttributeExtensions コレクションに追加することによって作成されます。

//Attribute extensions are stored in a dictionary indexed by
// XmlQualifiedName
feed.AttributeExtensions.Add(new XmlQualifiedName("myAttribute", ""), "someValue");

要素拡張は、エントリを ElementExtensions コレクションに追加することによって作成されます。これらの拡張には、文字列などの基本的な値、.NET Framework オブジェクトの XML シリアル化、および手動で入力された XML ノードを指定できます。

次のサンプルコードでは、simpleString という拡張要素が作成されます。

feed.ElementExtensions.Add("simpleString", "", "hello, world!");

この要素の XML 名前空間は、空の名前空間 ("") であり、その値は、"hello, world!" という文字列が含まれたテキストノードになります。

入れ子になった多数の要素で構成される複雑な要素拡張を作成する方法の 1 つに、次の例に示すように、.NET Framework API をシリアル化に使用する方法があります (DataContractSerializer と XmlSerializer の両方がサポートされています)。

feed.ElementExtensions.Add( new DataContractExtension() { Key = "X", Value = 4 } );
feed.ElementExtensions.Add( new XmlSerializerExtension { Key = "Y", Value = 8 }, new XmlSerializer( typeof( XmlSerializerExtension ) ) );

この例の DataContractExtension と XmlSerializerExtension は、シリアライザで使用するために記述されたカスタム型です。

SyndicationElementExtensionCollection クラスを使用すると、XmlReader インスタンスから要素拡張を作成することもできます。これによって、次のサンプルコードに示すように、XElement などの XML 処理 API と簡単に統合できるようになります。

feed.ElementExtensions.Add(new XElement("xElementExtension",
        new XElement("Key", new XAttribute("attr1", "someValue"), "Z"),
        new XElement("Value", new XAttribute("attr1", "someValue"),
        "15")).CreateReader());

拡張データの読み取り

属性の拡張の値は、次のサンプルコードに示すように、AttributeExtensions を使用して XmlQualifiedName コレクションの属性を検索することによって取得できます。

Console.WriteLine( feed.AttributeExtensions[ new XmlQualifiedName( "myAttribute", "" )]);

要素拡張には、ReadElementExtensions<T> メソッドを使用してアクセスします。

foreach( string s in feed2.ElementExtensions.ReadElementExtensions<string>("simpleString", ""))
{
    Console.WriteLine(s);
}

foreach (DataContractExtension dce in feed2.ElementExtensions.ReadElementExtensions<DataContractExtension>("DataContractExtension",
"http://schemas.datacontract.org/2004/07/SyndicationExtensions"))
{
    Console.WriteLine(dce.ToString());
}

foreach (XmlSerializerExtension xse in feed2.ElementExtensions.ReadElementExtensions<XmlSerializerExtension>("XmlSerializerExtension", "", new XmlSerializer(typeof(XmlSerializerExtension))))
{
    Console.WriteLine(xse.ToString());
}

XmlReader メソッドを使用して、個々の要素拡張で GetReader() を取得することも可能です。

foreach (SyndicationElementExtension extension in feed2.ElementExtensions.Where<SyndicationElementExtension>(x => x.OuterName == "xElementExtension"))
{
    XNode xelement = XElement.ReadFrom(extension.GetReader());
    Console.WriteLine(xelement.ToString());
}

サンプルをセットアップ、ビルド、および実行するには

Windows Communication Foundation サンプルの 1 回限りのセットアップの手順を実行したことを確認します。
ソリューションの C# 版または Visual Basic .NET 版をビルドするには、「 Building the Windows Communication Foundation Samples」の手順に従います。
単一または複数コンピューター構成でサンプルを実行するには、「Windows Communication Foundation サンプルの実行」の手順に従います。

弱く型指定された拡張のサンプル

サンプル XML

拡張データの書き込み

拡張データの読み取り

サンプルをセットアップ、ビルド、および実行するには

関連項目

その他のリソース