Click or drag to resize
UniGrid Methods

The UniGrid type exposes the following members.

Methods
  NameDescription
Public methodAddAdditionalColumn
Adds column to the UniGrid's columns with optional callback which specifies what will be displayed in a column cells.
Public methodAddColumn
Add new basic column into grid view.
Public methodAddConfirmation
Adds confirmation text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddError
Adds error text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddHeaderAction
Adds specified action to the page header actions.
(Inherited from AbstractUserControl.)
Public methodAddInformation
Adds information text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddMessage
Adds message text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddWarning
Adds warning text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodApplyFilter
Applies current filter where condition.
Public methodClearActions
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.
Protected methodCreateChildControls
Creates the child controls collection
(Overrides ControlCreateChildControls.)
Public methodDisplayExternalFilter
Determines whether to show external filter.
Public methodEnsureControls
Interface for control that is able to explicitly ensure its child controls
(Inherited from AbstractUserControl.)
Public methodEval(String)
Evaluates the given value
(Inherited from AbstractUserControl.)
Public methodEval(String, Boolean)
Evaluates the item data (safe version), with html encoding.
(Inherited from AbstractUserControl.)
Public methodEvalBool
Evaluates the item data and converts it to the bool.
(Inherited from AbstractUserControl.)
Public methodEvalDateTime
Evaluates the item data and converts it to the date time.
(Inherited from AbstractUserControl.)
Public methodEvalDouble
Evaluates the item data and converts it to the integer.
(Inherited from AbstractUserControl.)
Public methodEvalGuid
Evaluates the item data and converts it to the guid.
(Inherited from AbstractUserControl.)
Public methodEvalHTML
Evaluates the item data and doesn't encode it. Method should be used for columns with html content.
(Inherited from AbstractUserControl.)
Public methodEvalHtmlAttribute
Evaluates the item data, encodes it to be used in HTML attribute.
(Inherited from AbstractUserControl.)
Public methodEvalInteger
Evaluates the item data and converts it to the integer.
(Inherited from AbstractUserControl.)
Public methodEvalJSString
Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'".
(Inherited from AbstractUserControl.)
Public methodEvalText(String)
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.)
Public methodEvalText(String, Boolean)
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.)
Protected methodGetAccessDeniedPageUrl
Returns access denied page with dependence on current setting.
(Inherited from CMSUserControl.)
Protected methodGetActionImage
Returns icon file for current theme or from default if current doesn't exist.
Public methodGetCallbackResult
Returns callback result.
Public methodGetClearSelectionScript
Gets JavaScript for clearing selection of the grid.
Public methodGetFilter
Returns where condition from UniGrid filters.
Public methodGetFlagIconUrl
Returns resolved path to the flag image for the specified culture.
(Inherited from AbstractUserControl.)
Public methodGetCheckDependenciesDescription
Gets description for error message when dependencies check fails.
Public methodGetCheckSelectionScript
Gets JavaScript for checking selection of the grid.
Public methodGetCheckSelectionScript(Boolean)
Gets JavaScript for checking selection of the grid.
Public methodGetImagePath
Gets UI image relative path.
(Inherited from AbstractUserControl.)
Public methodGetImageUrl
Gets UI image relative path.
(Inherited from AbstractUserControl.)
Public methodGetJSModule
Gets the JS module representing the UniGrid
Public methodGetReloadScript
Gets JavaScript for reload of the grid.
Public methodGetSelectionFieldClientID
Gets identifier of field containing selected items.
Public methodGetString
Returns the localized string of the control's hierarchically highest parent that has the ResourcePrefix property and its translation defined.
(Inherited from AbstractUserControl.)
Public methodGetValue(String)
Returns the value of the given property.
(Inherited from InlineUserControl.)
Public methodGetValueReturnType(String, ReturnType)
Returns the value of the given property.
(Inherited from InlineUserControl.)
Public methodHandleAction
Handles the action event.
Protected methodHandleVisibility
Handles the display of the grid based on whether the data is loaded or not
Public methodHasValue
Returns true if the value of the given property is set.
(Inherited from InlineUserControl.)
Protected methodIsInternalPostBack
Returns true if current request was fired by page change or filter show button.
Protected methodLoadActionsDefinition
Loads actions definition.
Protected methodLoadColumnDefinition
Load single column definition.
Protected methodLoadFilterControl
Loads the filter control
Protected methodLoadGrid
Loads the grid
Public methodLoadGridDefinition
Loads the grid definition.
Protected methodLoadOptionsDefinition
Load options definition.
Protected methodLoadPagerDefinition
Load UniGrid pager configuration.
Public methodLoadUserControl
Loads the user control based on the given path
(Inherited from AbstractUserControl.)
Public methodLoadXmlConfiguration
Loads the XML configuration of the grid.
Public methodLogAndShowError
Logs the exception and
(Inherited from AbstractUserControl.)
Protected methodMapPathInternal
Returns the physical file path that corresponds to the specified virtual path.
Public methodOnContentLoaded
Method that is called when the control content is loaded.
(Inherited from InlineUserControl.)
Protected methodOnInit
Init event handler.
(Inherited from AbstractUserControl.)
Protected methodOnLoad
Load event handler
(Overrides CMSUserControlOnLoad(EventArgs).)
Protected methodOnPreRender
PreRender event handler
(Overrides AbstractUserControlOnPreRender(EventArgs).)
Protected methodProcessSorting
Sets the sort direction if current request is sorting.
Public methodRaiseAction
Raises the action event.
Public methodRaiseAfterRetrieveData
Raises after data are retrieved.
Public methodRaiseBeforeFiltering
Raises the before filtering event.
Public methodRaiseBeforeSorting
Raises the before page index changing event.
Public methodRaiseCallbackEvent
Sets callback event arguments.
Public methodRaiseDataReload
Raises the reload data event and returns DataSet.
Public methodRaiseExternalDataBound
Raises the external data bound event.
Public methodRaiseLoadColumns
Raises when columns are loaded dynamically and not from XML.
Public methodRaiseOnAfterDataReload
Raises the after data reload event.
Public methodRaiseOnBeforeDataReload
Raises the before data reload event.
Public methodRaiseOnFilterFieldCreated
Raised when filter field is created.
Protected methodRaiseOnPageBinding
Raises the OnPageBinding event
Public methodRaisePageSizeChanged
Raises the after page size dropdown changed.
Public methodRaisePostBackEvent
Raises the postback event
Public methodRaiseShowButtonClick
Raises the before page index changing event.
Public methodReBind
Evokes control DataBind.
Public methodRedirectToAccessDenied(String)
Redirects the user to Access denied page.
(Inherited from CMSUserControl.)
Protected methodRedirectToAccessDenied(Int32, String)
Redirects the user to Access denied page.
(Inherited from CMSUserControl.)
Protected methodRedirectToAccessDenied(String, String)
Redirects the user to Access denied page.
(Inherited from CMSUserControl.)
Protected methodRedirectToUIElementAccessDenied
Redirects the user to Access denied page.
(Inherited from CMSUserControl.)
Protected methodRegisterCmdScripts
Register UniGrid commands scripts.
Public methodReleaseContext
Releases the control context.
(Inherited from CMSUserControl.)
Public methodReloadData
Reloads the grid data.
Protected methodRender
Render event handler.
(Inherited from AbstractUserControl.)
Public methodReset
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 methodResetSelection
Uncheck all checkboxes in selection column.
Public methodStatic memberResetStates
Resets the state of all Unigrids displaying objects of given type.
Public methodResolveUrl
Resolves the given URL
(Inherited from AbstractUserControl.)
Protected methodRestoreState
Restores the UniGrid's state, if applicable.
Public methodRetrieveData
Gets a DataSet with data based on UniGrid's settings.
Protected methodSetActionsHash
Sets hidden field with actions hashes.
Protected methodSetBasicFormFilter
Sets basic form filter.
Public methodSetContext
Sets the control context.
(Inherited from CMSUserControl.)
Protected methodStatic memberSetDropdownValue
Sets the DropDown value to the given value or default value if available
Protected methodSetFilter(Boolean)
Sets filter to the grid view and save it to the view state.
Protected methodSetFilter(Boolean, String)
Sets filter to the grid view and save it to the view state.
Protected methodSetPager
Sets pager control.
Protected methodStatic memberSetTextboxValue
Sets the TextBox value to the given value or default value if available
Protected methodSetUnigridControls
Sets UniGrid controls.
Protected methodSetupGridRow
Sets up an individual grid row
Public methodSetValue
Sets the property value of the control, setting the value affects only local property value.
(Inherited from InlineUserControl.)
Public methodShowConfirmation
Shows the general confirmation message.
(Inherited from AbstractUserControl.)
Public methodShowError
Shows the specified error message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowChangesSaved
Shows the general changes saved message.
(Inherited from AbstractUserControl.)
Public methodShowInformation
Shows the given information on the page, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowMessage(MessageTypeEnum, String, String, String, Boolean)
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Protected methodShowMessage(MessageTypeEnum, String, String, String, Boolean, Boolean)
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowWarning
Shows the specified warning message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Protected methodSortUniGridDataSource
Sorts UniGrid data source according to sort directive saved in ViewState.
Protected methodStoreState
Stores the UniGrid's state, if applicable.
Protected methodTrackViewState
Tracks the view state.
(Inherited from InlineUserControl.)
Top
Extension Methods
  NameDescription
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 MethodGetString
Gets the string by the specified resource key
(Defined by ControlsExtensions.)
Top
See Also