Click or drag to resize
CMSRepeater Class
Repeater control that can be bounded to the CMS content.
Inheritance Hierarchy
SystemObject
  System.Web.UIControl
    System.Web.UI.WebControlsRepeater
      CMS.Base.Web.UIUIRepeater
        CMS.DocumentEngine.Web.UIBasicRepeater
          CMS.DocumentEngine.Web.UICMSRepeater
            CMS.DocumentEngine.Web.UICMSRepeaterWithEffect

Namespace: CMS.DocumentEngine.Web.UI
Assembly: CMS.DocumentEngine.Web.UI (in CMS.DocumentEngine.Web.UI.dll) Version: 13.0.131
Syntax
C#
public class CMSRepeater : BasicRepeater, 
	ICMSDataProperties, ICMSControlProperties, ICMSBaseProperties, IStopProcessing

The CMSRepeater type exposes the following members.

Constructors
Fields
  NameDescription
Protected fieldmControlsLoaded
Flag saying whether the dynamic controls has been loaded yet.
(Inherited from BasicRepeater.)
Protected fieldmDataLoaded
Flag saying whether the data has been loaded yet.
(Inherited from BasicRepeater.)
Protected fieldmDataPager
DataPager variable.
Protected fieldmDataSource
Document data source.
Protected fieldmExternalPager
External pager control?
Protected fieldmFilterControl
Filter control.
Protected fieldmFilterName
Filter name.
Protected fieldmItemSeparator
Item separator code.
Protected fieldmOnBeforeInitFired
True if the on before init was fired.
(Inherited from BasicRepeater.)
Protected fieldmPageSizeSet
Indicates if page size property is set.
Protected fieldmRelatedData
Custom data connected to the object.
(Inherited from BasicRepeater.)
Protected fieldmRelatedDataLoaded
Related data is loaded.
(Inherited from BasicRepeater.)
Protected fieldNoData
When DataSource is empty NoData = true
Protected fielduseDataSourceControl
Indicates whether the viewer should obtain data source from the referenced control provided by the value of DataSourceControl property.
(Inherited from BasicRepeater.)
Top
Properties
  NameDescription
Public propertyAlternatingTransformationName
Transformation name in format application.class.transformation applied to alternating items.
Public propertyCacheDependencies
Cache dependencies, each cache dependency on a new line.
Public propertyCacheItemName
Name of the cache item the control will use.
Public propertyCacheMinutes
Number of minutes the retrieved content is cached for. Zero indicates that the content will not be cached.
Public propertyCategoryName
Property to set and get the category name for filtering documents.
Public propertyCheckPermissions
Allows you to specify whether to check permissions of the current user. If the value is 'false' (default value) no permissions are checked. Otherwise, only nodes for which the user has read permission are displayed.
Public propertyClassNames
Property to set and get the classnames list (separated by the semicolon).
Public propertyColumns
Gets or sets the columns to be retrieved from database.
Public propertyCombineWithDefaultCulture
Property to set and get the CombineWithDefaultCulture flag.
Public propertyControlContext
Control context.
Public propertyCultureCode
Property to set and get the CultureCode.
Public propertyDataBindByDefault
Indicates whether data binding should be performed by default.
(Inherited from BasicRepeater.)
Public propertyDataSource
Object from which data-bound control retrieves its list of data item.
(Inherited from BasicRepeater.)
Public propertyDataSourceControl
Control with data source.
(Inherited from BasicRepeater.)
Public propertyDataSourceName
Gets or sets name of source.
(Inherited from BasicRepeater.)
Protected propertyDefaultDataSource
Default data source to use if no external is provided
(Overrides BasicRepeaterDefaultDataSource.)
Public propertyDelayedLoading
Indicates whether the data should be loaded to the load event instead of default init event.
Public propertyEnablePaging
Enables paging on Data control
Public propertyFilterControl
Filter control.
Public propertyFilterName
Gets or Set filter name.
Public propertyFilterOutDuplicates
Indicates if the duplicated (linked) items should be filtered out from the data.
Public propertyHideControlForZeroRows
Hides the control when no data is loaded. Default value is False.
(Inherited from BasicRepeater.)
Public propertyIsSelected
Gets a value indicating whether the current item is a selected item.
Public propertyItemSeparator
Item separator between displayed records.
Public propertyLoadPagesIndividually
If true, each page is loaded individually in case of paging.
Public propertyMaxRelativeLevel
Property to set and get the MaxRelativeLevel.
Public propertyNestedControlsID
Nested controls ID, use ';' like separator.
Public propertyOrderBy
Property to set and get the OrderBy.
Public propertyPageableControl
Gets or sets the encapsulated control that implements IUniPageable interface.
(Inherited from BasicRepeater.)
Public propertyPagerControl
Represents pager control.
Public propertyPagerDataItem
Pager data item object.
(Inherited from BasicRepeater.)
Public propertyPagerForceNumberOfResults
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 propertyPageSize
Number of items per page.
Public propertyParentControl
Parent control.
Public propertyPath
Property to set and get the Path.
Public propertyRelatedData
Custom data connected to the object, if not set, returns the Related data of the nearest IDataControl.
(Inherited from BasicRepeater.)
Public propertyRelatedNodeIsOnTheLeftSide
If true, the returned nodes are on the right side of the relationship.
Public propertyRelationshipName
Name of the relationship.
Public propertyRelationshipWithNodeGuid
Select nodes with given relationship with given node.
Public propertyResolveDynamicControls
Gets or sets the value that indicates whether dynamic controls should be resolved
(Inherited from BasicRepeater.)
Public propertySelectedColumns
Gets or sets the columns to be retrieved from database.
Public propertySelectedItemTransformationName
Transformation name for selected item in format application.class.transformation.
Public propertySelectOnlyPublished
Property to set and get the SelectOnlyPublished flag.
Public propertySelectTopN
Top N rows to select.
Public propertyShortID
Short ID of the control.
(Inherited from UIRepeater.)
Public propertyShowDeleteButton
Show Delete button.
Public propertyShowEditButton
Show Edit and Delete buttons.
Public propertyShowEditDeleteButtons
Show Edit and Delete buttons.
Public propertySiteName
Property to set and get the SiteName.
Public propertyStopProcessing
Stop processing
Public propertyTopN
Select top N rows.
Public propertyTransformationName
Transformation name in format application.class.transformation.
Public propertyTreeProvider
Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created.
Public propertyUniPagerControl
Pager control.
(Inherited from BasicRepeater.)
Public propertyWhereCondition
Property to set and get the WhereCondition.
Public propertyZeroRowsText
Text to be shown when the control is hidden by HideControlForZeroRows.
(Inherited from BasicRepeater.)
Top
Methods
  NameDescription
Protected methodBoundPagerToDataSource
Bound pager to the external external DataSource
(Inherited from BasicRepeater.)
Public methodClearCache
Clears the cached items.
Protected methodCreateControlHierarchy
Creates a control hierarchy with or without the specified datasource.
(Inherited from BasicRepeater.)
Public methodDataBind
Databind event.
(Overrides BasicRepeaterDataBind.)
Public methodGetDefaultCacheDependencies
Gets the default cache dependencies for the data source.
Public methodHasData
Indicates if datasource contains data.
(Inherited from BasicRepeater.)
Protected methodInitControl
Ensures default data binding
(Overrides BasicRepeaterInitControl(Boolean).)
Protected methodOnInit
Init event handler.
(Inherited from BasicRepeater.)
Protected methodOnLoad
OnLoad event handler
(Inherited from BasicRepeater.)
Protected methodOnPreRender
OnPreRender override.
(Inherited from BasicRepeater.)
Protected methodRaiseOnBeforeInit
Raises the OnBeforeInit event.
(Inherited from BasicRepeater.)
Public methodReBind
Evokes control databind.
(Inherited from BasicRepeater.)
Public methodReleaseContext
Releases the web part context.
Public methodReloadData
Loads data from the according to the current values of properties.
(Overrides BasicRepeaterReloadData(Boolean).)
Protected methodReloadDataInternal
Loads data from the according to the current values of properties.
Protected methodRender
Render event handler.
(Overrides BasicRepeaterRender(HtmlTextWriter).)
Public methodSetContext
Sets the web part context.
Top
Extension Methods
  NameDescription
Public Extension MethodCallHandled
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 MethodGetString
Gets the string by the specified resource key
(Defined by ControlsExtensions.)
Top
Events
  NameDescription
Public eventOnBeforeInit
On before init handler.
(Inherited from BasicRepeater.)
Public eventOnPageBinding
Occurs when the control bind data.
(Inherited from BasicRepeater.)
Public eventOnPageChanged
Occurs when the pager change the page and current mode is postback => reload data
(Inherited from BasicRepeater.)
Top
See Also