Click or drag to resize
QueryDataGrid Class
QueryDataGrid control.
Inheritance Hierarchy

Namespace: CMS.Controls
Assembly: CMS.Controls (in CMS.Controls.dll) Version: 9.0.0
Syntax
C#
public class QueryDataGrid : BasicDataGrid, 
	ICMSQueryProperties, ICMSBaseProperties

The QueryDataGrid type exposes the following members.

Constructors
  NameDescription
Public methodQueryDataGrid
Constructor.
Top
Fields
  NameDescription
Protected fieldmFilterControl
Filter control.
Protected fieldmFilterName
Filter name.
Protected fieldmOnBeforeInitFired
True if the on before init was fired.
(Inherited from BasicDataGrid.)
Protected fieldmRelatedData
Custom data connected to the object.
(Inherited from BasicDataGrid.)
Protected fieldmRelatedDataLoaded
Related data is loaded.
(Inherited from BasicDataGrid.)
Top
Properties
  NameDescription
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 propertyControlContext
Control context.
Public propertyCurrent
Current page number.
Public propertyDataBindByDefault
Indicates whether data binding should be performed by default.
(Inherited from BasicDataGrid.)
Public propertyDataSource
Gets or sets the object from which data-bound control retrieves its list of data item.
(Inherited from UIDataGrid.)
Public propertyFilterControl
Filter control.
Public propertyFilterName
Gets or Set filter name.
Public propertyForceCacheMinutes
Gets or sets the value that indicates whether cache minutes must be set manually (Cache minutes value is independent on view mode and cache settings)
Public propertyHideControlForZeroRows
Hides the control when no data is loaded. Default value is False.
(Inherited from BasicDataGrid.)
Public propertyOrderBy
Property to set and get the OrderBy.
Public propertyPageSize
Number of items per page.
(Overrides DataGridPageSize.)
Public propertyProcessSorting
Indicates if sorting should be processed in DataView instead of sorting on the SQL level.
(Inherited from BasicDataGrid.)
Public propertyQueryName
Query name in format application.class.query.
Public propertyQueryParameters
Query parameters.
Public propertyRelatedData
Custom data connected to the object, if not set, returns the Related data of the nearest IDataControl.
(Inherited from BasicDataGrid.)
Public propertySelectedColumns
Columns to select.
Public propertySelectTopN
Top N rows to select.
Public propertySetFirstPageAfterSortChange
Indicates if page index is set to the first page after sort change.
(Inherited from BasicDataGrid.)
Public propertyShortID
Short ID of the control.
(Inherited from UIDataGrid.)
Public propertySiteName
Gets or sets the sitename, this property has no effect in this control.
Public propertySortAscending
Direction of sorting. Default value is True.
(Inherited from BasicDataGrid.)
Public propertySortField
Gets or sets the sort field. It can be used for setting the default sort field.
(Inherited from BasicDataGrid.)
Public propertyStopProcessing
Stop processing
Public propertyTopN
Select top N rows.
Public propertyWhereCondition
Property to set and get the WhereCondition.
Public propertyZeroRowsText
Text to be shown when control is hidden by HideControlForZeroRows.
(Inherited from BasicDataGrid.)
Top
Methods
  NameDescription
Public methodClearCache
Clears the cached items.
Protected methodControl_PreRender
Control prerender code.
(Inherited from BasicDataGrid.)
Public methodDataBind
Binds data to the grid and displays the sorting symbols.
(Inherited from BasicDataGrid.)
Public methodGetDefaultCacheDependencies
Gets the default cache dependencies for the data source.
Public methodGetPagerMode
Returns the pager position based on the given string.
(Inherited from BasicDataGrid.)
Protected methodOnInit
Init event handler.
(Overrides BasicDataGridOnInit(EventArgs).)
Protected methodOnLoad
OnLoad.
(Overrides BasicDataGridOnLoad(EventArgs).)
Protected methodOnPageIndexChanged
OnPageIndexChanged event handler. It ensures displaying of the given page.
(Overrides BasicDataGridOnPageIndexChanged(DataGridPageChangedEventArgs).)
Protected methodOnPreRender
PreRender event handler.
(Overrides UIDataGridOnPreRender(EventArgs).)
Protected methodOnSortCommand
OnSortCommand event handler. It sorts data by selected column.
(Overrides BasicDataGridOnSortCommand(DataGridSortCommandEventArgs).)
Protected methodRaiseOnBeforeInit
Raises the OnBeforeInit event.
(Inherited from BasicDataGrid.)
Public methodReleaseContext
Releases the web part context.
Public methodReloadData
Reloads the control data.
Protected methodRender
Render event handler, to maintain the proper control rendering.
(Inherited from BasicDataGrid.)
Public methodSetContext
Sets the web part context.
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.
(Inherited from BasicDataGrid.)
Top
See Also