Ukázka rozšíření silného typu
Ukázka StronglyTypedExtensions používá SyndicationFeed třídu pro účely příkladu. Vzory demonstrované v této ukázce se ale dají použít se všemi třídami syndikace, které podporují data rozšíření.
Objektový model syndikace (SyndicationFeedSyndicationItem, a související třídy) podporuje volně typovaný přístup k datům rozšíření pomocí AttributeExtensions a ElementExtensions vlastností. Tato ukázka ukazuje, jak poskytovat přístup silného typu k datům rozšíření implementací vlastních odvozených tříd SyndicationFeed a SyndicationItem které zpřístupní určitá rozšíření specifická pro aplikaci jako vlastnosti silného typu.
Tento příklad ukazuje, jak implementovat rozšiřující prvek definovaný v navrhované atom threading Extensions RFC. Toto je pouze pro demonstrační účely a tento vzorek není zamýšlen jako úplná implementace navrhované specifikace.
Ukázkový KÓD XML
Následující příklad XML ukazuje položku Atom 1.0 s dodatečným <in-reply-to> rozšiřujícím elementem.
<entry>
<id>tag:example.org,2005:1,2</id>
<title type="text">Another response to the original</title>
<summary type="text">
This is a response to the original entry</summary>
<updated>2006-03-01T12:12:13Z</updated>
<link href="http://www.example.org/entries/1/2" />
<in-reply-to p3:ref="tag:example.org,2005:1"
p3:href="http://www.example.org/entries/1"
p3:type="application/xhtml+xml"
xmlns:p3="http://contoso.org/syndication/thread/1.0"
xmlns="http://contoso.org/syndication/thread/1.0">
<anotherElement xmlns="http://www.w3.org/2005/Atom">
Some more data</anotherElement>
<aDifferentElement xmlns="http://www.w3.org/2005/Atom">
Even more data</aDifferentElement>
</in-reply-to>
</entry>
Prvek <in-reply-to> určuje tři požadované atributy (reftypeahref) a zároveň umožňuje přítomnost dalších rozšiřujících atributů a rozšiřujících prvků.
Modelování elementu V-Reply-To
V této ukázce <in-reply-to> je prvek modelován jako CLR, který implementuje IXmlSerializable, což umožňuje jeho použití s DataContractSerializer. Implementuje také některé metody a vlastnosti pro přístup k datům elementu, jak je znázorněno v následujícím vzorovém kódu.
[XmlRoot(ElementName = "in-reply-to", Namespace = "http://contoso.org/syndication/thread/1.0")]
public class InReplyToElement : IXmlSerializable
{
internal const string ElementName = "in-reply-to";
internal const string NsUri =
"http://contoso.org/syndication/thread/1.0";
private Dictionary<XmlQualifiedName, string> extensionAttributes;
private Collection<XElement> extensionElements;
public InReplyToElement()
{
this.extensionElements = new Collection<XElement>();
this.extensionAttributes = new Dictionary<XmlQualifiedName,
string>();
}
public Dictionary<XmlQualifiedName, string> AttributeExtensions
{
get { return this.extensionAttributes; }
}
public Collection<XElement> ElementExtensions
{
get { return this.extensionElements; }
}
public Uri Href
{ get; set; }
public string MediaType
{ get; set; }
public string Ref
{ get; set; }
public Uri Source
{ get; set; }
}
Třída InReplyToElement implementuje vlastnosti požadovaného atributu (HRef, MediaTypea Source) a také kolekce pro blokování AttributeExtensions a ElementExtensions.
Třída InReplyToElement implementuje IXmlSerializable rozhraní, které umožňuje přímou kontrolu nad tím, jak se instance objektů čtou a zapisují do XML. Metoda ReadXml nejprve přečte hodnoty pro Ref, HRef, Sourcea MediaType vlastnosti z předaného XmlReader do něj. Všechny neznámé atributy jsou uloženy v kolekci AttributeExtensions . Pokud jsou všechny atributy přečteny, ReadStartElement() je volána pro přechod čtenáře na další prvek. Vzhledem k tomu, že element modelovaný touto třídou nemá žádné povinné podřízené položky, podřízené prvky se ukládají do vyrovnávací paměti do XElement instancí a uloženy v ElementExtensions kolekci, jak je znázorněno v následujícím kódu.
public void ReadXml(System.Xml.XmlReader reader)
{
bool isEmpty = reader.IsEmptyElement;
if (reader.HasAttributes)
{
for (int i = 0; i < reader.AttributeCount; i++)
{
reader.MoveToNextAttribute();
if (reader.NamespaceURI == "")
{
if (reader.LocalName == "ref")
{
this.Ref = reader.Value;
}
else if (reader.LocalName == "href")
{
this.Href = new Uri(reader.Value);
}
else if (reader.LocalName == "source")
{
this.Source = new Uri(reader.Value);
}
else if (reader.LocalName == "type")
{
this.MediaType = reader.Value;
}
else
{
this.AttributeExtensions.Add(new
XmlQualifiedName(reader.LocalName,
reader.NamespaceURI),
reader.Value);
}
}
}
}
reader.ReadStartElement();
if (!isEmpty)
{
while (reader.IsStartElement())
{
ElementExtensions.Add(
(XElement) XElement.ReadFrom(reader));
}
reader.ReadEndElement();
}
}
V WriteXml, InReplyToElement metoda nejprve zapíše hodnoty Ref, HRef, Source, a MediaType vlastnosti jako XML atributy (WriteXml není zodpovědný za zápis skutečné vnější element sám, jak to dělá volající ).WriteXml Zapisuje také obsah AttributeExtensions a ElementExtensions zapisovač, jak je znázorněno v následujícím kódu.
public void WriteXml(System.Xml.XmlWriter writer)
{
if (this.Ref != null)
{
writer.WriteAttributeString("ref", InReplyToElement.NsUri,
this.Ref);
}
if (this.Href != null)
{
writer.WriteAttributeString("href", InReplyToElement.NsUri,
this.Href.ToString());
}
if (this.Source != null)
{
writer.WriteAttributeString("source", InReplyToElement.NsUri,
this.Source.ToString());
}
if (this.MediaType != null)
{
writer.WriteAttributeString("type", InReplyToElement.NsUri,
this.MediaType);
}
foreach (KeyValuePair<XmlQualifiedName, string> kvp in
this.AttributeExtensions)
{
writer.WriteAttributeString(kvp.Key.Name, kvp.Key.Namespace,
kvp.Value);
}
foreach (XElement element in this.ElementExtensions)
{
element.WriteTo(writer);
}
}
ThreadedFeed a ThreadedItem
V ukázce SyndicationItems se s rozšířeními InReplyTo modelují podle ThreadedItem třídy. Podobně je třída, ThreadedFeedSyndicationFeed jejíž položky jsou všechny instance ThreadedItem.
Třída ThreadedFeed dědí z SyndicationFeed a přepsání OnCreateItem , aby vrátila ThreadedItemznak . Také implementuje metodu pro přístup k Items kolekci, jak ThreadedItemsje znázorněno v následujícím kódu.
public class ThreadedFeed : SyndicationFeed
{
public ThreadedFeed()
{
}
public IEnumerable<ThreadedItem> ThreadedItems
{
get
{
return this.Items.Cast<ThreadedItem>();
}
}
protected override SyndicationItem CreateItem()
{
return new ThreadedItem();
}
}
Třída ThreadedItem zdědí SyndicationItem a vytvoří InReplyToElement jako vlastnost silného typu. To poskytuje pohodlný programový přístup k InReplyTo datům rozšíření. Implementuje TryParseElement také a WriteElementExtensions pro čtení a zápis dat rozšíření, jak je znázorněno v následujícím kódu.
public class ThreadedItem : SyndicationItem
{
private InReplyToElement inReplyTo;
// Constructors
public ThreadedItem()
{
inReplyTo = new InReplyToElement();
}
public ThreadedItem(string title, string content, Uri itemAlternateLink, string id, DateTimeOffset lastUpdatedTime) : base(title, content, itemAlternateLink, id, lastUpdatedTime)
{
inReplyTo = new InReplyToElement();
}
public InReplyToElement InReplyTo
{
get { return this.inReplyTo; }
}
protected override bool TryParseElement(
System.Xml.XmlReader reader,
string version)
{
if (version == SyndicationVersions.Atom10 &&
reader.NamespaceURI == InReplyToElement.NsUri &&
reader.LocalName == InReplyToElement.ElementName)
{
this.inReplyTo = new InReplyToElement();
this.InReplyTo.ReadXml(reader);
return true;
}
else
{
return base.TryParseElement(reader, version);
}
}
protected override void WriteElementExtensions(XmlWriter writer,
string version)
{
if (this.InReplyTo != null &&
version == SyndicationVersions.Atom10)
{
writer.WriteStartElement(InReplyToElement.ElementName,
InReplyToElement.NsUri);
this.InReplyTo.WriteXml(writer);
writer.WriteEndElement();
}
base.WriteElementExtensions(writer, version);
}
}
Nastavení, sestavení a spuštění ukázky
Ujistěte se, že jste pro ukázky windows Communication Foundation provedli jednorázovou instalační proceduru.
Pokud chcete sestavit edici C# nebo Visual Basic .NET řešení, postupujte podle pokynů v části Sestavení ukázek windows Communication Foundation.
Pokud chcete spustit ukázku v konfiguraci s jedním nebo více počítači, postupujte podle pokynů v části Spuštění ukázek windows Communication Foundation.