BasicDataList Class

Extended DataList control that automates data binding.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      System.Web.UI.WebControls.BaseDataList
        System.Web.UI.WebControls.DataList
          CMS.Base.Web.UI.UIDataList
            CMS.DocumentEngine.Web.UI.BasicDataList
              CMS.DocumentEngine.Web.UI.CMSDataList
              CMS.DocumentEngine.Web.UI.QueryDataList

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

Syntax

public class BasicDataList : UIDataList, 
	IUniPageable, IUniPageableContainer, IRelatedData

The BasicDataList type exposes the following members.

Constructors

	Name	Description
Public method	BasicDataList	Constructor.

Fields

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

Properties

	Name	Description
Public property	DataBindByDefault	Indicates whether data binding should be performed by default.
Public property	DataSource	Object from which data-bound control retrieves its list of data item. (Overrides UIDataList.DataSource.)
Public property	DataSourceControl	Control with data source.
Public property	DataSourceName	Data source name.
Protected property	DefaultDataSource	Default data source to use if no external is provided.
Public property	HideControlForZeroRows	Hides the control when no data is loaded. The default value is False.
Public property	PageableControl	Gets or sets the encapsulated control that implements IUniPageable interface.
Public property	PagerDataItem	Pager data item object.
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
Public property	RelatedData	Custom data connected to the object, if not set, returns the Related data of the nearest IDataControl.
Public property	ResolveDynamicControls	Gets or sets the value that indicates whether dynamic controls should be resolved
Public property	ShortID	Short ID of the control. (Inherited from UIDataList.)
Public property	UniPagerControl	Pager control.
Public property	ZeroRowsText	Text to be shown when the control is hidden by HideControlForZeroRows.

Methods

	Name	Description
Protected method	BoundPagerToDataSource	Bound pager to the external external DataSource
Protected method	CreateControlHierarchy	Creates a control hierarchy with or without the specified data source. (Overrides DataList.CreateControlHierarchy(Boolean).)
Public method	HasData	Indicates if data source contains data.
Protected method	InitControl	Ensures default data binding
Protected method	LoadDynamicControls	Handles the Item Create event and creates dynamic control s if present.
Protected method	OnInit	Init event handler. (Overrides UIDataList.OnInit(EventArgs).)
Protected method	OnLoad	OnLoad event handler (Overrides BaseDataList.OnLoad(EventArgs).)
Protected method	RaiseOnBeforeInit	Raises the OnBeforeInit event.
Public method	ReBind	Evokes control databind.
Public method	ReloadData	Reloads the control data, skips the loading if the data is already loaded.
Protected method	Render	Render event handler, to maintain the proper control rendering. (Overrides BaseDataList.Render(HtmlTextWriter).)

Extension Methods

	Name	Description
Public Extension Method	AddCssClass	Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive. (Defined by ControlsExtensions.)
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	GetCssClasses	Returns all CSS classes of control. (Defined by ControlsExtensions.)
Public Extension Method	GetRenderedHTML	Returns HTML which would be rendered by control to page. (Defined by ControlsExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by ControlsExtensions.)
Public Extension Method	HasCssClass	Checks whether the control has given CSS class. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	RemoveCssClass	Removes all occurrences. Class names are case sensitive. (Defined by ControlsExtensions.)
Public Extension Method	SetCssClasses	Sets CSS classes to the control. Current classes will be overridden. (Defined by ControlsExtensions.)

Events

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