UniGrid Class

UniGrid base class.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.TemplateControl
      System.Web.UI.UserControl
        CMS.Base.Web.UI.AbstractUserControl
          CMS.Base.Web.UI.InlineUserControl
            CMS.UIControls.CMSUserControl
              CMS.UIControls.UniGrid

Namespace: CMS.UIControls
Assembly: CMS.UIControls (in CMS.UIControls.dll) Version: 12.0.0

Syntax

public abstract class UniGrid : CMSUserControl, 
	IUniGrid, IObjectTypeDriven, IExtensibleUniGrid, ICallbackEventHandler, IPostBackEventHandler, 
	IUniPageable

The UniGrid type exposes the following members.

Constructors

	Name	Description
Protected method	UniGrid

Fields

	Name	Description
Public field Static member	ALL	Constant representing all data source
Public field Static member	CUSTOM_FILTER_SOURCE_NAME	Name of the custom filter control set via GridOptions.FilterPath. Custom filter can be accessed by FilterFields[CUSTOM_FILTER_SOURCE_NAME].
Protected field	dataSourceIsUsed	Indicates whether external data source is used.
Protected field	displayFilter	Indicates whether a filter should be displayed above the UniGrid. If the amount of displayed rows is lower than the value of the FilterLimit key, the filter will be hidden despite this setting. Loaded from UniGrid options.
Protected field	filterQueryParameters	Dictionary of where conditions by filters for filtering by query parameters. Filter name = Where condition.
Protected field	onActionUsed	Indicates whether UniGrid action was raised. Used for data reloading.
Protected field	pagerForceNumberOfResults	Total number of available records returned from data reload.
Public field Static member	SELECTALL_EXTERNAL_DATABOUND	Select all external source name. Used for header external DataBound of SelectAll check box.
Public field Static member	SELECTION_EXTERNAL_DATABOUND	Selection external source name. Used for external DataBound of selection column.
Protected field	showSelection	Indicates whether a column allowing the selection of rows should be displayed on the left of the UniGrid. Loaded from UniGrid options.
Protected field	showSortDirection	Determines if an arrow showing the sorting direction should be displayed next to the header of the column used for sorting. Loaded from UniGrid options.

Properties

	Name	Description
Protected property	ActionsHashHidden	Hidden field with hashed action ids.
Protected property	ActionsHidden	Hidden field with action ids.
Public property	ActionsID	Array list of actions on current page of UniGrid.
Protected property	AdvancedExportControl	Returns the advanced export control of the current grid
Public property	AllColumns	Allows to explicitly specify all columns that can be retrieved from UniGrid Comma-separated value e.g. "ItemID, ItemName"
Public property	ApplyPageSize	Determines whether to apply CurrentPageSize when retrieving data.
Public property	CheckRelative	If true, relative ancestor div is checked in context menu
Protected property	CmdArgHiddenField	Hidden field for the command argument
Protected property	CmdNameHiddenField	Hidden field for the command name
Public property	Columns	Columns to get from the database.
Public property	CompleteWhereCondition	Returns the complete where condition.
Public property	ComponentName	Component name (Inherited from AbstractUserControl.)
Public property	ControlContext	Control context. (Inherited from CMSUserControl.)
Public property	ControlGUID	Unique ID of the control within the given request.
Public property	CurrentDocument	Current document (Inherited from AbstractUserControl.)
Public property	CurrentOffset	Gets current offset.
Protected property	CurrentOrder	Gets current order by.
Public property	CurrentPageInfo	Current page info (Inherited from AbstractUserControl.)
Protected property	CurrentPageSize	Gets current page size from pager.
Public property	CurrentResolver	Control's resolver (Inherited from CMSUserControl.)
Public property	CurrentSite	Current site (Inherited from AbstractUserControl.)
Public property	CurrentTopN	Number of records to display (load). It's being set before ReloadData event is fired in order to optimize the data loading.
Public property	CurrentUser	Current user (Inherited from AbstractUserControl.)
Public property	CustomFilter	Custom filter control
Public property	DataSource	External grid DataSource, when set, overrides the default data source settings.
Public property	DataSourceIsSorted	Indicates if data source is sorted outside of UniGrid.
Public property	DefaultImageDirectoryPath	Gets default image directory path for images.
Public property	DelayedReload	Indicates if delayed reload should be used. If True reload data must be called externally.
Public property	DeselectedItems	Gets deselected items from UniGrid.
Public property	DialogHeight	Height of
Public property	DialogWidth	Width of edited dialog
Public property	DisplayMode	Gets or sets display mode of the control. (Inherited from CMSUserControl.)
Public property	DocumentManager	Document manager control (Inherited from AbstractUserControl.)
Public property	EditActionUrl	URL for the edit action handling.
Public property	EditedObject	Control's edited object (Inherited from CMSUserControl.)
Public property	EditInDialog	If true, the editing action is done through a dialog
Public property	ExportFileName	Name used for exporting files (without extension).
Public property	FilterByQueryString	True if the filtering should be set from the query string parameters.
Public property	FilterDirectoryPath	Gets or sets directory path for custom filter controls.
Public property	FilteredZeroRowsText	Text displayed when UniGrid data source is empty after filtering.
Public property	FilterForm	Gets filter form.
Public property	FilterFormData	Data container for filter form.
Public property	FilterFormName	This name is used for alternative form.
Protected property	FilterFormPlaceHolder	Returns the filter form placeholder
Public property	FilterIsSet	Indicates if filter is set. It's being used when filter by query string is used.
Public property	FilterLimit	Minimal count of entries for display filter. 0 means that filter is displayed always and -1 means that filter is never displayed.
Public property	FilterMode	Filter mode passed to custom filters.
Public property	FilterPlaceHolder	Gets filter placeHolder from UniGrid.
Public property	GridActions	Actions definition.
Public property	GridColumns	Columns definition.
Public property	GridMassActions	Mass actions definition.
Public property	GridName	Xml file with source information.
Public property	GridOptions	Options.
Public property	GridView	Grid view used by UniGrid.
Public property	GroupObject	Indicates if the object type is community group related.
Protected property	HasDefaultState	Gets the value indicating whether UniGrid is in a default state, i.e., without filtering condition, on the first page and with the default page size and sorting order.
Public property	HeaderActions	Header actions control (Inherited from AbstractUserControl.)
Protected property	HeaderPanel	Returns the grid header panel
Public property	HideControlForZeroRows	Indicates whether hide UniGrid or not when its data source is empty.
Public property	HideFilterButton	Indicates whether hide filter "Show" button or not.
Public property	ImageDirectoryPath	Gets or sets directory path for images.
Protected property	InfoLabel	Grid information label
Public property	InfoObject	Gets instance of info object based on ObjectType property.
Public property	IsCMSDesk	Determines whether the current control lies on the page that is currently located under the CMS Desk. (Inherited from CMSUserControl.)
Public property	IsEmpty	Indicates if the data source is empty.
Public property	IsLiveSite	Indicates if control is used on live site (Overrides AbstractUserControl.IsLiveSite.)
Public property	Item	Gets or sets the value of the column. (Inherited from InlineUserControl.)
Public property	JavaScriptModule	Path to JavaScript module that will be loaded for this grid.
Public property	JavaScriptModuleData	Data that will be sent to the grid's JavaScript module.
Public property	Macro	If defined, uses this macro to retrieve the grid data source. The macro must return IDataQuery object. Macro source has higher priority than object type.
Public property	MassActions	Control containing mass actions.
Protected property	MenuPlaceHolder	Gets the menu placeholder
Public property	MessagesPlaceHolder	Placeholder for messages (Inherited from AbstractUserControl.)
Public property	NamedColumns	Gets named columns from grid view.
Public property	NewlySelectedItems	Gets newly selected items from UniGrid.
Public property	ObjectType	Object type which is loaded to the grid
Public property	OrderBy	Order columns.
Protected property	OrderByRegex	Description.
Protected property	OriginallySelected	Gets array list of originally selected items.
Public property	Pager	UniGrid pager used by UniGrid.
Public property	PagerConfig	Pager configuration.
Public property	PagerDataItem	Pager data item.
Public property	PagerFirstPageText	Text displayed in pagers first page link.
Public property	PagerForceNumberOfResults	Volume of returned records.
Public property	PagerLastPageText	Text displayed in pagers last page link.
Public property	PagerNextGroupText	Text displayed in pagers next group link.
Public property	PagerNextPageText	Text displayed in pagers next page link.
Public property	PagerPreviousGroupText	Text displayed in pagers previous group link.
Public property	PagerPreviousPageText	Text displayed in pagers previous page link.
Public property	PageSize	UniGrid page size values separated with comma. Default: 5,10,25,50,100
Public property	PageSizeDropdown	Gets page size dropdown from UniGrid.
Public property	Parameter	Inline control parameter - mirrors the GridName property. (Overrides InlineUserControl.Parameter.)
Protected property	Properties	Control properties. (Inherited from InlineUserControl.)
Public property	Query	Query used in grid view.
Public property	QueryParameters	Query parameters for the query.
Public property	RememberDefaultState	Indicates whether UniGrid remembers its default state.
Public property	RememberState	Gets or sets the value indicating whether UniGrid remembers its state, i.e., filter, page number, page size and sorting order.
Public property	RememberStateByParam	Gets or sets a comma-separated list of names of query parameters whose value constitute a part of UniGrid's identity.
Public property Code example	ResourcePrefix	Prefix for the resource strings which are used for the localization by the control and its child controls. (Inherited from AbstractUserControl.)
Public property	ResourcePrefixes	List of cached resource prefixes for the parent hierarchy (Inherited from AbstractUserControl.)
Public property	RowsCount	Gets rows count from DataSet. Sets after ReloadData().
Public property	SelectedItems	Gets or sets selected items of UniGrid. Returns empty collection if hash validation fails.
Protected property	SelectionHashHiddenField	Hidden field containing selected items hash.
Public property	SelectionHiddenField	Hidden field containing selected items.
Public property	SelectionJavascript	Name of javascript function called after selection checkbox is clicked. First argument will be value of selection column or first column in data source. Second argument will be true/false according to checkbox.
Public property	SelectionsID	Array list of selection ids of UniGrid.
Public property	ShortID	Short ID of the control. (Inherited from AbstractUserControl.)
Public property	ShowActionsLabel	If true, the actions label is displayed
Public property	ShowActionsMenu	Defines whether to show actions menu (menu in the header row of actions column).
Public property	ShowExportMenu	Defines whether to show export menu (menu in the header row of actions column).
Public property	ShowFilter	If count of rows is greater or equal to filter limit, show filter.
Public property	ShowObjectMenu	Defines whether to show object menu (menu containing relationships, export/backup, destroy object, ... functionality)
Protected property	SortColumns	Gets sort columns from grid view.
Public property	SortDirect	Sort directive used in grid view.
Protected property	StateRestored	Gets or sets the value indicating whether UniGrid has restored its state.
Public property	StopProcessing	Indicates if the control should perform the operations. (Inherited from AbstractUserControl.)
Public property	TextColumns	Array list of text columns used in sorting when query is used.
Public property	TopN	Number of records to display (load).
Public property	UIContext	Control's UI Context (Inherited from CMSUserControl.)
Public property	UniPagerControl	Pager control.
Public property	UseCMSDeskAccessDeniedPage	Gets or sets the value that indicates whether CMSDesk access denied page should be used. (Inherited from CMSUserControl.)
Public property	UsesLocalMessagesPlaceHolder	Indicates if control uses local messages placeholder (Inherited from AbstractUserControl.)
Protected property	ViewState	ViewState - overridden for the Master page ViewState fix. (Inherited from InlineUserControl.)
Public property	WhereClause	Where clause used in grid view.
Public property	WhereCondition	Where condition that can be set from other classes.
Public property	ZeroRowsText	Text displayed when UniGrid data source is empty.

Methods

	Name	Description
Public method	AddAdditionalColumn	Adds column to the UniGrid's columns with optional callback which specifies what will be displayed in a column cells.
Public method	AddColumn	Add new basic column into grid view.
Public method	AddConfirmation	Adds confirmation text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddError	Adds error text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddHeaderAction	Adds specified action to the page header actions. (Inherited from AbstractUserControl.)
Public method	AddInformation	Adds information text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddMessage	Adds message text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddWarning	Adds warning text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	ApplyFilter	Applies current filter where condition.
Public method	ClearActions	Clears UniGrid's information on recently performed action. Under normal circumstances there is no need to perform this action. However sometimes forcing grid to clear the actions is required.
Public method	DisplayExternalFilter	Determines whether to show external filter.
Public method	EnsureControls	Interface for control that is able to explicitly ensure its child controls (Inherited from AbstractUserControl.)
Public method	Eval(String)	Evaluates the given value (Inherited from AbstractUserControl.)
Public method	Eval(String, Boolean)	Evaluates the item data (safe version), with html encoding. (Inherited from AbstractUserControl.)
Public method	EvalBool	Evaluates the item data and converts it to the bool. (Inherited from AbstractUserControl.)
Public method	EvalDateTime	Evaluates the item data and converts it to the date time. (Inherited from AbstractUserControl.)
Public method	EvalDecimal	Evaluates the item data and converts it to the decimal. (Inherited from AbstractUserControl.)
Public method	EvalDouble	Evaluates the item data and converts it to the double. (Inherited from AbstractUserControl.)
Public method	EvalGuid	Evaluates the item data and converts it to the guid. (Inherited from AbstractUserControl.)
Public method	EvalHTML	Evaluates the item data and doesn't encode it. Method should be used for columns with html content. (Inherited from AbstractUserControl.)
Public method	EvalHtmlAttribute	Evaluates the item data, encodes it to be used in HTML attribute. (Inherited from AbstractUserControl.)
Public method	EvalInteger	Evaluates the item data and converts it to the integer. (Inherited from AbstractUserControl.)
Public method	EvalJSString	Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'". (Inherited from AbstractUserControl.)
Public method	EvalText(String)	Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content. (Inherited from AbstractUserControl.)
Public method	EvalText(String, Boolean)	Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content. (Inherited from AbstractUserControl.)
Protected method	GetAccessDeniedPageUrl	Returns access denied page with dependence on current setting. (Inherited from CMSUserControl.)
Protected method	GetActionImage	Returns icon file for current theme or from default if current doesn't exist.
Public method	GetCallbackResult	Returns callback result.
Public method	GetCheckDependenciesDescription	Gets description for error message when dependencies check fails.
Public method	GetCheckSelectionScript	Gets JavaScript for checking selection of the grid.
Public method	GetClearSelectionScript	Gets JavaScript for clearing selection of the grid.
Protected method	GetConfigurationXml	Returns XML document from given path.
Public method	GetFilter	Returns where condition from UniGrid filters.
Public method	GetFlagIconUrl	Returns resolved path to the flag image for the specified culture. (Inherited from AbstractUserControl.)
Public method	GetImagePath	Gets UI image relative path. (Inherited from AbstractUserControl.)
Public method	GetImageUrl	Gets UI image relative path. (Inherited from AbstractUserControl.)
Public method	GetJSModule	Gets the JS module representing the UniGrid
Public method	GetReloadScript	Gets JavaScript for reload of the grid.
Public method	GetSelectionFieldClientID	Gets identifier of field containing selected items.
Public method	GetString	Returns the localized string of the control's hierarchically highest parent that has the ResourcePrefix property and its translation defined. (Inherited from AbstractUserControl.)
Public method	GetValue(String)	Returns the value of the given property. (Inherited from InlineUserControl.)
Public method	GetValue<ReturnType>(String, ReturnType)	Returns the value of the given property. (Inherited from InlineUserControl.)
Public method	HandleAction	Handles the action event.
Protected method	HandleVisibility	Handles the display of the grid based on whether the data is loaded or not
Public method	HasValue	Returns true if the value of the given property is set. (Inherited from InlineUserControl.)
Protected method	IsInternalPostBack	Returns true if current request was fired by page change or filter show button.
Protected method	LoadActionsDefinition	Loads actions definition.
Protected method	LoadColumnDefinition	Load single column definition.
Protected method	LoadFilterControl	Loads the filter control
Protected method	LoadGrid	Loads the grid
Public method	LoadGridDefinition	Loads the grid definition.
Protected method	LoadMassActionsDefinition	Loads mass actions definition.
Protected method	LoadOptionsDefinition	Load options definition.
Protected method	LoadPagerDefinition	Load UniGrid pager configuration.
Public method	LoadUserControl	Loads the user control based on the given path (Inherited from AbstractUserControl.)
Public method	LoadXmlConfiguration	Loads the XML configuration of the grid.
Public method	LogAndShowError	Logs the exception and (Inherited from AbstractUserControl.)
Protected method	MapPathInternal	Returns the physical file path that corresponds to the specified virtual path.
Public method	OnContentLoaded	Method that is called when the control content is loaded. (Inherited from InlineUserControl.)
Protected method	OnInit	Init event handler. (Overrides AbstractUserControl.OnInit(EventArgs).)
Protected method	OnLoad	Load event handler. (Overrides AbstractUserControl.OnLoad(EventArgs).)
Protected method	OnPreRender	PreRender event handler. (Overrides AbstractUserControl.OnPreRender(EventArgs).)
Protected method	ProcessSorting	Sets the sort direction if current request is sorting.
Public method	RaiseAction	Raises the action event.
Public method	RaiseAfterRetrieveData	Raises after data are retrieved.
Public method	RaiseBeforeFiltering	Raises the before filtering event.
Public method	RaiseBeforeSorting	Raises the before page index changing event.
Public method	RaiseCallbackEvent	Sets callback event arguments.
Public method	RaiseDataReload	Raises the reload data event and returns DataSet.
Public method	RaiseExternalDataBound	Raises the external data bound event.
Public method	RaiseLoadColumns	Raises when columns are loaded dynamically and not from XML.
Public method	RaiseOnAfterDataReload	Raises the after data reload event.
Public method	RaiseOnBeforeDataReload	Raises the before data reload event.
Public method	RaiseOnFilterFieldCreated	Raised when filter field is created.
Protected method	RaiseOnPageBinding	Raises the OnPageBinding event
Public method	RaisePageSizeChanged	Raises the after page size dropdown changed.
Public method	RaisePostBackEvent	Raises the postback event
Public method	RaiseShowButtonClick	Raises the before page index changing event.
Public method	ReBind	Evokes control DataBind.
Public method	RedirectToAccessDenied(String)	Redirects the user to Access denied page. (Inherited from CMSUserControl.)
Protected method	RedirectToAccessDenied(Int32, String)	Redirects the user to Access denied page. (Inherited from CMSUserControl.)
Protected method	RedirectToAccessDenied(String, String)	Redirects the user to Access denied page. (Inherited from CMSUserControl.)
Protected method	RedirectToUIElementAccessDenied	Redirects the user to Access denied page. (Inherited from CMSUserControl.)
Protected method	RegisterCmdScripts	Register UniGrid commands scripts.
Public method	ReleaseContext	Releases the control context. (Inherited from CMSUserControl.)
Public method	ReloadData	Reloads the grid data.
Protected method	Render	Render event handler. (Inherited from AbstractUserControl.)
Public method	Reset	Resets the UniGrid state, i.e., restores the filter to the initial state, navigates to the first page and sets the default page size and sorting order, and finally reloads data.
Public method	ResetSelection	Uncheck all checkboxes in selection column.
Public method Static member	ResetStates	Resets the state of all Unigrids displaying objects of given type.
Public method	ResolveUrl	Resolves the given URL (Inherited from AbstractUserControl.)
Protected method	RestoreState	Restores the UniGrid's state, if applicable.
Public method	RetrieveData	Gets a DataSet with data based on UniGrid's settings.
Protected method	SetActionsHash	Sets hidden field with actions hashes.
Protected method	SetBasicFormFilter	Sets basic form filter.
Public method	SetContext	Sets the control context. (Inherited from CMSUserControl.)
Protected method	SetFilter	Sets filter to the grid view and save it to the view state.
Protected method	SetPager	Sets pager control.
Protected method	SetUnigridControls	Sets UniGrid controls.
Protected method	SetupGridRow	Sets up an individual grid row
Public method	SetValue	Sets the property value of the control, setting the value affects only local property value. (Inherited from InlineUserControl.)
Public method	ShowChangesSaved	Shows the general changes saved message. (Inherited from AbstractUserControl.)
Public method	ShowConfirmation	Shows the general confirmation message. (Inherited from AbstractUserControl.)
Public method	ShowError	Shows the specified error message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	ShowInformation	Shows the given information on the page, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	ShowMessage(MessageTypeEnum, String, String, String, Boolean)	Shows the specified message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Protected method	ShowMessage(MessageTypeEnum, String, String, String, Boolean, Boolean)	Shows the specified message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	ShowWarning	Shows the specified warning message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Protected method	SortUniGridDataSource	Sorts UniGrid data source according to sort directive saved in ViewState.
Protected method	StoreState	Stores the UniGrid's state, if applicable.
Protected method	TrackViewState	Tracks the view state. (Inherited from InlineUserControl.)

Extension Methods

	Name	Description
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	GetString	Gets the string by the specified resource key (Defined by ControlsExtensions.)

Events

	Name	Description
Public event	OnAction	Event raised on action post back.
Public event	OnAfterDataReload	Event raised after data are reloaded from external data source.
Public event	OnAfterRetrieveData	Raised when after data are retrieved.
Public event	OnBeforeDataReload	Event raised before data are reloaded from external data source.
Public event	OnBeforeFiltering	Raised before filtering from UniGrid filter is called.
Public event	OnBeforeSorting	Raised before sorting is called.
Public event	OnDataReload	Event raised when data are reloaded from external data source.
Public event	OnExternalDataBound	Event raised when external source data required.
Public event	OnFilterFieldCreated	Raised when filter field is created.
Public event	OnLoadColumns	Raised when columns are loaded dynamically and not from XML.
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
Public event	OnPageSizeChanged	Raised on page size changed.
Public event	OnShowButtonClick	OnShowButtonClick event handler.