SyndicationFeed.Description Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets and sets a description of the feed.

Namespace:   System.ServiceModel.Syndication
Assembly:  System.ServiceModel (in System.ServiceModel.dll)

public TextSyndicationContent Description { get; set; }

Property Value

Type: System.ServiceModel.Syndication.TextSyndicationContent

A TextSyndicationContent object that represents the description of the feed.

When serialized to Atom 1.0, Description is written to a <subtitle> element.

When serialized to RSS 2.0, Description is written to a <description> element.

The following code shows how to set the Description of a SyndicationFeed.

List<SyndicationItem> items = new List<SyndicationItem>();

SyndicationItem item1 = new SyndicationItem();
item1.Title = new TextSyndicationContent("Item 1");
item1.Content = SyndicationContent.CreatePlaintextContent("This is the content for Item 1");
items.Add(item1);

SyndicationItem item2 = new SyndicationItem();
item2.Title = new TextSyndicationContent("Item 2");
item2.Content = SyndicationContent.CreatePlaintextContent("This is the content for Item 2");
items.Add(item2);

SyndicationFeed feed = new SyndicationFeed(items);
feed.Description = new TextSyndicationContent("This is a feed description");

The following XML shows how Description is serialized to Atom 1.0.

<subtitle type="text">This is a sample feed</subtitle>

The following XML shows how Description is serialized to RSS 2.0.

<description>This is a sample feed</description>

.NET Framework
Available since 3.5
Silverlight
Available since 2.0
Return to top
Show: