| UniGrid Methods |
The UniGrid type exposes the following members.
Methods| 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.) |
Extension Methods| 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.) |
See Also