Atom10FeedFormatter<TSyndicationFeed> Atom10FeedFormatter<TSyndicationFeed> Atom10FeedFormatter<TSyndicationFeed> Atom10FeedFormatter<TSyndicationFeed> Class

Definition

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

generic <typename TSyndicationFeed>
 where TSyndicationFeed : SyndicationFeedgcnew()public ref class Atom10FeedFormatter : System::ServiceModel::Syndication::Atom10FeedFormatter
public class Atom10FeedFormatter<TSyndicationFeed> : System.ServiceModel.Syndication.Atom10FeedFormatter where TSyndicationFeed : SyndicationFeednew()
type Atom10FeedFormatter<'SyndicationFeed (requires 'SyndicationFeed :> SyndicationFeed and 'SyndicationFeed : (new : unit -> 'SyndicationFeed))> = class
    inherit Atom10FeedFormatter
Public Class Atom10FeedFormatter(Of TSyndicationFeed)
Inherits Atom10FeedFormatter

Type Parameters

TSyndicationFeed

The SyndicationFeed -derived type to serialize.

Inheritance
Atom10FeedFormatter<TSyndicationFeed>Atom10FeedFormatter<TSyndicationFeed>Atom10FeedFormatter<TSyndicationFeed>Atom10FeedFormatter<TSyndicationFeed>

Examples

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

MySyndicationFeed feed = new MySyndicationFeed("Test Feed", "This is a test feed", new Uri("http://Contoso/testfeed"), "TestFeedID", DateTime.Now);
SyndicationItem item = new SyndicationItem("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 = feed;
item.Summary = new TextSyndicationContent("This the item summary");

List<SyndicationItem> items = new List<SyndicationItem>();
items.Add(item);
feed.Items = items;

XmlWriter atomWriter = XmlWriter.Create("Atom.xml");
Atom10FeedFormatter<MySyndicationFeed> atomFormatter = new Atom10FeedFormatter<MySyndicationFeed>(feed);
atomFormatter.WriteTo(atomWriter);
atomWriter.Close();
Dim feed As MySyndicationFeed = New MySyndicationFeed("Test Feed", "This is a test feed", New Uri("http:'Contoso/testfeed"), "TestFeedID", DateTime.Now)
Dim item As SyndicationItem = New SyndicationItem("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 = feed
item.Summary = New TextSyndicationContent("This the item summary")

Dim items As List(Of SyndicationItem) = New List(Of SyndicationItem)
items.Add(item)
feed.Items = items

Dim atomWriter As XmlWriter = XmlWriter.Create("Atom.xml")
Dim atomFormatter As Atom10FeedFormatter(Of MySyndicationFeed) = New Atom10FeedFormatter(Of MySyndicationFeed)(feed)
atomFormatter.WriteTo(atomWriter)
atomWriter.Close()

Remarks

Use this class to serialize instances of SyndicationFeed-derived classes and to create instances of SyndicationFeed derived classes from XML documents that contain Atom 1.0 feeds. If you must serialize a SyndicationFeed instance, use the Atom10FeedFormatter 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

Atom10FeedFormatter<TSyndicationFeed>() Atom10FeedFormatter<TSyndicationFeed>() Atom10FeedFormatter<TSyndicationFeed>() Atom10FeedFormatter<TSyndicationFeed>()

Creates a new instance of the Atom10FeedFormatter<TSyndicationFeed> class.

Atom10FeedFormatter<TSyndicationFeed>(TSyndicationFeed) Atom10FeedFormatter<TSyndicationFeed>(TSyndicationFeed) Atom10FeedFormatter<TSyndicationFeed>(TSyndicationFeed) Atom10FeedFormatter<TSyndicationFeed>(TSyndicationFeed)

Creates a new instance of the Atom10FeedFormatter<TSyndicationFeed> class with the specified SyndicationFeed-derived instance.

Methods

CanRead(XmlReader) CanRead(XmlReader) CanRead(XmlReader) CanRead(XmlReader)

Verifies whether the specified XmlReader contains a valid Atom 1.0 syndication feed.

(Inherited from Atom10FeedFormatter)
CreateFeedInstance() CreateFeedInstance() CreateFeedInstance() CreateFeedInstance()

Creates a new instance of the SyndicationFeed derived class.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
ReadFrom(XmlReader) ReadFrom(XmlReader) ReadFrom(XmlReader) ReadFrom(XmlReader)

Reads an Atom 1.0 syndication feed from the specified XmlReader instance.

(Inherited from Atom10FeedFormatter)
ReadItem(XmlReader, SyndicationFeed) ReadItem(XmlReader, SyndicationFeed) ReadItem(XmlReader, SyndicationFeed) ReadItem(XmlReader, SyndicationFeed)

Reads a syndication item from XmlReader instance using the SyndicationFeed instance.

(Inherited from Atom10FeedFormatter)
ReadItems(XmlReader, SyndicationFeed, Boolean) ReadItems(XmlReader, SyndicationFeed, Boolean) ReadItems(XmlReader, SyndicationFeed, Boolean) ReadItems(XmlReader, SyndicationFeed, Boolean)

Reads in a collection of SyndicationItem instances from the specified XmlReader.

(Inherited from Atom10FeedFormatter)
SetFeed(SyndicationFeed) SetFeed(SyndicationFeed) SetFeed(SyndicationFeed) SetFeed(SyndicationFeed)

Associates a SyndicationFeed instance with the SyndicationFeedFormatter.

(Inherited from SyndicationFeedFormatter)
ToString() ToString() ToString() ToString()

Gets a string representation of the SyndicationFeedFormatter instance.

(Inherited from SyndicationFeedFormatter)
WriteItem(XmlWriter, SyndicationItem, Uri) WriteItem(XmlWriter, SyndicationItem, Uri) WriteItem(XmlWriter, SyndicationItem, Uri) WriteItem(XmlWriter, SyndicationItem, Uri)

Writes the specified SyndicationItem instance to the specified XmlWriter.

(Inherited from Atom10FeedFormatter)
WriteItems(XmlWriter, IEnumerable<SyndicationItem>, Uri) WriteItems(XmlWriter, IEnumerable<SyndicationItem>, Uri) WriteItems(XmlWriter, IEnumerable<SyndicationItem>, Uri) WriteItems(XmlWriter, IEnumerable<SyndicationItem>, Uri)

Writes a collection of SyndicationItem instances to the specified XmlWriter.

(Inherited from Atom10FeedFormatter)
WriteTo(XmlWriter) WriteTo(XmlWriter) WriteTo(XmlWriter) WriteTo(XmlWriter)

Writes the SyndicationFeed associated with the Atom10FeedFormatter to the specified XmlWriter.

(Inherited from Atom10FeedFormatter)

Properties

DateTimeParser DateTimeParser DateTimeParser DateTimeParser Inherited from SyndicationFeedFormatter
Feed Feed Feed Feed

Gets the SyndicationFeed associated with the formatter.

(Inherited from SyndicationFeedFormatter)
FeedType FeedType FeedType FeedType

The instance derived from SyndicationFeed that is associated with the Atom10FeedFormatter instance.

(Inherited from Atom10FeedFormatter)
PreserveAttributeExtensions PreserveAttributeExtensions PreserveAttributeExtensions PreserveAttributeExtensions

Gets or sets a value that specifies whether to preserve attribute extensions during serialization.

(Inherited from Atom10FeedFormatter)
PreserveElementExtensions PreserveElementExtensions PreserveElementExtensions PreserveElementExtensions

Gets or sets a value that specifies whether to preserve element extensions during serialization.

(Inherited from Atom10FeedFormatter)
UriParser UriParser UriParser UriParser Inherited from SyndicationFeedFormatter
Version Version Version Version

Gets the syndication version used by the formatter.

(Inherited from Atom10FeedFormatter)

Explicit Interface Implementations

IXmlSerializable.GetSchema() IXmlSerializable.GetSchema() IXmlSerializable.GetSchema() IXmlSerializable.GetSchema()

Implements the GetSchema() method.

(Inherited from Atom10FeedFormatter)
IXmlSerializable.ReadXml(XmlReader) IXmlSerializable.ReadXml(XmlReader) IXmlSerializable.ReadXml(XmlReader) IXmlSerializable.ReadXml(XmlReader)

Implements the ReadXml(XmlReader) method.

(Inherited from Atom10FeedFormatter)
IXmlSerializable.WriteXml(XmlWriter) IXmlSerializable.WriteXml(XmlWriter) IXmlSerializable.WriteXml(XmlWriter) IXmlSerializable.WriteXml(XmlWriter)

Implements the WriteXml(XmlWriter) method.

(Inherited from Atom10FeedFormatter)

Applies to