RSSRepeater Class

Extended XMLRepeater control that provides RSS support.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.Repeater
      CMS.Base.Web.UI.UIRepeater
        CMS.DocumentEngine.Web.UI.BasicRepeater
          CMS.DocumentEngine.Web.UI.XMLRepeater
            CMS.DocumentEngine.Web.UI.RSSRepeater

Namespace: CMS.DocumentEngine.Web.UI
Assembly: CMS.DocumentEngine.Web.UI (in CMS.DocumentEngine.Web.UI.dll) Version: 11.0.0

Syntax

public class RSSRepeater : XMLRepeater

The RSSRepeater type exposes the following members.

Constructors

	Name	Description
Public method	RSSRepeater

Fields

	Name	Description
Protected field	mControlsLoaded	Flag saying whether the dynamic controls has been loaded yet. (Inherited from BasicRepeater.)
Protected field	mDataLoaded	Flag saying whether the data has been loaded yet. (Inherited from BasicRepeater.)
Protected field	mOnBeforeInitFired	True if the on before init was fired. (Inherited from BasicRepeater.)
Protected field	mRelatedData	Custom data connected to the object. (Inherited from BasicRepeater.)
Protected field	mRelatedDataLoaded	Related data is loaded. (Inherited from BasicRepeater.)
Protected field	useDataSourceControl	Indicates whether the viewer should obtain data source from the referenced control provided by the value of DataSourceControl property. (Inherited from BasicRepeater.)

Properties

	Name	Description
Public property	CacheDependencies	Cache dependencies, each cache dependency on a new line. (Inherited from XMLRepeater.)
Public property	CacheItemName	Name of the cache item the control will use. (Inherited from XMLRepeater.)
Public property	CacheMinutes	Number of minutes the retrieved content is cached for. Zero indicates that the content will not be cached. (Inherited from XMLRepeater.)
Public property	ContentType	Content type of response. (Inherited from XMLRepeater.)
Public property	DataBindByDefault	Indicates whether data binding should be performed by default. (Inherited from XMLRepeater.)
Public property	DataSource	Object from which data-bound control retrieves its list of data item. (Inherited from BasicRepeater.)
Public property	DataSourceControl	Control with data source. (Inherited from BasicRepeater.)
Public property	DataSourceName	Gets or sets name of source. (Inherited from BasicRepeater.)
Protected property	DefaultDataSource	Default data source to use if no external is provided. (Inherited from BasicRepeater.)
Public property	DelayedLoading	Indicates whether the data should be loaded to the load event instead of default init event. (Inherited from XMLRepeater.)
Public property	Encoding	Content encoding. (UTF8 by default). (Inherited from XMLRepeater.)
Public property	FeedDescription	Description of the feed.
Public property	FeedLanguage	Language of the feed. If the value is empty the content culture will be used.
Public property	FeedLink	Link to feed.
Public property	FeedName	Name of feed for caching purposes. (Inherited from XMLRepeater.)
Public property	FeedTitle	URL title of the feed.
Public property	FooterXML	Custom feed footer XML which is generated after feed items. If the value is empty default footer for RSS feed is generated. (Overrides XMLRepeater.FooterXML.)
Public property	HeaderXML	Custom feed header XML which is generated before feed items. If the value is empty default header for RSS feed is generated. (Overrides XMLRepeater.HeaderXML.)
Public property	HideControlForZeroRows	Hides the control when no data is loaded. Default value is False. (Inherited from BasicRepeater.)
Public property	PageableControl	Gets or sets the encapsulated control that implements IUniPageable interface. (Inherited from BasicRepeater.)
Public property	PagerDataItem	Pager data item object. (Inherited from BasicRepeater.)
Public property	PagerForceNumberOfResults	Gets or sets the number of result. Enables proceed "fake" datasets, where number of results in the dataset is not correspondent to the real number of results This property must be equal -1 if should be disabled (Inherited from BasicRepeater.)
Public property	RelatedData	Custom data connected to the object, if not set, returns the Related data of the nearest IDataControl. (Inherited from BasicRepeater.)
Public property	ResolveDynamicControls	Gets or sets the value that indicates whether dynamic controls should be resolved (Inherited from BasicRepeater.)
Public property	ShortID	Short ID of the control. (Inherited from UIRepeater.)
Public property	StopProcessing	Stops further processing. (Inherited from XMLRepeater.)
Public property	TransformationName	Transformation name in format application.class.transformation. (Inherited from XMLRepeater.)
Public property	UniPagerControl	Pager control. (Inherited from BasicRepeater.)
Public property Static member	UseAtomLink	Gets or sets a value that indicates if the "atom:link" element should be used in the generated RSS feed. Default is true.
Public property	ZeroRowsText	Text to be shown when the control is hidden by HideControlForZeroRows. (Inherited from BasicRepeater.)

Methods

	Name	Description
Protected method	BoundPagerToDataSource	Bound pager to the external external DataSource (Inherited from BasicRepeater.)
Protected method	CreateControlHierarchy	Creates a control hierarchy with or without the specified datasource. (Inherited from BasicRepeater.)
Public method	DataBind	Overrides databind event. (Inherited from XMLRepeater.)
Public method	GetCacheDependency	Gets the cache dependency for the control. (Inherited from XMLRepeater.)
Public method	GetDefaultCacheDependendencies	Gets the default cache dependencies for the data source. (Inherited from XMLRepeater.)
Public method	HasData	Indicates if datasource contains data. (Inherited from BasicRepeater.)
Protected method	InitControl	Ensures default data binding (Inherited from XMLRepeater.)
Protected method	OnInit	Init event handler. (Inherited from BasicRepeater.)
Protected method	OnLoad	OnLoad event handler (Inherited from BasicRepeater.)
Protected method	OnPreRender	OnPreRender override. (Inherited from BasicRepeater.)
Protected method	RaiseOnBeforeInit	Raises the OnBeforeInit event. (Inherited from BasicRepeater.)
Public method	ReBind	Evokes control databind. (Inherited from BasicRepeater.)
Public method	ReloadData	Initializes the control properties. (Inherited from XMLRepeater.)
Protected method	Render	Overrides render event. (Inherited from XMLRepeater.)

Extension Methods

	Name	Description
Public Extension Method	CallHandled	Calls the method handled by the exception handler. If the call doesn't succeed, the problem is reported through parent IExceptionHandler control instead of throwing unhandled exception for the entire page. Returns true, if the call succeeded, otherwise returns false. (Defined by ControlsExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by ControlsExtensions.)

Events

	Name	Description
Public event	OnBeforeInit	On before init handler. (Inherited from BasicRepeater.)
Public event	OnPageBinding	Occurs when the control bind data. (Inherited from BasicRepeater.)
Public event	OnPageChanged	Occurs when the pager change the page and current mode is postback => reload data (Inherited from BasicRepeater.)