CMSDataGrid Class

CMSDataGrid control.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.WebControls.WebControl
      System.Web.UI.WebControls.BaseDataList
        System.Web.UI.WebControls.DataGrid
          CMS.ExtendedControls.UIDataGrid
            CMS.Controls.BasicDataGrid
              CMS.Controls.CMSDataGrid

Namespace: CMS.Controls
Assembly: CMS.Controls (in CMS.Controls.dll) Version: 8.2.23

Syntax

public class CMSDataGrid : BasicDataGrid, 
	ICMSDataProperties, ICMSControlProperties, ICMSBaseProperties

The CMSDataGrid type exposes the following members.

Constructors

	Name	Description
Public method	CMSDataGrid()	Constructor.
Public method	CMSDataGrid(TreeProvider)	Constructor.

Methods

	Name	Description
Public method	ClearCache	Clears the cached items.
Protected method	Control_PreRender	Control prerender code. (Inherited from BasicDataGrid.)
Public method	DataBind	Binds data to the grid and displays the sorting symbols. (Inherited from BasicDataGrid.)
Public method	GetCacheDependency	Gets the cache dependency for the control.
Protected method	GetDataSet	Retrieves DataSet.
Public method	GetDefaultCacheDependencies	Gets the default cache dependencies for the data source.
Public method	GetPagerMode	Returns the pager position based on the given string. (Inherited from BasicDataGrid.)
Protected method	OnInit	Init event handler. (Overrides BasicDataGrid.OnInit(EventArgs).)
Protected method	OnLoad	OnPreRender event handler. It automatically selects and binds data unless DataBindByDefault is false. (Overrides BasicDataGrid.OnLoad(EventArgs).)
Protected method	OnPageIndexChanged	OnPageIndexChanged event handler. It ensures displaying of the given page. (Overrides BasicDataGrid.OnPageIndexChanged(DataGridPageChangedEventArgs).)
Protected method	OnPreRender	OnPreRender event handler. It automatically selects and binds data unless DataBindByDefault is false. (Overrides UIDataGrid.OnPreRender(EventArgs).)
Protected method	OnSortCommand	OnSortCommand event handler. It sorts data by selected column. (Overrides BasicDataGrid.OnSortCommand(DataGridSortCommandEventArgs).)
Protected method	PrepareControlHierarchy	Prepare control hierarchy. (Overrides DataGrid.PrepareControlHierarchy().)
Protected method	RaiseOnBeforeInit	Raises the OnBeforeInit event. (Inherited from BasicDataGrid.)
Public method	ReleaseContext	Releases the web part context.
Public method	ReloadData	Reloads the control data.
Protected method	Render	Render CMSDataGrid. (Overrides BasicDataGrid.Render(HtmlTextWriter).)
Public method	SetContext	Sets the web part context.

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	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
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	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
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 CoreExtensions.)
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.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

	Name	Description
Protected field	mFilterControl	Filter control.
Protected field	mFilterName	Filter name.
Protected field	mOnBeforeInitFired	True if the on before init was fired. (Inherited from BasicDataGrid.)
Public field	mProperties	Properties object to set DataProperties.
Protected field	mRelatedData	Custom data connected to the object. (Inherited from BasicDataGrid.)
Protected field	mRelatedDataLoaded	Related data is loaded. (Inherited from BasicDataGrid.)

Properties

	Name	Description
Public property	AutoGenerateColumns	Gets or sets a value that indicates whether BoundColumn objects are automatically created and displayed in the DataGrid control for each field in the data source. (Overrides DataGrid.AutoGenerateColumns.)
Public property	CacheDependencies	Cache dependencies, each cache dependency on a new line.
Public property	CacheItemName	Name of the cache item the control will use.
Public property	CacheMinutes	Number of minutes the retrieved content is cached for. Zero indicates that the content will not be cached.
Public property	CategoryName	Property to set and get the category name for filtering documents.
Public property	ClassNames	Property to set and get the classnames list (separated by the semicolon).
Public property	CombineWithDefaultCulture	Property to set and get the CombineWithDefaultCulture flag.
Public property	ControlContext	Control context.
Public property	CultureCode	Property to set and get the CultureCode.
Public property	DataBindByDefault	Indicates whether data binding should be performed by default. (Inherited from BasicDataGrid.)
Public property	DataSource	Gets or sets the object from which data-bound control retrieves its list of data item. (Inherited from UIDataGrid.)
Public property	FilterControl	Filter control.
Public property	FilterName	Gets or Set filter name.
Public property	FilterOutDuplicates	Indicates if the duplicated (linked) items should be filtered out from the data.
Public property	HideControlForZeroRows	Hides the control when no data is loaded. Default value is False. (Inherited from BasicDataGrid.)
Public property	CheckPermissions	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 property	MaxRelativeLevel	Property to set and get the MaxRelativeLevel.
Public property	OrderBy	Property to set and get the OrderBy.
Public property	PageSize	Number of items per page. (Overrides DataGrid.PageSize.)
Public property	Path	Property to set and get the Path.
Public property	ProcessSorting	Indicates if sorting should be processed in DataView instead of sorting on the SQL level. (Inherited from BasicDataGrid.)
Public property	RelatedData	Custom data connected to the object, if not set, returns the Related data of the nearest IDataControl. (Inherited from BasicDataGrid.)
Public property	RelatedNodeIsOnTheLeftSide	If true, the returned nodes are on the right side of the relationship.
Public property	RelationshipName	Name of the relationship.
Public property	RelationshipWithNodeGuid	Select nodes with given relationship with given node.
Public property	SelectedColumns	Gets or sets the columns to be retrieved from database.
Public property	SelectedItemTransformationName	Transformation name for selected item in format application.class.transformation.
Public property	SelectOnlyPublished	Property to set and get the SelectOnlyPublished flag.
Public property	SelectTopN	Top N rows to select.
Public property	SetFirstPageAfterSortChange	Indicates if page index is set to the first page after sort change. (Inherited from BasicDataGrid.)
Public property	ShortID	Short ID of the control. (Inherited from UIDataGrid.)
Public property	SiteName	Property to set and get the SiteName.
Public property	SortAscending	Direction of sorting. Default value is True. (Inherited from BasicDataGrid.)
Public property	SortField	Gets or sets the sort field. It can be used for setting the default sort field. (Inherited from BasicDataGrid.)
Public property	StopProcessing	Stop processing
Public property	TopN	Select top N rows.
Public property	TreeProvider	Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created.
Public property	WhereCondition	Property to set and get the WhereCondition.
Public property	ZeroRowsText	Text to be shown when control is hidden by HideControlForZeroRows. (Inherited from BasicDataGrid.)

Events

	Name	Description
Public event	OnBeforeInit	On before init handler. (Inherited from BasicDataGrid.)