Atom10ItemFormatter<TSyndicationItem> Class

Definition

Namespace:

System.ServiceModel.Syndication

Assembly:

System.ServiceModel.Syndication.dll

Package:

System.ServiceModel.Syndication v9.0.0-rc.2.24473.5

A class that serializes SyndicationItem-derived classes to and from Atom 1.0 format.

generic <typename TSyndicationItem>
 where TSyndicationItem : SyndicationItemgcnew()public ref class Atom10ItemFormatter : System::ServiceModel::Syndication::Atom10ItemFormatter

public class Atom10ItemFormatter<TSyndicationItem> : System.ServiceModel.Syndication.Atom10ItemFormatter where TSyndicationItem : SyndicationItem, new()

type Atom10ItemFormatter<'SyndicationItem (requires 'SyndicationItem :> SyndicationItem and 'SyndicationItem : (new : unit -> 'SyndicationItem))> = class
    inherit Atom10ItemFormatter

Public Class Atom10ItemFormatter(Of TSyndicationItem)
Inherits Atom10ItemFormatter

Type Parameters

TSyndicationItem

The SyndicationItem -derived class to serialize.

Inheritance

Object

SyndicationItemFormatter

Atom10ItemFormatter

Atom10ItemFormatter<TSyndicationItem>

Examples

The following code demonstrates how to create a SyndicationItem-derived class and serialize it to Atom 1.0.

MySyndicationItem item = new MySyndicationItem("Test Item", "This is the content for Test Item", new Uri("http://localhost/ItemOne"), "TestItemID", DateTime.Now);

item.Links.Add(new SyndicationLink(new Uri("http://someuri"), "alternate", "MyItemLink", "text/html", 100));
item.PublishDate = new DateTime(1968, 2, 23);
item.LastUpdatedTime = DateTime.Today;
item.SourceFeed = new SyndicationFeed();
item.Summary = new TextSyndicationContent("This the item summary");

XmlWriter atomWriter = XmlWriter.Create("AtomItem.xml");
Atom10ItemFormatter<MySyndicationItem> formatter = new Atom10ItemFormatter<MySyndicationItem>(item);
formatter.WriteTo(atomWriter);
atomWriter.Close();

Dim item As MySyndicationItem = New MySyndicationItem("Test Item", "This is the content for Test Item", New Uri("http:'localhost/ItemOne"), "TestItemID", DateTime.Now)

item.Links.Add(New SyndicationLink(New Uri("http:'someuri"), "alternate", "MyItemLink", "text/html", 100))
item.PublishDate = New DateTime(1968, 2, 23)
item.LastUpdatedTime = DateTime.Today
item.SourceFeed = New SyndicationFeed()
item.Summary = New TextSyndicationContent("This the item summary")

Dim atomWriter As XmlWriter = XmlWriter.Create("AtomItem.xml")
Dim formatter As Atom10ItemFormatter(Of MySyndicationItem) = New Atom10ItemFormatter(Of MySyndicationItem)(item)
formatter.WriteTo(atomWriter)
atomWriter.Close()

Remarks

Use this class to serialize instances of SyndicationItem-derived classes and to create instances of SyndicationFeed-derived classes from XML documents that contain Atom1.0 entries. If you must serialize a SyndicationItem instance use the Atom10ItemFormatter formatter instead.

Note

The Atom 1.0 specification allows for fractional seconds to be specified in any of its date constructs. When serializing and deserializing, the WCF implementation ignores the fractional seconds.

Constructors

Atom10ItemFormatter<TSyndicationItem>()	Creates a new instance of the Atom10ItemFormatter<TSyndicationItem> class.
Atom10ItemFormatter<TSyndicationItem>(TSyndicationItem)	Creates a new instance of the Atom10ItemFormatter<TSyndicationItem> class with the specified SyndicationItem-derived instance.

Properties

Item	Gets the SyndicationItem associated with the formatter. (Inherited from SyndicationItemFormatter)
ItemType	Gets the type of the syndication item associated with the Atom10ItemFormatter. (Inherited from Atom10ItemFormatter)
PreserveAttributeExtensions	Gets or sets a value that specifies whether to preserve attribute extensions during serialization. (Inherited from Atom10ItemFormatter)
PreserveElementExtensions	Gets or sets a value that specifies whether to preserve element extensions during serialization. (Inherited from Atom10ItemFormatter)
Version	Gets the syndication version used by the formatter. (Inherited from Atom10ItemFormatter)

Methods

CanRead(XmlReader)	Verifies whether the specified XmlReader contains a valid Atom 1.0 syndication item. (Inherited from Atom10ItemFormatter)
CreateItemInstance()	Creates a new instance of the SyndicationItem-derived class.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ReadFrom(XmlReader)	Reads an Atom 1.0 syndication item from the specified XmlReader instance. (Inherited from Atom10ItemFormatter)
SetItem(SyndicationItem)	Associates a SyndicationItem instance with the SyndicationItemFormatter. (Inherited from SyndicationItemFormatter)
ToString()	Gets a string representation of the SyndicationItemFormatter instance. (Inherited from SyndicationItemFormatter)
WriteElementExtensions(XmlWriter, SyndicationCategory, String)	Writes the element extensions in the SyndicationCategory instance to the specified XmlWriter in the specified syndication version. (Inherited from SyndicationItemFormatter)
WriteElementExtensions(XmlWriter, SyndicationLink, String)	Writes the element extensions in the SyndicationLink instance to the specified XmlWriter in the specified syndication version. (Inherited from SyndicationItemFormatter)
WriteElementExtensions(XmlWriter, SyndicationPerson, String)	Writes the element extensions in the SyndicationPerson instance to the specified XmlWriter in the specified syndication version. (Inherited from SyndicationItemFormatter)
WriteTo(XmlWriter)	Writes the SyndicationItem associated with the Atom10ItemFormatter to the specified XmlWriter. (Inherited from Atom10ItemFormatter)

Explicit Interface Implementations

IXmlSerializable.GetSchema()	Implements the GetSchema() method. (Inherited from Atom10ItemFormatter)
IXmlSerializable.ReadXml(XmlReader)	Implements the ReadXml(XmlReader) method. (Inherited from Atom10ItemFormatter)
IXmlSerializable.WriteXml(XmlWriter)	Implements the WriteXml(XmlWriter) method. (Inherited from Atom10ItemFormatter)