Click or drag to resize
CMSDataList Class
Multicolumn document viewer (DataList).
Inheritance Hierarchy

Namespace: CMS.Controls
Assembly: CMS.Controls (in CMS.Controls.dll) Version: 8.2.23
public class CMSDataList : BasicDataList, 
	ICMSDataProperties, ICMSControlProperties, ICMSBaseProperties

The CMSDataList type exposes the following members.

Public methodCMSDataList
Protected methodBoundPagerToDataSource
Bound pager to the external external DataSource
(Inherited from BasicDataList.)
Public methodClearCache
Clears the cached items.
Protected methodCreateControlHierarchy
Creates a control hierarchy with or without the specified data source.
(Inherited from BasicDataList.)
Protected methodCreateChildControls
Disable default create child controls.
(Overrides BaseDataListCreateChildControls.)
Public methodDataBind
Databind event.
(Overrides BaseDataListDataBind.)
Public methodGetDefaultCacheDependencies
Gets the default cache dependencies for the data source.
Public methodStatic memberGetRepeatDirection
Returns the repeat direction based on the given string.
Public methodStatic memberGetRepeatLayout
Returns the repeat layout based on the given string.
Public methodHasData
Indicates if data source contains data.
(Inherited from BasicDataList.)
Protected methodInitControl
Ensures default data binding
(Overrides BasicDataListInitControl(Boolean).)
Protected methodLoadDynamicControls
Handles the Item Create event and creates dynamic control s if present.
(Inherited from BasicDataList.)
Protected methodOnInit
Init event handler.
(Inherited from BasicDataList.)
Protected methodOnLoad
OnLoad event handler
(Inherited from BasicDataList.)
Protected methodPrepareControlHierarchy
Disable prepare control hierarchy.
(Overrides DataListPrepareControlHierarchy.)
Protected methodRaiseOnBeforeInit
Raises the OnBeforeInit event.
(Inherited from BasicDataList.)
Public methodReBind
Evokes control databind.
(Inherited from BasicDataList.)
Public methodReleaseContext
Releases the web part context.
Public methodReloadData
Loads data from the according to the current values of properties.
(Overrides BasicDataListReloadData(Boolean).)
Protected methodRender
Render pager and datalist.
(Overrides BasicDataListRender(HtmlTextWriter).)
Public methodSetContext
Sets the web part context.
Extension Methods
Public Extension MethodAddCssClass
Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
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 MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetCssClasses
Returns all CSS classes of control.
(Defined by ControlsExtensions.)
Public Extension MethodGetRenderedHTML
Returns HTML which would be rendered by control to page.
(Defined by ControlsExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodHasCssClass
Checks whether the control has given CSS class. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodRemoveCssClass
Removes all occurrences. Class names are case sensitive.
(Defined by ControlsExtensions.)
Public Extension MethodSetCssClasses
Sets CSS classes to the control. Current classes will be overridden.
(Defined by ControlsExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Protected fielddetailMode
Is true when render detail of some document
Protected fieldmControlsLoaded
Flag saying whether the dynamic controls has been loaded yet.
(Inherited from BasicDataList.)
Protected fieldmDataLoaded
Flag saying whether the data has been loaded yet.
(Inherited from BasicDataList.)
Protected fieldmDataPager
Data pager.
Protected fieldmDataSource
Document data source.
Protected fieldmExternalPager
External pager control?
Protected fieldmFilterControl
Filter control.
Protected fieldmFilterName
Filter name.
Protected fieldmOnBeforeInitFired
True if the on before init was fired.
(Inherited from BasicDataList.)
Protected fieldmPageSizeSet
Indicates if page size property is set.
Protected fieldmRelatedData
Custom data connected to the object.
(Inherited from BasicDataList.)
Protected fieldmRelatedDataLoaded
Related data is loaded.
(Inherited from BasicDataList.)
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 BasicDataList.)
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 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 BasicDataList.)
Public propertyDataSource
Object from which data-bound control retrieves its list of data item.
(Inherited from BasicDataList.)
Public propertyDataSourceControl
Control with data source.
(Inherited from BasicDataList.)
Public propertyDataSourceName
Data source name.
(Inherited from BasicDataList.)
Protected propertyDefaultDataSource
Default data source to use if no external is provided
(Overrides BasicDataListDefaultDataSource.)
Public propertyDelayedLoading
Indicates whether the data should be loaded to the load event instead of default init event.
Public propertyEnablePaging
Enables paging.
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. The default value is False.
(Inherited from BasicDataList.)
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 propertyIsSelected
Gets a value indicating whether the current item is a selected item.
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 BasicDataList.)
Public propertyPagerControl
Represents pager control.
Public propertyPagerDataItem
Pager data item object.
(Inherited from BasicDataList.)
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 BasicDataList.)
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 BasicDataList.)
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 BasicDataList.)
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 UIDataList.)
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 BasicDataList.)
Public propertyWhereCondition
Property to set and get the WhereCondition.
Public propertyZeroRowsText
Text to be shown when the control is hidden by HideControlForZeroRows.
(Inherited from BasicDataList.)
Public eventOnBeforeInit
On before init handler.
(Inherited from BasicDataList.)
Public eventOnPageBinding
Occurs when the control bind data.
(Inherited from BasicDataList.)
Public eventOnPageChanged
Occurs when the pager change the page and current mode is postback => reload data
(Inherited from BasicDataList.)
See Also