SyndicationItem.Summary Property

Definition

Namespace:

System.ServiceModel.Syndication

Assembly:

System.ServiceModel.Syndication.dll

Package:

System.ServiceModel.Syndication v9.0.0

Source:

SyndicationItem.cs

Gets or sets the summary of the syndication item.

public:
 property System::ServiceModel::Syndication::TextSyndicationContent ^ Summary { System::ServiceModel::Syndication::TextSyndicationContent ^ get(); void set(System::ServiceModel::Syndication::TextSyndicationContent ^ value); };

public System.ServiceModel.Syndication.TextSyndicationContent Summary { get; set; }

member this.Summary : System.ServiceModel.Syndication.TextSyndicationContent with get, set

Public Property Summary As TextSyndicationContent

Property Value

TextSyndicationContent

A TextSyndicationContent that contains a summary of the item.

Examples

The following code shows how to set the Summary property on a SyndicationItem instance.

SyndicationItem item = new SyndicationItem("Item Title", "Item Content", new Uri("http://Item/Alternate/Link"));
item.Summary = new TextSyndicationContent("This is a syndication item summary");

Dim item As New SyndicationItem("Item Title", "Item Content", New Uri("http:' Item/Alternate/Link"))
item.Summary = New TextSyndicationContent("This is a syndication item summary")

The following XML shows how the Summary property is serialized to Atom 1.0.

<summary type="text">this is a summary for my item</summary>

The following XML shows how the Summary property is serialized to RSS 2.0.

<description>this is a summary for my item</description>

Remarks

When serialized to Atom 1.0, this property is written to a <summary> element. When serialized to RSS 2.0, this property is written to a <description> element.