The UniGrid type exposes the following members.
Back to Top
Back to Top
Back to Top
Back to Top
Back to Top
Back to Top
Constructors
Name | Description | |
---|---|---|
UniGrid |
Constructor
|
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.) | |
AddedControl | (Inherited from Control.) | |
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.) | |
AddParsedSubObject | Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object. (Inherited from Control.) | |
AddWarning |
Adds warning text to existing message on the page.
(Inherited from AbstractUserControl.) | |
ApplyFilter |
Applies current filter where condition.
| |
ApplyStyleSheetSkin | Applies the style properties defined in the page style sheet to the control. (Inherited from Control.) | |
BuildProfileTree | Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page. (Inherited from Control.) | |
ClearCachedClientID | Sets the cached ClientID value to null. (Inherited from Control.) | |
ClearEffectiveClientIDMode | Sets the ClientIDMode property of the current control instance and of any child controls to Inherit. (Inherited from Control.) | |
ClearChildControlState | Deletes the control-state information for the server control's child controls. (Inherited from Control.) | |
ClearChildState | Deletes the view-state and control-state information for all the server control's child controls. (Inherited from Control.) | |
ClearChildViewState | Deletes the view-state information for all the server control's child controls. (Inherited from Control.) | |
Construct | Performs design-time logic. (Inherited from TemplateControl.) | |
CreateControlCollection | Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control. (Inherited from Control.) | |
CreateChildControls | Called by the ASP.NET page framework to notify server controls that use composition-based implementation to create any child controls they contain in preparation for posting back or rendering. (Inherited from Control.) | |
CreateResourceBasedLiteralControl | Accesses literal strings stored in a resource. The CreateResourceBasedLiteralControl(Int32, Int32, Boolean) method is not intended for use from within your code. (Inherited from TemplateControl.) | |
DataBind | Binds a data source to the invoked server control and all its child controls. (Inherited from Control.) | |
DataBind(Boolean) | Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event. (Inherited from Control.) | |
DataBindChildren | Binds a data source to the server control's child controls. (Inherited from Control.) | |
DesignerInitialize | Performs any initialization steps on the user control that are required by RAD designers. (Inherited from UserControl.) | |
DisplayExternalFilter |
Determines whether to show external filter.
| |
Dispose | Enables a server control to perform final clean up before it is released from memory. (Inherited from Control.) | |
EnsureControls |
Interface for control that is able to explicitly ensure its child controls
(Inherited from AbstractUserControl.) | |
EnsureChildControls | Determines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from Control.) | |
EnsureID | Creates an identifier for controls that do not have an identifier assigned. (Inherited from Control.) | |
Equals | (Inherited from Object.) | |
Eval(String) |
Evaluates the given value
(Inherited from AbstractUserControl.) | |
Eval(String, Boolean) |
Evaluates the item data (safe version), with html encoding.
(Inherited from AbstractUserControl.) | |
Eval(String, String) | Evaluates a data-binding expression using the specified format string to display the result. (Inherited from TemplateControl.) | |
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.) | |
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.) | |
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) | |
FindControl(String) | Searches the current naming container for a server control with the specified id parameter. (Inherited from Control.) | |
FindControl(String, Int32) | Searches the current naming container for a server control with the specified id and an integer, specified in the pathOffset parameter, which aids in the search. You should not override this version of the FindControl method. (Inherited from Control.) | |
Focus | Sets input focus to a control. (Inherited from Control.) | |
FrameworkInitialize | Initializes the control that is derived from the TemplateControl class. (Inherited from TemplateControl.) | |
GetAccessDeniedPageUrl |
Returns access denied page with dependence on current setting.
(Inherited from CMSUserControl.) | |
GetClearSelectionScript |
Gets JavaScript for clearing selection of the grid.
| |
GetDataTableFilter |
Returns where condition from UniGrid filters for DataTable.Select.
| |
GetDesignModeState | Gets design-time data for a control. (Inherited from Control.) | |
GetFilter |
Returns where condition from UniGrid filters.
| |
GetFilter(Boolean) |
Returns where condition from UniGrid filters.
| |
GetFlagIconUrl |
Returns resolved path to the flag image for the specified culture.
(Inherited from AbstractUserControl.) | |
GetGlobalResourceObject(String, String) | Gets an application-level resource object based on the specified ClassKey and ResourceKey properties. (Inherited from TemplateControl.) | |
GetGlobalResourceObject(String, String, Type, String) | Gets an application-level resource object based on the specified ClassKey and ResourceKey properties, object type, and property name of the resource. (Inherited from TemplateControl.) | |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
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.) | |
GetLocalResourceObject(String) | Gets a page-level resource object based on the specified ResourceKey property. (Inherited from TemplateControl.) | |
GetLocalResourceObject(String, Type, String) | Gets a page-level resource object based on the specified ResourceKey property, object type, and property name. (Inherited from TemplateControl.) | |
GetReloadScript |
Gets JavaScript for reload of the grid.
| |
GetRouteUrl(Object) | Gets the URL that corresponds to a set of route parameters. (Inherited from Control.) | |
GetRouteUrl(RouteValueDictionary) | Gets the URL that corresponds to a set of route parameters. (Inherited from Control.) | |
GetRouteUrl(String, Object) | Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.) | |
GetRouteUrl(String, RouteValueDictionary) | Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control.) | |
GetSelectionFieldClientID |
Gets identifier of field containing selected items.
| |
GetString |
Returns localized string.
(Inherited from AbstractUserControl.) | |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
GetUniqueIDRelativeTo | Returns the prefixed portion of the UniqueID property of the specified control. (Inherited from Control.) | |
GetValue(String) |
Returns the value of the given property.
(Inherited from InlineUserControl.) | |
GetValue ReturnType (String, ReturnType) |
Returns the value of the given property.
(Inherited from InlineUserControl.) | |
HasControls | Determines if the server control contains any child controls. (Inherited from Control.) | |
HasEvents | Returns a value indicating whether events are registered for the control or any child controls. (Inherited from Control.) | |
HasValue |
Returns true if the value of the given property is set.
(Inherited from InlineUserControl.) | |
InitializeAsUserControl | Initializes the UserControl object that has been created declaratively. Since there are some differences between pages and user controls, this method makes sure that the user control is initialized properly. (Inherited from UserControl.) | |
IsLiteralContent | Determines if the server control holds only literal content. (Inherited from Control.) | |
LoadControl(String) | Loads a Control object from a file based on a specified virtual path. (Inherited from TemplateControl.) | |
LoadControl(Type, Object ) | Loads a Control object based on a specified type and constructor parameters. (Inherited from TemplateControl.) | |
LoadControlState | Restores control-state information from a previous page request that was saved by the SaveControlState method. (Inherited from Control.) | |
LoadGridDefinition |
Loads the grid definition.
| |
LoadTemplate | Obtains an instance of the ITemplate interface from an external file. (Inherited from TemplateControl.) | |
LoadUserControl |
Loads the user control based on the given path
(Inherited from AbstractUserControl.) | |
LoadViewState | Restores the view-state information from a previous user control request that was saved by the SaveViewState method. (Inherited from UserControl.) | |
LogAndShowError |
Logs the exception and
(Inherited from AbstractUserControl.) | |
MapPath | Assigns a virtual file path, either absolute or relative, to a physical file path. (Inherited from UserControl.) | |
MapPathSecure | Retrieves the physical path that a virtual path, either absolute or relative, maps to. (Inherited from Control.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
OnAbortTransaction | Raises the AbortTransaction event. (Inherited from TemplateControl.) | |
OnBubbleEvent | Determines whether the event for the server control is passed up the page's UI server control hierarchy. (Inherited from Control.) | |
OnCommitTransaction | Raises the CommitTransaction event. (Inherited from TemplateControl.) | |
OnContentLoaded |
Method that is called when the control content is loaded.
(Inherited from InlineUserControl.) | |
OnDataBinding | Raises the DataBinding event. (Inherited from Control.) | |
OnError | Raises the Error event. (Inherited from TemplateControl.) | |
OnInit |
Init event handler.
(Inherited from AbstractUserControl.) | |
OnLoad |
OnLoad override, setup access denied page with dependence on current usage.
(Inherited from CMSUserControl.) | |
OnPreRender |
PreRender event handler
(Overrides AbstractUserControl OnPreRender(EventArgs).) | |
OnUnload | Raises the Unload event. (Inherited from Control.) | |
OpenFile | Gets a Stream used to read a file. (Inherited from Control.) | |
ParseControl(String) | Parses an input string into a Control object on the Web Forms page or user control. (Inherited from TemplateControl.) | |
ParseControl(String, Boolean) | Parses an input string into a Control object on the ASP.NET Web page or user control. (Inherited from TemplateControl.) | |
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.
| |
RaiseBubbleEvent | Assigns any sources of the event and its information to the control's parent. (Inherited from Control.) | |
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.
| |
RaisePageSizeChanged |
Raises the after page size dropdown changed.
| |
RaiseShowButtonClick |
Raises the before page index changing event.
| |
ReadStringResource | Reads a string resource. The ReadStringResource method is not intended for use from within your code. (Inherited from TemplateControl.) | |
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.) | |
ReleaseContext |
Releases the control context.
(Inherited from CMSUserControl.) | |
ReloadData |
Reload data.
| |
RemovedControl | (Inherited from Control.) | |
Render |
Render event handler.
(Inherited from AbstractUserControl.) | |
RenderControl(HtmlTextWriter) | Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled. (Inherited from Control.) | |
RenderControl(HtmlTextWriter, ControlAdapter) | Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. (Inherited from Control.) | |
RenderChildren | Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client. (Inherited from Control.) | |
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.
| |
ResetFilter |
Resets the filter
| |
ResetSelection |
Uncheck all checkboxes in selection column.
| |
ResolveAdapter | Gets the control adapter responsible for rendering the specified control. (Inherited from Control.) | |
ResolveClientUrl | Gets a URL that can be used by the browser. (Inherited from Control.) | |
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.
| |
SaveControlState | Saves any server control state changes that have occurred since the time the page was posted back to the server. (Inherited from Control.) | |
SaveViewState | Saves any user control view-state changes that have occurred since the last page postback. (Inherited from UserControl.) | |
SetContext |
Sets the control context.
(Inherited from CMSUserControl.) | |
SetDesignModeState | Sets design-time data for a control. (Inherited from Control.) | |
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.
| |
SetRenderMethodDelegate | Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from Control.) | |
SetStringResourcePointer | Sets a pointer to a string resource. The SetStringResourcePointer(Object, Int32) method is used by generated classes and is not intended for use from within your code. (Inherited from TemplateControl.) | |
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.) | |
StoreState |
Stores the UniGrid's state, if applicable.
| |
TestDeviceFilter | Returns a Boolean value indicating whether a device filter applies to the HTTP request. (Inherited from TemplateControl.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) | |
TrackViewState |
Tracks the view state.
(Inherited from InlineUserControl.) | |
WriteUTF8ResourceString | Writes a resource string to an HtmlTextWriter control. The WriteUTF8ResourceString(HtmlTextWriter, Int32, Int32, Boolean) method is used by generated classes and is not intended for use from within your code. (Inherited from TemplateControl.) | |
XPath(String) | Evaluates an XPath data-binding expression. (Inherited from TemplateControl.) | |
XPath(String, IXmlNamespaceResolver) | Evaluates an XPath data-binding expression using the specified prefix and namespace mappings for namespace resolution. (Inherited from TemplateControl.) | |
XPath(String, String) | Evaluates an XPath data-binding expression using the specified format string to display the result. (Inherited from TemplateControl.) | |
XPath(String, String, IXmlNamespaceResolver) | Evaluates an XPath data-binding expression using the specified prefix and namespace mappings for namespace resolution and the specified format string to display the result. (Inherited from TemplateControl.) | |
XPathSelect(String) | Evaluates an XPath data-binding expression and returns a node collection that implements the IEnumerable interface. (Inherited from TemplateControl.) | |
XPathSelect(String, IXmlNamespaceResolver) | Evaluates an XPath data-binding expression using the specified prefix and namespace mappings for namespace resolution and returns a node collection that implements the IEnumerable interface. (Inherited from TemplateControl.) |
Extension Methods
Name | Description | |
---|---|---|
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.) |
Fields
Name | Description | |
---|---|---|
ALL |
Constant representing all data source
| |
CLEAR_SELECTION_PREFIX |
ClearSelection function prefix
| |
CMD_PREFIX |
Command function prefix
| |
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.
| |
DESTROY_OBJECT_PREFIX |
Destroy function prefix
| |
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.
| |
CHECK_SELECTION_PREFIX |
CheckSelection function prefix
| |
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.
| |
RELOAD_PREFIX |
Reload function prefix
| |
SELECT_ALL_PREFIX |
SelectAll function prefix
| |
SELECT_PREFIX |
Select function prefix
| |
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.
|
Properties
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.
| |
Adapter | Gets the browser-specific adapter for the control. (Inherited from Control.) | |
AllColumns |
Allows to explicitly specify all columns that can be retrieved from UniGrid
Comma-separated value e.g. "ItemID, ItemName"
| |
Application | Gets the Application object for the current Web request. (Inherited from UserControl.) | |
ApplyPageSize |
Determines whether to apply CurrentPageSize when retrieving data.
| |
AppRelativeTemplateSourceDirectory | Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control.) | |
AppRelativeVirtualPath | Gets or sets the application-relative, virtual directory path to the file from which the control is parsed and compiled. (Inherited from TemplateControl.) | |
Attributes | Gets a collection of all attribute name and value pairs declared in the user control tag within the .aspx file. (Inherited from UserControl.) | |
AutoHandlers | Obsolete. The AutoHandlers property has been deprecated in ASP.NET NET 2.0. It is used by generated classes and is not intended for use within your code. (Inherited from TemplateControl.) | |
BindingContainer | Gets the control that contains this control's data binding. (Inherited from Control.) | |
Cache | Gets the Cache object that is associated with the application that contains the user control. (Inherited from UserControl.) | |
CachePolicy | Gets a reference to a collection of caching parameters for this user control. (Inherited from UserControl.) | |
ClientID | Gets the control ID for HTML markup that is generated by ASP.NET. (Inherited from Control.) | |
ClientIDMode | Gets or sets the algorithm that is used to generate the value of the ClientID property. (Inherited from Control.) | |
ClientIDSeparator | Gets a character value representing the separator character used in the ClientID property. (Inherited from Control.) | |
Columns |
Columns to get from the database.
| |
CompleteWhereCondition |
Returns the complete where condition.
| |
ComponentName |
Component name
(Inherited from AbstractUserControl.) | |
Context | Gets the HttpContext object associated with the server control for the current Web request. (Inherited from Control.) | |
ControlContext |
Control context.
(Inherited from CMSUserControl.) | |
ControlGUID |
Unique ID of the control within the given request.
(Inherited from CMSUserControl.) | |
Controls | Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy. (Inherited from Control.) | |
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.) | |
CustomFilters |
Gets custom filter controls from UniGrid.
| |
DataItemContainer | Gets a reference to the naming container if the naming container implements IDataItemContainer. (Inherited from Control.) | |
DataKeysContainer | Gets a reference to the naming container if the naming container implements IDataKeysControl. (Inherited from 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 array list of selected items.
| |
DesignMode | Gets a value indicating whether a control is being used on a design surface. (Inherited from Control.) | |
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
| |
EnableTheming | Gets or sets a Boolean value indicating whether themes apply to the control that is derived from the TemplateControl class. (Inherited from TemplateControl.) | |
EnableViewState | Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client. (Inherited from Control.) | |
Events | Gets a list of event handler delegates for the control. This property is read-only. (Inherited from Control.) | |
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.
| |
FilterFields |
Filter fields dictionary for filter customization.
Dictionary is filled after LoadGridDefinition method is called.
Field source name is used as the key. If there are multiple same source names they have '#n' suffix to be unique ('n' is numeric counter).
| |
FilterForm |
Gets filter form.
| |
FilterFormData |
Data container for filter form.
| |
FilterFormName |
This name is used for alternative form.
| |
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.
| |
HasChildViewState | Gets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from Control.) | |
HeaderActions |
Header actions control
(Inherited from AbstractUserControl.) | |
HideControlForZeroRows |
Indicates whether hide UniGrid or not when its data source is empty.
| |
HideFilterButton |
Indicates whether hide filter "Show" button or not.
| |
ChildControlsCreated | Gets a value that indicates whether the server control's child controls have been created. (Inherited from Control.) | |
ID | Gets or sets the programmatic identifier assigned to the server control. (Inherited from Control.) | |
IdSeparator | Gets the character used to separate control identifiers. (Inherited from Control.) | |
ImageDirectoryPath |
Gets or sets directory path for images.
| |
InfoObject |
Gets instance of info object based on ObjectType property.
| |
InitialFilterState |
Gets the object that holds the initial UniGrid filter state.
| |
InitialFilterStateControls | ||
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.
| |
IsChildControlStateCleared | Gets a value indicating whether controls contained within this control have control state. (Inherited from Control.) | |
IsLiveSite |
Indicates if control is used on live site.
(Inherited from AbstractUserControl.) | |
IsPostBack | Gets a value indicating whether the user control is being loaded in response to a client postback, or if it is being loaded and accessed for the first time. (Inherited from UserControl.) | |
IsTrackingViewState | Gets a value that indicates whether the server control is saving changes to its view state. (Inherited from Control.) | |
IsViewStateEnabled | Gets a value indicating whether view state is enabled for this control. (Inherited from Control.) | |
Item |
Gets or sets the value of the column.
(Inherited from InlineUserControl.) | |
LoadViewStateByID | Gets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control.) | |
MessagesPlaceHolder |
Placeholder for messages
(Inherited from AbstractUserControl.) | |
NamedColumns |
Gets named columns from grid view.
| |
NamingContainer | Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same ID property value. (Inherited from Control.) | |
NewlySelectedItems |
Gets array list of selected items.
| |
ObjectType |
Type of the selected objects.
| |
OrderBy |
Order columns.
| |
OrderByRegex |
Description.
| |
Page | Gets a reference to the Page instance that contains the server control. (Inherited from Control.) | |
Pager |
UniGrid pager used by UniGrid.
| |
PagerConfig |
Pager configuration.
| |
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: 25,50,100,##ALL##
| |
PageSizeDropdown |
Gets page size dropdown from UniGrid.
| |
Parameter |
Inline control parameter - mirrors the GridName property.
(Overrides InlineUserControl Parameter.) | |
Parent | Gets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control.) | |
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.
| |
RenderingCompatibility | Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from Control.) | |
Request | Gets the HttpRequest object for the current Web request. (Inherited from UserControl.) | |
Response | Gets the HttpResponse object for the current Web request. (Inherited from UserControl.) | |
RowsCount |
Gets rows count from DataSet.
Sets after ReloadData().
| |
SelectedItems |
Gets array list of selected items.
| |
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.
| |
Server | Gets the HttpServerUtility object for the current Web request. (Inherited from UserControl.) | |
Session | Gets the HttpSessionState object for the current Web request. (Inherited from UserControl.) | |
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 than filter limit, show filter.
| |
ShowObjectMenu |
Defines whether to show object menu (menu containing relationships, export/backup, destroy object, ... functionality)
| |
Site | Gets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control.) | |
SkinID | Gets or sets the skin to apply to the control. (Inherited from Control.) | |
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.) | |
SupportAutoEvents | Gets a value indicating whether the TemplateControl control supports automatic events. (Inherited from TemplateControl.) | |
TemplateControl | Gets or sets a reference to the template that contains this control. (Inherited from Control.) | |
TemplateSourceDirectory | Gets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control.) | |
TextColumns |
Array list of text columns used in sorting when query is used.
| |
TopN |
Number of records to display (load).
| |
Trace | Gets the TraceContext object for the current Web request. (Inherited from UserControl.) | |
TypeName |
Returns the object type name.
(Inherited from CMSUserControl.) | |
UIContext |
Control's UI Context
(Inherited from AbstractUserControl.) | |
UniqueID | Gets the unique, hierarchically qualified identifier for the server control. (Inherited from 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.) | |
ViewStateIgnoresCase | Gets a value that indicates whether the StateBag object is case-insensitive. (Inherited from Control.) | |
ViewStateMode | Gets or sets the view-state mode of this control. (Inherited from Control.) | |
Visible | Gets or sets a value that indicates whether a server control is rendered as UI on the page. (Inherited from Control.) | |
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.
|
Events
Name | Description | |
---|---|---|
AbortTransaction | Occurs when a user ends a transaction. (Inherited from TemplateControl.) | |
CommitTransaction | Occurs when a transaction completes. (Inherited from TemplateControl.) | |
DataBinding | Occurs when the server control binds to a data source. (Inherited from Control.) | |
Disposed | Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested. (Inherited from Control.) | |
Error | Occurs when an unhandled exception is thrown. (Inherited from TemplateControl.) | |
Init | Occurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from Control.) | |
Load | Occurs when the server control is loaded into the Page object. (Inherited from Control.) | |
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.
| |
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.
| |
PreRender | Occurs after the Control object is loaded but prior to rendering. (Inherited from Control.) | |
Unload | Occurs when the server control is unloaded from memory. (Inherited from Control.) |
See Also