| UniGrid Properties |
The UniGrid type exposes the following members.
| 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 CMSUserControl.) | |
| 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.
| |
| GridMassActions |
Mass actions 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.
| |
| MassActions |
Control containing mass actions.
| |
| 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.) | |
| Properties |
Control properties.
(Inherited from InlineUserControl.) | |
| 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.
| |
| ResourcePrefix |
Prefix for the resource strings which are used for the localization by the control and its child controls.
(Inherited from AbstractUserControl.) | |
| ResourcePrefixes |
List of cached resource prefixes for the parent hierarchy
(Inherited from AbstractUserControl.) | |
| 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).
| |
| ShowExportMenu |
Defines whether to show export 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 CMSUserControl.) | |
| 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.
|