SyndicationGenerator SyndicationGenerator SyndicationGenerator SyndicationGenerator Class

Definition

Describes the agent or the tool used to generate the feed. This class encapsulates information in the /rss/channel/generator element in RSS 2.0 or the /atom:feed/atom:generator element in Atom 1.0.

public : sealed class SyndicationGenerator : ISyndicationGenerator, ISyndicationNode
public sealed class SyndicationGenerator : ISyndicationGenerator, ISyndicationNode
Public NotInheritable Class SyndicationGenerator Implements ISyndicationGenerator, ISyndicationNode
var syndicationGenerator = new syndicationGenerator();
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

The following table maps SyndicationGenerator properties to RSS and Atom feed elements.

SyndicationGeneratorRSSAtom
Text (node value)(node value)
Uri uri (attribute)
Version version (attribute)

Constructors

SyndicationGenerator() SyndicationGenerator() SyndicationGenerator() SyndicationGenerator()

Creates a new SyndicationGenerator object.

public : SyndicationGenerator()
public SyndicationGenerator()
Public Sub New()
var syndicationGenerator = new syndicationGenerator();

SyndicationGenerator(String) SyndicationGenerator(String) SyndicationGenerator(String) SyndicationGenerator(String)

Creates a new SyndicationGenerator object with the specified Text property value.

public : SyndicationGenerator(Platform::String text)
public SyndicationGenerator(String text)
Public Sub New(text As String)
var syndicationGenerator = new syndicationGenerator(text);
Parameters
text
Platform::String String String String

Identifies the generator. This parameter represents the text content in the atom:generator element or the generator element in RSS 2.0.

Properties

AttributeExtensions AttributeExtensions AttributeExtensions AttributeExtensions

Gets the list of custom attributes of the element.

public : IVector<SyndicationAttribute> AttributeExtensions { get; }
public IList<SyndicationAttribute> AttributeExtensions { get; }
Public ReadOnly Property AttributeExtensions As IList<SyndicationAttribute>
var iList = syndicationGenerator.attributeExtensions;
Value
IVector<SyndicationAttribute> IList<SyndicationAttribute> IList<SyndicationAttribute> IList<SyndicationAttribute>

A list of attributes of the element.

BaseUri BaseUri BaseUri BaseUri

Gets or sets the base URI for the element. This property represents the xml:base attribute on the element. It may be inherited from an ancestor element.

public : Uri BaseUri { get; set; }
public Uri BaseUri { get; set; }
Public ReadWrite Property BaseUri As Uri
var uri = syndicationGenerator.baseUri;
syndicationGenerator.baseUri = uri;
Value
Uri Uri Uri Uri

The xml:base attribute on the element.

ElementExtensions ElementExtensions ElementExtensions ElementExtensions

Gets the list of child elements within the element.

public : IVector<ISyndicationNode> ElementExtensions { get; }
public IList<ISyndicationNode> ElementExtensions { get; }
Public ReadOnly Property ElementExtensions As IList<ISyndicationNode>
var iList = syndicationGenerator.elementExtensions;
Value
IVector<ISyndicationNode> IList<ISyndicationNode> IList<ISyndicationNode> IList<ISyndicationNode>

The list of child elements within the element.

Remarks

The following elements in the RSS 2.0 documents do not have public accessors;they can be accessed by searching the ElementExtensions collection on the SyndicationFeed object:

  • /rss/channel/docs
  • /rss/channel/cloud
  • /rss/channel/pubDate
  • /rss/channel/webmaster
  • /rss/channel/ttl
  • /rss/channel/rating
  • /rss/channel/textInput
  • /rss/channel/skipDays
  • /rss/channel/skipHours

Language Language Language Language

Gets or sets the language of the element. This property represents the xml:lang attribute on the element. It may be inherited from an ancestor element. It must be valid according to XML 1.0.

public : Platform::String Language { get; set; }
public string Language { get; set; }
Public ReadWrite Property Language As string
var string = syndicationGenerator.language;
syndicationGenerator.language = string;
Value
Platform::String string string string

The xml:lang attribute on the element.

NodeName NodeName NodeName NodeName

Gets or sets the local name of the element.

public : Platform::String NodeName { get; set; }
public string NodeName { get; set; }
Public ReadWrite Property NodeName As string
var string = syndicationGenerator.nodeName;
syndicationGenerator.nodeName = string;
Value
Platform::String string string string

The local name of the element. Must be valid according to XML 1.0.

NodeNamespace NodeNamespace NodeNamespace NodeNamespace

Gets or sets the namespace of the element.

public : Platform::String NodeNamespace { get; set; }
public string NodeNamespace { get; set; }
Public ReadWrite Property NodeNamespace As string
var string = syndicationGenerator.nodeNamespace;
syndicationGenerator.nodeNamespace = string;
Value
Platform::String string string string

The namespace of the element.

NodeValue NodeValue NodeValue NodeValue

Gets or sets the text content of the element. If the element contains only child elements, this property is NULL.

public : Platform::String NodeValue { get; set; }
public string NodeValue { get; set; }
Public ReadWrite Property NodeValue As string
var string = syndicationGenerator.nodeValue;
syndicationGenerator.nodeValue = string;
Value
Platform::String string string string

The text content of the element.

Text Text Text Text

Gets or sets the text that identifies the generator.

public : Platform::String Text { get; set; }
public string Text { get; set; }
Public ReadWrite Property Text As string
var string = syndicationGenerator.text;
syndicationGenerator.text = string;
Value
Platform::String string string string

The text content in the atom:generator element or the generator element in RSS 2.0.

Uri Uri Uri Uri

Gets or sets the Uniform Resource Identifier (URI) of the syndication generator.

public : Uri Uri { get; set; }
public Uri Uri { get; set; }
Public ReadWrite Property Uri As Uri
var uri = syndicationGenerator.uri;
syndicationGenerator.uri = uri;
Value
Uri Uri Uri Uri

The href attribute on atom:link.

Version Version Version Version

Gets or sets the version of the generator.

public : Platform::String Version { get; set; }
public string Version { get; set; }
Public ReadWrite Property Version As string
var string = syndicationGenerator.version;
syndicationGenerator.version = string;
Value
Platform::String string string string

The version attribute on atom:generator.

Methods

GetXmlDocument(SyndicationFormat) GetXmlDocument(SyndicationFormat) GetXmlDocument(SyndicationFormat) GetXmlDocument(SyndicationFormat)

Generates the DOM object that represents this element, all the attributes and child elements including foreign markups. The only formats accepted by this method are Atom 1.0 and RSS 2.0.

public : XmlDocument GetXmlDocument(SyndicationFormat format)
public XmlDocument GetXmlDocument(SyndicationFormat format)
Public Function GetXmlDocument(format As SyndicationFormat) As XmlDocument
var xmlDocument = syndicationGenerator.getXmlDocument(format);
Parameters
Returns

The DOM object that represents this element, and all the attributes and child elements, including foreign markups.

See Also