InsertRSSFeed Class Content Studio 5.7 SDK
Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

Writes a list of RSS items to the supplied stream or the default response stream. The list can be formatted using the built-in formatting or the developer can supply an XSL stylesheet to have full control of the formatting. Up to three rows of data can be displayed for each item. For the built-in formatting, RSS 1.0 with the RDF syntax and version 0.91 and 2.0 are supported. The InsertRSSFeed class acts as the underlying engine for the Insert RSS Feed AS component.
Inheritance Hierarchy

SystemObject
  ContentStudio.SiteCodeBase
    ContentStudio.Site.ActiveScriptingActiveScriptingBase
      ContentStudio.Site.ActiveScriptingPageableComponent
        ContentStudio.Site.ActiveScriptingEPTBase
          ContentStudio.Site.ActiveScripting.MiscInsertRSSFeed

Namespace: ContentStudio.Site.ActiveScripting.Misc
Assembly: CS_SiteLib (in CS_SiteLib.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax

public sealed class InsertRSSFeed : EPTBase

The InsertRSSFeed type exposes the following members.

Constructors

  NameDescription
Public methodInsertRSSFeed
Constructs a new instance of the InsertRSSFeed class that writes to the default response stream
Public methodInsertRSSFeed(Stream)
Constructs a new instance of the InsertRSSFeed class that writes to the supplied stream.
Top
Properties

  NameDescription
Public propertyApplicationCacheName
Sets or gets a value that identifies the component on the entire web site. The default value is "RSS_Reader_Control1".
Public propertyApplicationTimeout
Sets or gets the timeout limit (in minutes) for the application cache to live before it is refreshed. The default value is 240.
Public propertyBackwardsComponentCompatibilityMode
Sets or gets a value that indicates whether the code runs in backwards compatibility component mode. The default value is false.
(Inherited from ActiveScriptingBase.)
Public propertyCellPadding
Sets or gets the CELLPADDING attribute on the generated table. The default value is zero. This property is ignored if a custom XSL stylesheet is supplied (XSLStyleSheet).
Public propertyCellSpacing
Sets or gets the CELLSPACING attribute on the generated table. The default value is zero. This property is ignored if a custom XSL stylesheet is supplied (XSLStyleSheet).
Public propertyClassForRow1
Sets or gets the CLASS attribute to be used with the first row displayed for each news item. The default value is an empty string. This property is ignored if a custom XSL stylesheet is supplied (XSLStyleSheet).
Public propertyClassForRow2
Sets or gets the CLASS attribute to be used with the second row displayed for each news item. The default value is an empty string. This property is ignored if a custom XSL stylesheet is supplied (XSLStyleSheet).
Public propertyClassForRow3
Sets or gets the CLASS attribute to be used with the third row displayed for each news item. The default value is an empty string. This property is ignored if a custom XSL stylesheet is supplied (XSLStyleSheet).
Public propertyComponentName
Gets the name of the component
(Overrides ActiveScriptingBaseComponentName.)
Public propertyConformance
Gets a value which specifies which type of code a component can generate.
(Overrides ActiveScriptingBaseConformance.)
Public propertyDateFormattingString
Sets or gets a value that indicates how DateTime values should be formatted. The default value is an empty string, using the default format of the system. For more information on the different date format strings, see the System.Globalization.DateTimeFormatInfo class documentation.
Public propertyDefaultItemTitleSize
Sets or gets a value that indicates the length of an alternative title when no title is supplied by the source. The alternative title is automatically constructed from the first N characters of the description followed by three dots. The default value is zero, which means that no alternative title is used.
Public propertyElementType
Gets a value which specifies the type of outer element the component generates.
(Overrides ActiveScriptingBaseElementType.)
Public propertyEncoding
Sets or gets the encoding the component uses. The default encoding is the UTF8 encoding without byte order mark.
(Inherited from ActiveScriptingBase.)
Public propertyNumberOfItems
Sets or gets a value that indicates the maximum number of displayed items in the feed. Use zero to display all available items. The default value is zero.
Public propertyRow1
Sets or gets a value that defines what the first row should display. The default value is RSSFields.Title. This property is ignored if a custom XSL stylesheet is supplied (XSLStyleSheet).
Public propertyRow1_IsLink
Sets or gets a value that indicates if the first row should be a link to the actual new item. The default value is true. This property is ignored if a custom XSL stylesheet is supplied (XSLStyleSheet).
Public propertyRow2
Sets or gets a value that defines what the second row should display. The default value is RSSFields.Description. This property is ignored if a custom XSL stylesheet is supplied (XSLStyleSheet).
Public propertyRow2_IsLink
Sets or gets a value that indicates if the second row should be a link to the actual new item. The default value is false. This property is ignored if a custom XSL stylesheet is supplied (XSLStyleSheet).
Public propertyRow3
Sets or gets a value that defines what the second row should display. The default value is RSSFields.Date. This property is ignored if a custom XSL stylesheet is supplied (XSLStyleSheet).
Public propertyRow3_IsLink
Sets or gets a value that indicates if the third row should be a link to the actual new item. The default value is false. This property is ignored if a custom XSL stylesheet is supplied (XSLStyleSheet).
Public propertyRowBackgroundColorEven
Sets or gets the background color of even numbered rows (2, 4 etc.). The default value is "#FFFFFF" (white). This property is ignored if a custom XSL stylesheet is supplied (XSLStyleSheet).
Public propertyRowBackgroundColorUneven
Sets or gets the background color of odd numbered rows (1, 3 etc.). The default value is "#F5F5F5" (light grey). This property is ignored if a custom XSL stylesheet is supplied (XSLStyleSheet).
Public propertySecureHtmlEncoding
Sets or gets a value that indicates if the displayed result should be HTML encoded. The default value is true.
Public propertySourceFile
Sets or gets the URL that acts as the source for the RSS Feed. The default value is "http://www.contentstudio.se/RSS".
Public propertyTableBorder
Sets or gets the BORDER attribute of the generated table. The default value is zero. This property is ignored if a custom XSL stylesheet is supplied (XSLStyleSheet).
Public propertyTableCaption
Sets or gets the CAPTION attribute connected to the generated table. The default value is an empty string, which omits the attribute.
Public propertyTableSummary
Sets or gets the SUMMARY attribute of the generated table. The default value is an empty string, which omits the attribute.
Public propertyTableWidth
Sets or gets the WIDTH attribute of the generated table. The default value is "100%". This property is ignored if a custom XSL stylesheet is supplied (XSLStyleSheet).
Public propertyUseApplicationCache
Sets or gets a value that indicates if application cache should be used. The default value is false.
Public propertyUseWrapping
Sets or gets a value that indicates if there should be an extra space inserted between each news item. The default value is false. This property is ignored if a custom XSL stylesheet is supplied (XSLStyleSheet).
Public propertyXSLStyleSheet
Sets or gets the URL that contains the XSL style sheet to be used to format the inserted RSS feed. The default value is an empty string. If this property is set, all other formatting options are ignored.
Top
Methods

  NameDescription
Public methodEquals (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodInvoke
Invokes the component and writes its content into the specified stream.
Public methodToString (Inherited from Object.)
Top
Remarks

To use this class, create an instance of this object, and call the Invoke method with an appropriate set of parameters. This class can throw exceptions, thus your code should be wrapped within try/catch statements in order to avoid the entire page to crash. This class generates inline code, thus you must wrap it into a block element to make the page validate according to the HTML/XHTML regulations. The generated code is fully HTML/XHTML strict compatible.
See Also

Reference