CMSDataGrid Class |
Namespace: CMS.Controls
public class CMSDataGrid : BasicDataGrid, ICMSDataProperties, ICMSControlProperties, ICMSBaseProperties
The CMSDataGrid type exposes the following members.
Name | Description | |
---|---|---|
CMSDataGrid |
Constructor.
| |
CMSDataGrid(TreeProvider) |
Constructor.
|
Name | Description | |
---|---|---|
ClearCache |
Clears the cached items.
| |
Control_PreRender |
Control prerender code.
(Inherited from BasicDataGrid.) | |
DataBind |
Binds data to the grid and displays the sorting symbols.
(Inherited from BasicDataGrid.) | |
GetCacheDependency |
Gets the cache dependency for the control.
| |
GetDataSet |
Retrieves DataSet.
| |
GetDefaultCacheDependencies |
Gets the default cache dependencies for the data source.
| |
GetPagerMode |
Returns the pager position based on the given string.
(Inherited from BasicDataGrid.) | |
OnInit |
Init event handler.
(Overrides BasicDataGridOnInit(EventArgs).) | |
OnLoad |
OnPreRender event handler. It automatically selects and binds data unless DataBindByDefault is false.
(Overrides BasicDataGridOnLoad(EventArgs).) | |
OnPageIndexChanged |
OnPageIndexChanged event handler. It ensures displaying of the given page.
(Overrides BasicDataGridOnPageIndexChanged(DataGridPageChangedEventArgs).) | |
OnPreRender |
OnPreRender event handler. It automatically selects and binds data unless DataBindByDefault is false.
(Overrides UIDataGridOnPreRender(EventArgs).) | |
OnSortCommand |
OnSortCommand event handler. It sorts data by selected column.
(Overrides BasicDataGridOnSortCommand(DataGridSortCommandEventArgs).) | |
PrepareControlHierarchy |
Prepare control hierarchy.
(Overrides DataGridPrepareControlHierarchy.) | |
RaiseOnBeforeInit |
Raises the OnBeforeInit event.
(Inherited from BasicDataGrid.) | |
ReleaseContext |
Releases the web part context.
| |
ReloadData |
Reloads the control data.
| |
Render |
Render CMSDataGrid.
(Overrides BasicDataGridRender(HtmlTextWriter).) | |
SetContext |
Sets the web part context.
|
Name | Description | |
---|---|---|
AddCssClass |
Adds CSS class to control. If class is already present, than adding is skipped. Class names are case sensitive.
(Defined by ControlsExtensions.) | |
AsValue |
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.) | |
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.) | |
GetAPIString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) | |
GetCssClasses |
Returns all CSS classes of control.
(Defined by ControlsExtensions.) | |
GetRenderedHTML |
Returns HTML which would be rendered by control to page.
(Defined by ControlsExtensions.) | |
GetString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) | |
HasCssClass |
Checks whether the control has given CSS class. Class names are case sensitive.
(Defined by ControlsExtensions.) | |
RemoveCssClass |
Removes all occurrences. Class names are case sensitive.
(Defined by ControlsExtensions.) | |
SetCssClasses |
Sets CSS classes to the control. Current classes will be overridden.
(Defined by ControlsExtensions.) | |
ToBoolean |
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToDateTime |
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToDouble |
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToGuid |
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToInteger |
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.) | |
ToString |
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.) |
Name | Description | |
---|---|---|
mFilterControl |
Filter control.
| |
mFilterName |
Filter name.
| |
mOnBeforeInitFired |
True if the on before init was fired.
(Inherited from BasicDataGrid.) | |
mProperties |
Properties object to set DataProperties.
| |
mRelatedData |
Custom data connected to the object.
(Inherited from BasicDataGrid.) | |
mRelatedDataLoaded |
Related data is loaded.
(Inherited from BasicDataGrid.) |
Name | Description | |
---|---|---|
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 DataGridAutoGenerateColumns.) | |
CacheDependencies |
Cache dependencies, each cache dependency on a new line.
| |
CacheItemName |
Name of the cache item the control will use.
| |
CacheMinutes |
Number of minutes the retrieved content is cached for. Zero indicates that the content will not be cached.
| |
CategoryName |
Property to set and get the category name for filtering documents.
| |
ClassNames |
Property to set and get the classnames list (separated by the semicolon).
| |
CombineWithDefaultCulture |
Property to set and get the CombineWithDefaultCulture flag.
| |
ControlContext |
Control context.
| |
CultureCode |
Property to set and get the CultureCode.
| |
DataBindByDefault |
Indicates whether data binding should be performed by default.
(Inherited from BasicDataGrid.) | |
DataSource |
Gets or sets the object from which data-bound control retrieves its list of data item.
(Inherited from UIDataGrid.) | |
FilterControl |
Filter control.
| |
FilterName |
Gets or Set filter name.
| |
FilterOutDuplicates |
Indicates if the duplicated (linked) items should be filtered out from the data.
| |
HideControlForZeroRows |
Hides the control when no data is loaded. Default value is False.
(Inherited from BasicDataGrid.) | |
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.
| |
MaxRelativeLevel |
Property to set and get the MaxRelativeLevel.
| |
OrderBy |
Property to set and get the OrderBy.
| |
PageSize |
Number of items per page.
(Overrides DataGridPageSize.) | |
Path |
Property to set and get the Path.
| |
ProcessSorting |
Indicates if sorting should be processed in DataView instead of sorting on the SQL level.
(Inherited from BasicDataGrid.) | |
RelatedData |
Custom data connected to the object, if not set, returns the Related data of the nearest IDataControl.
(Inherited from BasicDataGrid.) | |
RelatedNodeIsOnTheLeftSide |
If true, the returned nodes are on the right side of the relationship.
| |
RelationshipName |
Name of the relationship.
| |
RelationshipWithNodeGuid |
Select nodes with given relationship with given node.
| |
SelectedColumns |
Gets or sets the columns to be retrieved from database.
| |
SelectedItemTransformationName |
Transformation name for selected item in format application.class.transformation.
| |
SelectOnlyPublished |
Property to set and get the SelectOnlyPublished flag.
| |
SelectTopN |
Top N rows to select.
| |
SetFirstPageAfterSortChange |
Indicates if page index is set to the first page after sort change.
(Inherited from BasicDataGrid.) | |
ShortID |
Short ID of the control.
(Inherited from UIDataGrid.) | |
SiteName |
Property to set and get the SiteName.
| |
SortAscending |
Direction of sorting. Default value is True.
(Inherited from BasicDataGrid.) | |
SortField |
Gets or sets the sort field. It can be used for setting the default sort field.
(Inherited from BasicDataGrid.) | |
StopProcessing |
Stop processing
| |
TopN |
Select top N rows.
| |
TreeProvider |
Tree provider instance used to access data. If no TreeProvider is assigned, a new TreeProvider instance is created.
| |
WhereCondition |
Property to set and get the WhereCondition.
| |
ZeroRowsText |
Text to be shown when control is hidden by HideControlForZeroRows.
(Inherited from BasicDataGrid.) |
Name | Description | |
---|---|---|
OnBeforeInit |
On before init handler.
(Inherited from BasicDataGrid.) |