Click or drag to resize
UniGrid Properties

The UniGrid type exposes the following members.

Properties
  NameDescription
Protected propertyActionsHashHidden
Hidden field with hashed action ids.
Protected propertyActionsHidden
Hidden field with action ids.
Public propertyActionsID
Array list of actions on current page of UniGrid.
Protected propertyAdvancedExportControl
Returns the advanced export control of the current grid
Public propertyAllColumns
Allows to explicitly specify all columns that can be retrieved from UniGrid Comma-separated value e.g. "ItemID, ItemName"
Public propertyAllowShiftKeySelection
Indicates whether selection of multiple items using the Shift key is enabled.
Public propertyApplyPageSize
Determines whether to apply CurrentPageSize when retrieving data.
Public propertyCheckRelative
If true, relative ancestor div is checked in context menu
Protected propertyCmdArgHiddenField
Hidden field for the command argument
Protected propertyCmdNameHiddenField
Hidden field for the command name
Public propertyColumns
Columns to get from the database.
Public propertyCompleteWhereCondition
Returns the complete where condition.
Public propertyComponentName
Component name
(Inherited from AbstractUserControl.)
Public propertyControlContext
Control context.
(Inherited from CMSUserControl.)
Public propertyControlGUID
Unique ID of the control within the given request.
Public propertyCurrentOffset
Gets current offset.
Protected propertyCurrentOrder
Gets current order by.
Protected propertyCurrentPageSize
Gets current page size from pager.
Public propertyCurrentResolver
Control's resolver
(Inherited from CMSUserControl.)
Public propertyCurrentSite
Current site
(Inherited from AbstractUserControl.)
Public propertyCurrentTopN
Number of records to display (load). It's being set before ReloadData event is fired in order to optimize the data loading.
Public propertyCurrentUser
Current user
(Inherited from AbstractUserControl.)
Public propertyCustomFilter
Custom filter control
Public propertyDataSource
External grid DataSource, when set, overrides the default data source settings.
Public propertyDataSourceIsSorted
Indicates if data source is sorted outside of UniGrid.
Public propertyDefaultImageDirectoryPath
Gets default image directory path for images.
Public propertyDelayedReload
Indicates if delayed reload should be used. If True reload data must be called externally.
Public propertyDeselectedItems
Gets deselected items from UniGrid.
Public propertyDialogHeight
Height of
Public propertyDialogWidth
Width of edited dialog
Public propertyDisplayMode
Gets or sets display mode of the control.
(Inherited from CMSUserControl.)
Public propertyDocumentManager
Document manager control
(Inherited from AbstractUserControl.)
Public propertyEditActionUrl
URL for the edit action handling.
Public propertyEditedObject
Control's edited object
(Inherited from CMSUserControl.)
Public propertyEditInDialog
If true, the editing action is done through a dialog
Public propertyExportFileName
Name used for exporting files (without extension).
Public propertyFilterByQueryString
True if the filtering should be set from the query string parameters.
Public propertyFilterDirectoryPath
Gets or sets directory path for custom filter controls.
Public propertyFilteredZeroRowsText
Text displayed when UniGrid data source is empty after filtering.
Public propertyFilterForm
Gets filter form.
Public propertyFilterFormData
Data container for filter form.
Public propertyFilterFormName
This name is used for alternative form.
Protected propertyFilterFormPlaceHolder
Returns the filter form placeholder
Public propertyFilterIsSet
Indicates if filter is set. It's being used when filter by query string is used.
Public propertyFilterLimit
Minimal count of entries for display filter. 0 means that filter is displayed always and -1 means that filter is never displayed.
Public propertyFilterMode
Filter mode passed to custom filters.
Public propertyFilterPlaceHolder
Gets filter placeHolder from UniGrid.
Public propertyGridActions
Actions definition.
Public propertyGridColumns
Columns definition.
Public propertyGridMassActions
Mass actions definition.
Public propertyGridName
Xml file with source information.
Public propertyGridOptions
Options.
Public propertyGridView
Grid view used by UniGrid.
Protected propertyHasDefaultState
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.
Public propertyHeaderActions
Header actions control
(Inherited from AbstractUserControl.)
Protected propertyHeaderPanel
Returns the grid header panel
Public propertyHideControlForZeroRows
Indicates whether hide UniGrid or not when its data source is empty.
Public propertyHideFilterButton
Indicates whether hide filter "Show" button or not.
Public propertyImageDirectoryPath
Gets or sets directory path for images.
Protected propertyInfoLabel
Grid information label
Public propertyInfoObject
Gets instance of info object based on ObjectType property.
Public propertyIsCMSDesk
Determines whether the current control lies on the page that is currently located under the CMS Desk.
(Inherited from CMSUserControl.)
Public propertyIsEmpty
Indicates if the data source is empty.
Public propertyIsLiveSite
Indicates if control is used on live site
(Overrides AbstractUserControlIsLiveSite.)
Public propertyItem
Gets or sets the value of the column.
(Inherited from InlineUserControl.)
Public propertyJavaScriptModule
Path to JavaScript module that will be loaded for this grid.
Public propertyJavaScriptModuleData
Data that will be sent to the grid's JavaScript module.
Public propertyMacro
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.
Public propertyMassActions
Control containing mass actions.
Protected propertyMenuPlaceHolder
Gets the menu placeholder
Public propertyMessagesPlaceHolder
Placeholder for messages
(Inherited from AbstractUserControl.)
Public propertyNamedColumns
Gets named columns from grid view.
Public propertyNewlySelectedItems
Gets newly selected items from UniGrid.
Public propertyObjectType
Object type which is loaded to the grid
Public propertyOrderBy
Order columns.
Protected propertyOrderByRegex
Description.
Protected propertyOriginallySelected
Gets array list of originally selected items.
Public propertyPager
UniGrid pager used by UniGrid.
Public propertyPagerConfig
Pager configuration.
Public propertyPagerDataItem
Pager data item.
Public propertyPagerFirstPageText
Text displayed in pagers first page link.
Public propertyPagerForceNumberOfResults
Volume of returned records.
Public propertyPagerLastPageText
Text displayed in pagers last page link.
Public propertyPagerNextGroupText
Text displayed in pagers next group link.
Public propertyPagerNextPageText
Text displayed in pagers next page link.
Public propertyPagerPreviousGroupText
Text displayed in pagers previous group link.
Public propertyPagerPreviousPageText
Text displayed in pagers previous page link.
Public propertyPageSize
UniGrid page size values separated with comma. Default: 5,10,25,50,100
Public propertyPageSizeDropdown
Gets page size dropdown from UniGrid.
Public propertyParameter
Inline control parameter - mirrors the GridName property.
(Overrides InlineUserControlParameter.)
Protected propertyProperties
Control properties.
(Inherited from InlineUserControl.)
Public propertyQuery
Query used in grid view.
Public propertyQueryParameters
Query parameters for the query.
Public propertyRememberDefaultState
Indicates whether UniGrid remembers its default state.
Public propertyRememberState
Gets or sets the value indicating whether UniGrid remembers its state, i.e., filter, page number, page size and sorting order.
Public propertyRememberStateByParam
Gets or sets a comma-separated list of names of query parameters whose value constitute a part of UniGrid's identity.
Public propertyCode exampleResourcePrefix
Prefix for the resource strings which are used for the localization by the control and its child controls.
(Inherited from AbstractUserControl.)
Public propertyResourcePrefixes
List of cached resource prefixes for the parent hierarchy
(Inherited from AbstractUserControl.)
Public propertyRowsCount
Gets rows count from DataSet. Sets after ReloadData().
Public propertySelectedItems
Gets or sets selected items of UniGrid. Returns empty collection if hash validation fails.
Protected propertySelectionHashHiddenField
Hidden field containing selected items hash.
Public propertySelectionHiddenField
Hidden field containing selected items.
Public propertySelectionJavascript
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.
Public propertySelectionsID
Array list of selection ids of UniGrid.
Public propertyShortID
Short ID of the control.
(Inherited from AbstractUserControl.)
Public propertyShowActionsLabel
If true, the actions label is displayed
Public propertyShowActionsMenu
Defines whether to show actions menu (menu in the header row of actions column).
Public propertyShowExportMenu
Defines whether to show export menu (menu in the header row of actions column).
Public propertyShowFilter
If count of rows is greater or equal to filter limit, show filter.
Public propertyShowObjectMenu
Defines whether to show object menu (menu containing relationships, export/backup, destroy object, ... functionality)
Protected propertySortColumns
Gets sort columns from grid view.
Public propertySortDirect
Sort directive used in grid view.
Protected propertyStateRestored
Gets or sets the value indicating whether UniGrid has restored its state.
Public propertyStopProcessing
Indicates if the control should perform the operations.
(Inherited from AbstractUserControl.)
Public propertyTextColumns
Array list of text columns used in sorting when query is used.
Public propertyTopN
Number of records to display (load).
Public propertyUIContext
Control's UI Context
(Inherited from CMSUserControl.)
Public propertyUniPagerControl
Pager control.
Public propertyUseCMSDeskAccessDeniedPage
Gets or sets the value that indicates whether CMSDesk access denied page should be used.
(Inherited from CMSUserControl.)
Public propertyUsesLocalMessagesPlaceHolder
Indicates if control uses local messages placeholder
(Inherited from AbstractUserControl.)
Protected propertyViewState
ViewState - overridden for the Master page ViewState fix.
(Inherited from InlineUserControl.)
Public propertyWhereClause
Where clause used in grid view.
Public propertyWhereCondition
Where condition that can be set from other classes.
Public propertyZeroRowsText
Text displayed when UniGrid data source is empty.
Top
See Also