Click or drag to resize
BasicDataList Class
Extended DataList control that automates data binding.
Inheritance Hierarchy
SystemObject
  System.Web.UIControl
    System.Web.UI.WebControlsWebControl
      System.Web.UI.WebControlsBaseDataList
        System.Web.UI.WebControlsDataList
          CMS.Base.Web.UIUIDataList
            CMS.DocumentEngine.Web.UIBasicDataList
              CMS.DocumentEngine.Web.UICMSDataList
              CMS.DocumentEngine.Web.UIQueryDataList

Namespace: CMS.DocumentEngine.Web.UI
Assembly: CMS.DocumentEngine.Web.UI (in CMS.DocumentEngine.Web.UI.dll) Version: 13.0.131
Syntax
C#
public class BasicDataList : UIDataList, 
	IUniPageable, IUniPageableContainer, IRelatedData

The BasicDataList type exposes the following members.

Constructors
  NameDescription
Public methodBasicDataList
Constructor.
Top
Fields
  NameDescription
Protected fieldmControlsLoaded
Flag saying whether the dynamic controls has been loaded yet.
Protected fieldmDataLoaded
Flag saying whether the data has been loaded yet.
Protected fieldmOnBeforeInitFired
True if the on before init was fired.
Protected fieldmRelatedData
Custom data connected to the object.
Protected fieldmRelatedDataLoaded
Related data is loaded.
Protected fielduseDataSourceControl
Indicates whether the viewer should obtain data source from the referenced control provided by the value of DataSourceControl property.
Top
Properties
  NameDescription
Public propertyDataBindByDefault
Indicates whether data binding should be performed by default.
Public propertyDataSource
Object from which data-bound control retrieves its list of data item.
(Overrides UIDataListDataSource.)
Public propertyDataSourceControl
Control with data source.
Public propertyDataSourceName
Data source name.
Protected propertyDefaultDataSource
Default data source to use if no external is provided.
Public propertyHideControlForZeroRows
Hides the control when no data is loaded. The default value is False.
Public propertyPageableControl
Gets or sets the encapsulated control that implements IUniPageable interface.
Public propertyPagerDataItem
Pager data item object.
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
Public propertyRelatedData
Custom data connected to the object, if not set, returns the Related data of the nearest IDataControl.
Public propertyResolveDynamicControls
Gets or sets the value that indicates whether dynamic controls should be resolved
Public propertyShortID
Short ID of the control.
(Inherited from UIDataList.)
Public propertyUniPagerControl
Pager control.
Public propertyZeroRowsText
Text to be shown when the control is hidden by HideControlForZeroRows.
Top
Methods
  NameDescription
Protected methodBoundPagerToDataSource
Bound pager to the external external DataSource
Protected methodCreateControlHierarchy
Creates a control hierarchy with or without the specified data source.
(Overrides DataListCreateControlHierarchy(Boolean).)
Public methodHasData
Indicates if data source contains data.
Protected methodInitControl
Ensures default data binding
Protected methodLoadDynamicControls
Handles the Item Create event and creates dynamic control s if present.
Protected methodOnInit
Init event handler.
(Overrides UIDataListOnInit(EventArgs).)
Protected methodOnLoad
OnLoad event handler
(Overrides BaseDataListOnLoad(EventArgs).)
Protected methodRaiseOnBeforeInit
Raises the OnBeforeInit event.
Public methodReBind
Evokes control databind.
Public methodReloadData
Reloads the control data, skips the loading if the data is already loaded.
Protected methodRender
Render event handler, to maintain the proper control rendering.
(Overrides BaseDataListRender(HtmlTextWriter).)
Top
Extension Methods
  NameDescription
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 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 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 ControlsExtensions.)
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.)
Top
Events
  NameDescription
Public eventOnBeforeInit
On before init handler.
Public eventOnPageBinding
Occurs when the control bind data.
Public eventOnPageChanged
Occurs when the pager change the page and current mode is postback => reload data
Top
See Also