UniGrid Class |
Namespace: CMS.UIControls
public abstract class UniGrid : CMSUserControl, IUniGrid, IObjectTypeDriven, IExtensibleUniGrid, ICallbackEventHandler, IUniPageable
The UniGrid type exposes the following members.
Name | Description | |
---|---|---|
AddAdditionalColumn |
Adds column to the UniGrid's columns with optional callback which specifies what will be displayed in a column cells.
| |
AddColumn |
Add new basic column into grid view.
| |
AddConfirmation |
Adds confirmation text to existing message on the page.
(Inherited from AbstractUserControl.) | |
AddError |
Adds error text to existing message on the page.
(Inherited from AbstractUserControl.) | |
AddHeaderAction |
Adds specified action to the page header actions.
(Inherited from AbstractUserControl.) | |
AddInformation |
Adds information text to existing message on the page.
(Inherited from AbstractUserControl.) | |
AddMessage |
Adds message text to existing message on the page.
(Inherited from AbstractUserControl.) | |
AddWarning |
Adds warning text to existing message on the page.
(Inherited from AbstractUserControl.) | |
ApplyFilter |
Applies current filter where condition.
| |
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.
| |
CreateChildControls |
Creates the child controls collection
(Overrides ControlCreateChildControls.) | |
DisplayExternalFilter |
Determines whether to show external filter.
| |
EnsureControls |
Interface for control that is able to explicitly ensure its child controls
(Inherited from AbstractUserControl.) | |
Eval(String) |
Evaluates the given value
(Inherited from AbstractUserControl.) | |
Eval(String, Boolean) |
Evaluates the item data (safe version), with html encoding.
(Inherited from AbstractUserControl.) | |
EvalBool |
Evaluates the item data and converts it to the bool.
(Inherited from AbstractUserControl.) | |
EvalDateTime |
Evaluates the item data and converts it to the date time.
(Inherited from AbstractUserControl.) | |
EvalDouble |
Evaluates the item data and converts it to the integer.
(Inherited from AbstractUserControl.) | |
EvalGuid |
Evaluates the item data and converts it to the guid.
(Inherited from AbstractUserControl.) | |
EvalHTML |
Evaluates the item data and doesn't encode it. Method should be used for columns with html content.
(Inherited from AbstractUserControl.) | |
EvalHtmlAttribute |
Evaluates the item data, encodes it to be used in HTML attribute.
(Inherited from AbstractUserControl.) | |
EvalInteger |
Evaluates the item data and converts it to the integer.
(Inherited from AbstractUserControl.) | |
EvalJSString |
Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'".
(Inherited from AbstractUserControl.) | |
EvalText(String) |
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.) | |
EvalText(String, Boolean) |
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.) | |
GetAccessDeniedPageUrl |
Returns access denied page with dependence on current setting.
(Inherited from CMSUserControl.) | |
GetActionImage |
Returns icon file for current theme or from default if current doesn't exist.
| |
GetCallbackResult |
Returns callback result.
| |
GetClearSelectionScript |
Gets JavaScript for clearing selection of the grid.
| |
GetDataTableFilter | Obsolete.
Returns where condition from UniGrid filters for DataTable.Select.
| |
GetFilter |
Returns where condition from UniGrid filters.
| |
GetFilter(Boolean) | Obsolete.
Returns where condition from UniGrid filters.
| |
GetFlagIconUrl |
Returns resolved path to the flag image for the specified culture.
(Inherited from AbstractUserControl.) | |
GetCheckSelectionScript |
Gets JavaScript for checking selection of the grid.
| |
GetCheckSelectionScript(Boolean) |
Gets JavaScript for checking selection of the grid.
| |
GetImagePath |
Gets UI image relative path.
(Inherited from AbstractUserControl.) | |
GetImageUrl |
Gets UI image relative path.
(Inherited from AbstractUserControl.) | |
GetJSModule |
Gets the JS module representing the UniGrid
| |
GetReloadScript |
Gets JavaScript for reload of the grid.
| |
GetSelectionFieldClientID |
Gets identifier of field containing selected items.
| |
GetString |
Returns localized string.
(Inherited from AbstractUserControl.) | |
GetValue(String) |
Returns the value of the given property.
(Inherited from InlineUserControl.) | |
GetValueReturnType(String, ReturnType) |
Returns the value of the given property.
(Inherited from InlineUserControl.) | |
HandleAction |
Handles the action event.
| |
HandleVisibility |
Handles the display of the grid based on whether the data is loaded or not
| |
HasValue |
Returns true if the value of the given property is set.
(Inherited from InlineUserControl.) | |
IsInternalPostBack |
Returns true if current request was fired by page change or filter show button.
| |
LoadActionsDefinition |
Loads actions definition.
| |
LoadColumnDefinition |
Load single column definition.
| |
LoadFilterControl |
Loads the filter control
| |
LoadGrid |
Loads the grid
| |
LoadGridDefinition |
Loads the grid definition.
| |
LoadOptionsDefinition |
Load options definition.
| |
LoadPagerDefinition |
Load UniGrid pager configuration.
| |
LoadUserControl |
Loads the user control based on the given path
(Inherited from AbstractUserControl.) | |
LoadXmlConfiguration |
Loads the XML configuration of the grid.
| |
LogAndShowError |
Logs the exception and
(Inherited from AbstractUserControl.) | |
OnContentLoaded |
Method that is called when the control content is loaded.
(Inherited from InlineUserControl.) | |
OnInit |
Init event handler.
(Inherited from AbstractUserControl.) | |
OnLoad |
Load event handler
(Overrides CMSUserControlOnLoad(EventArgs).) | |
OnPreRender |
PreRender event handler
(Overrides AbstractUserControlOnPreRender(EventArgs).) | |
ProcessSorting |
Sets the sort direction if current request is sorting.
| |
RaiseAction |
Raises the action event.
| |
RaiseAfterRetrieveData |
Raises after data are retrieved.
| |
RaiseBeforeFiltering |
Raises the before filtering event.
| |
RaiseBeforeSorting |
Raises the before page index changing event.
| |
RaiseCallbackEvent |
Sets callback event arguments.
| |
RaiseDataReload |
Raises the reload data event and returns DataSet.
| |
RaiseExternalDataBound |
Raises the external data bound event.
| |
RaiseLoadColumns |
Raises when columns are loaded dynamically and not from XML.
| |
RaiseOnAfterDataReload |
Raises the after data reload event.
| |
RaiseOnBeforeDataReload |
Raises the before data reload event.
| |
RaiseOnFilterFieldCreated |
Raised when filter field is created.
| |
RaiseOnPageBinding |
Raises the OnPageBinding event
| |
RaisePageSizeChanged |
Raises the after page size dropdown changed.
| |
RaiseShowButtonClick |
Raises the before page index changing event.
| |
ReBind |
Evokes control DataBind.
| |
RedirectToAccessDenied(String) |
Redirects the user to Access denied page.
(Inherited from CMSUserControl.) | |
RedirectToAccessDenied(Int32, String) |
Redirects the user to Access denied page.
(Inherited from CMSUserControl.) | |
RedirectToAccessDenied(String, String) |
Redirects the user to Access denied page.
(Inherited from CMSUserControl.) | |
RedirectToUIElementAccessDenied |
Redirects the user to Access denied page.
(Inherited from CMSUserControl.) | |
RegisterCmdScripts |
Register UniGrid commands scripts.
| |
ReleaseContext |
Releases the control context.
(Inherited from CMSUserControl.) | |
ReloadData |
Reloads the grid data.
| |
Render |
Render event handler.
(Inherited from AbstractUserControl.) | |
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.
| |
ResetFilter | Obsolete.
Resets the filter
| |
ResetSelection |
Uncheck all checkboxes in selection column.
| |
ResolveUrl |
Resolves the given URL
(Inherited from AbstractUserControl.) | |
RestoreState |
Restores the UniGrid's state, if applicable.
| |
RetrieveData |
Gets a DataSet with data based on UniGrid's settings.
| |
SetActionsHash |
Sets hidden field with actions hashes.
| |
SetBasicFormFilter |
Sets basic form filter.
| |
SetContext |
Sets the control context.
(Inherited from CMSUserControl.) | |
SetDropdownValue |
Sets the DropDown value to the given value or default value if available
| |
SetFilter(Boolean) |
Sets filter to the grid view and save it to the view state.
| |
SetFilter(Boolean, String) |
Sets filter to the grid view and save it to the view state.
| |
SetPager |
Sets pager control.
| |
SetTextboxValue |
Sets the TextBox value to the given value or default value if available
| |
SetUnigridControls |
Sets UniGrid controls.
| |
SetupGridRow |
Sets up an individual grid row
| |
SetValue |
Sets the property value of the control, setting the value affects only local property value.
(Inherited from InlineUserControl.) | |
ShowConfirmation |
Shows the general confirmation message.
(Inherited from AbstractUserControl.) | |
ShowError |
Shows the specified error message, optionally with a tooltip text.
(Inherited from AbstractUserControl.) | |
ShowChangesSaved |
Shows the general changes saved message.
(Inherited from AbstractUserControl.) | |
ShowInformation |
Shows the given information on the page, optionally with a tooltip text.
(Inherited from AbstractUserControl.) | |
ShowMessage(MessageTypeEnum, String, String, String, Boolean) |
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.) | |
ShowMessage(MessageTypeEnum, String, String, String, Boolean, Boolean) |
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.) | |
ShowWarning |
Shows the specified warning message, optionally with a tooltip text.
(Inherited from AbstractUserControl.) | |
SortUniGridDataSource |
Sorts UniGrid data source according to sort directive saved in ViewState.
| |
StoreState |
Stores the UniGrid's state, if applicable.
| |
TrackViewState |
Tracks the view state.
(Inherited from InlineUserControl.) |
Name | Description | |
---|---|---|
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.) | |
GetString |
Gets the string by the specified resource key
(Defined by CoreExtensions.) | |
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 | |
---|---|---|
ALL |
Constant representing all data source
| |
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].
| |
dataSourceIsUsed |
Indicates whether external data source is used.
| |
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.
| |
isEmpty |
Indicates if the data source is empty.
| |
mAccessDeniedPage |
Access denied page
(Inherited from CMSUserControl.) | |
mCMSDeskAccessDeniedPage |
CMSDesk access denied page
(Inherited from CMSUserControl.) | |
mControlContext |
Control context
(Inherited from CMSUserControl.) | |
mControlGUID |
Control GUID
(Inherited from CMSUserControl.) | |
mDisplayMode |
Display mode
(Inherited from CMSUserControl.) | |
mRelativePath |
Relative path
(Inherited from CMSUserControl.) | |
mRowsCount |
Rows count of UniGrid data source.
| |
mUseCMSDeskAccessDeniedPage |
Indicates whether CMSDesk access denied page should be used
(Inherited from CMSUserControl.) | |
mViewStateTracked |
If true, the ViewState has been already tracked.
(Inherited from InlineUserControl.) | |
onActionUsed |
Indicates whether UniGrid action was raised. Used for data reloading.
| |
pagerForceNumberOfResults |
Total number of available records returned from data reload.
| |
properties |
Control properties.
(Inherited from InlineUserControl.) | |
queryStringHashTable |
Dictionary of where conditions by filters for filtering by query parameters.
Filter name = Where condition.
| |
SELECTALL_EXTERNAL_DATABOUND |
Select all external source name. Used for header external DataBound of SelectAll check box.
| |
SELECTION_EXTERNAL_DATABOUND |
Selection external source name. Used for external DataBound of selection column.
| |
showSelection |
Indicates whether a column allowing the selection of rows should be displayed on the left of the UniGrid.
Loaded from UniGrid options.
| |
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.
|
Name | Description | |
---|---|---|
ActionsHashHidden |
Hidden field with hashed action ids.
| |
ActionsHidden |
Hidden field with action ids.
| |
ActionsID |
Array list of actions on current page of UniGrid.
| |
AdvancedExportControl |
Returns the advanced export control of the current grid
| |
AllColumns |
Allows to explicitly specify all columns that can be retrieved from UniGrid
Comma-separated value e.g. "ItemID, ItemName"
| |
ApplyPageSize |
Determines whether to apply CurrentPageSize when retrieving data.
| |
CmdArgHiddenField |
Hidden field for the command argument
| |
CmdNameHiddenField |
Hidden field for the command name
| |
Columns |
Columns to get from the database.
| |
CompleteWhereCondition |
Returns the complete where condition.
| |
ComponentName |
Component name
(Inherited from AbstractUserControl.) | |
ControlContext |
Control context.
(Inherited from CMSUserControl.) | |
ControlGUID |
Unique ID of the control within the given request.
(Inherited from CMSUserControl.) | |
CurrentDocument |
Current document
(Inherited from AbstractUserControl.) | |
CurrentOffset |
Gets current offset.
| |
CurrentOrder |
Gets current order by.
| |
CurrentPageInfo |
Current page info
(Inherited from AbstractUserControl.) | |
CurrentPageSize |
Gets current page size from pager.
| |
CurrentResolver |
Control's resolver
(Inherited from CMSUserControl.) | |
CurrentSite |
Current site
(Inherited from AbstractUserControl.) | |
CurrentTopN |
Number of records to display (load). It's being set before ReloadData event
is fired in order to optimize the data loading.
| |
CurrentUser |
Current user
(Inherited from AbstractUserControl.) | |
CustomFilter |
Custom filter control
| |
DataSource |
External grid DataSource, when set, overrides the default data source settings.
| |
DataSourceIsSorted |
Indicates if data source is sorted outside of UniGrid.
| |
DefaultImageDirectoryPath |
Gets default image directory path for images.
| |
DelayedReload |
Indicates if delayed reload should be used.
If True reload data must be called externally.
| |
DeselectedItems |
Gets deselected items from UniGrid.
| |
DialogHeight |
Height of
| |
DialogWidth |
Width of edited dialog
| |
DisplayMode |
Gets or sets display mode of the control.
(Inherited from CMSUserControl.) | |
DocumentManager |
Document manager control
(Inherited from AbstractUserControl.) | |
EditActionUrl |
URL for the edit action handling.
| |
EditedObject |
Control's edited object
(Inherited from AbstractUserControl.) | |
EditInDialog |
If true, the editing action is done through a dialog
| |
ExportFileName |
Name used for exporting files (without extension).
| |
FilterByQueryString |
True if the filtering should be set from the query string parameters.
| |
FilterDirectoryPath |
Gets or sets directory path for custom filter controls.
| |
FilteredZeroRowsText |
Text displayed when UniGrid data source is empty after filtering.
| |
FilterForm |
Gets filter form.
| |
FilterFormData |
Data container for filter form.
| |
FilterFormName |
This name is used for alternative form.
| |
FilterFormPlaceHolder |
Returns the filter form placeholder
| |
FilterIsSet |
Indicates if filter is set. It's being used when filter by query string is used.
| |
FilterLimit |
Minimal count of entries for display filter. 0 means that filter is displayed always and -1 means that filter is never displayed.
| |
FilterMode |
Filter mode passed to custom filters.
| |
FilterPlaceHolder |
Gets filter placeHolder from UniGrid.
| |
GridActions |
Actions definition.
| |
GridColumns |
Columns definition.
| |
GridName |
Xml file with source information.
| |
GridOptions |
Options.
| |
GridView |
Grid view used by UniGrid.
| |
GroupObject |
Indicates if the object type is community group related.
| |
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.
| |
HeaderActions |
Header actions control
(Inherited from AbstractUserControl.) | |
HeaderPanel |
Returns the grid header panel
| |
HideControlForZeroRows |
Indicates whether hide UniGrid or not when its data source is empty.
| |
HideFilterButton |
Indicates whether hide filter "Show" button or not.
| |
CheckRelative |
If true, relative ancestor div is checked in context menu
| |
ImageDirectoryPath |
Gets or sets directory path for images.
| |
InfoLabel |
Grid information label
| |
InfoObject |
Gets instance of info object based on ObjectType property.
| |
IsCMSDesk |
Determines whether the current control lies on the page that is currently located under the CMS Desk.
(Inherited from CMSUserControl.) | |
IsEmpty |
Indicates if the data source is empty.
| |
IsLiveSite |
Indicates if control is used on live site
(Overrides AbstractUserControlIsLiveSite.) | |
Item |
Gets or sets the value of the column.
(Inherited from InlineUserControl.) | |
JavaScriptModule |
Path to JavaScript module that will be loaded for this grid.
| |
JavaScriptModuleData |
Data that will be sent to the grid's JavaScript module.
| |
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.
| |
MenuPlaceHolder |
Gets the menu placeholder
| |
MessagesPlaceHolder |
Placeholder for messages
(Inherited from AbstractUserControl.) | |
NamedColumns |
Gets named columns from grid view.
| |
NewlySelectedItems |
Gets newly selected items from UniGrid.
| |
ObjectType |
Object type which is loaded to the grid
| |
OrderBy |
Order columns.
| |
OrderByRegex |
Description.
| |
OriginallySelected |
Gets array list of originally selected items.
| |
Pager |
UniGrid pager used by UniGrid.
| |
PagerConfig |
Pager configuration.
| |
PagerDataItem |
Pager data item.
| |
PagerFirstPageText |
Text displayed in pagers first page link.
| |
PagerForceNumberOfResults |
Volume of returned records.
| |
PagerLastPageText |
Text displayed in pagers last page link.
| |
PagerNextGroupText |
Text displayed in pagers next group link.
| |
PagerNextPageText |
Text displayed in pagers next page link.
| |
PagerPreviousGroupText |
Text displayed in pagers previous group link.
| |
PagerPreviousPageText |
Text displayed in pagers previous page link.
| |
PageSize |
UniGrid page size values separated with comma.
Default: 5,10,25,50,100
| |
PageSizeDropdown |
Gets page size dropdown from UniGrid.
| |
Parameter |
Inline control parameter - mirrors the GridName property.
(Overrides InlineUserControlParameter.) | |
Query |
Query used in grid view.
| |
QueryParameters |
Query parameters for the query.
| |
RelativePath |
Page relative path.
(Inherited from CMSUserControl.) | |
RememberDefaultState |
Indicates whether UniGrid remembers its default state.
| |
RememberState |
Gets or sets the value indicating whether UniGrid remembers its state, i.e., filter, page number, page size and sorting order.
| |
RememberStateByParam |
Gets or sets a comma-separated list of names of query parameters whose value constitute a part of UniGrid's identity.
| |
RowsCount |
Gets rows count from DataSet.
Sets after ReloadData().
| |
SelectedItems |
Gets or sets selected items of UniGrid.
Returns empty collection if hash validation fails.
| |
SelectionHashHiddenField |
Hidden field containing selected items hash.
| |
SelectionHiddenField |
Hidden field containing selected items.
| |
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.
| |
SelectionsID |
Array list of selection ids of UniGrid.
| |
ShortID |
Short ID of the control.
(Inherited from AbstractUserControl.) | |
ShowActionsLabel |
If true, the actions label is displayed
| |
ShowActionsMenu |
Defines whether to show actions menu (menu in the header row of actions column).
| |
ShowFilter |
If count of rows is greater or equal to filter limit, show filter.
| |
ShowObjectMenu |
Defines whether to show object menu (menu containing relationships, export/backup, destroy object, ... functionality)
| |
SortColumns |
Gets sort columns from grid view.
| |
SortDirect |
Sort directive used in grid view.
| |
StateRestored |
Gets or sets the value indicating whether UniGrid has restored its state.
| |
StopProcessing |
Indicates if the control should perform the operations.
(Inherited from AbstractUserControl.) | |
TextColumns |
Array list of text columns used in sorting when query is used.
| |
TopN |
Number of records to display (load).
| |
TypeName |
Returns the object type name.
(Inherited from CMSUserControl.) | |
UIContext |
Control's UI Context
(Inherited from AbstractUserControl.) | |
UniPagerControl |
Pager control.
| |
UseCMSDeskAccessDeniedPage |
Gets or sets the value that indicates whether CMSDesk access denied page should be used.
(Inherited from CMSUserControl.) | |
UsesLocalMessagesPlaceHolder |
Indicates if control uses local messages placeholder
(Inherited from AbstractUserControl.) | |
ViewState |
ViewState - overridden for the Master page ViewState fix.
(Inherited from InlineUserControl.) | |
WhereClause |
Where clause used in grid view.
| |
WhereCondition |
Where condition that can be set from other classes.
| |
ZeroRowsText |
Text displayed when UniGrid data source is empty.
|
Name | Description | |
---|---|---|
OnAction |
Event raised on action post back.
| |
OnAfterDataReload |
Event raised after data are reloaded from external data source.
| |
OnAfterRetrieveData |
Raised when after data are retrieved.
| |
OnBeforeDataReload |
Event raised before data are reloaded from external data source.
| |
OnBeforeFiltering |
Raised before filtering from UniGrid filter is called.
| |
OnBeforeSorting |
Raised before sorting is called.
| |
OnDataReload |
Event raised when data are reloaded from external data source.
| |
OnExternalDataBound |
Event raised when external source data required.
| |
OnFilterFieldCreated |
Raised when filter field is created.
| |
OnLoadColumns |
Raised when columns are loaded dynamically and not from XML.
| |
OnPageBinding |
Occurs when the control bind data.
| |
OnPageChanged |
Occurs when the pager change the page and current mode is postback => reload data
| |
OnPageSizeChanged |
Raised on page size changed.
| |
OnShowButtonClick |
OnShowButtonClick event handler.
|