Back to Devexpress

GridViewSettings Properties

aspnetmvc-devexpress-dot-web-dot-mvc-dot-gridviewsettings-dot-underscore-properties.md

latest25.7 KB
Original Source

GridViewSettings Properties

Contains the GridView extension settings.

NameDescription
AccessibilityCompliantEnables accessibility support. Inherited from GridSettingsBase.
AccessKeyGets or sets the access key that allows you to quickly navigate to the ASP.NET MVC extension. Inherited from SettingsBase.
AfterPerformCallbackEnables you to perform custom actions after a callback or a postback initiated by the control has been processed on the server.
AttributesGets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. Inherited from SettingsBase.
AutoFilterCellEditorCreateEnables you to assign editors to individual filter row cells.
AutoFilterCellEditorInitializeEnables the cell editors displayed within the auto filter row cells to be initialized.
BeforeColumnSortingGroupingProvides an opportunity to obtain the column sorting or grouping parameters and to perform some action before a column is sorted or grouped.
BeforeGetCallbackResultAllows you to perform custom actions after a callback sent by the current extension has been processed on the server, but prior to the time the respective callback result render is formed. Inherited from GridSettingsBase.
BeforeHeaderFilterFillItemsEnables you to provide custom filter items instead of default ones displayed within a Popup Header Filter.
CallbackRouteValuesDefines the callback routing logic by specifying the names of a Controller and an Action which should handle callbacks. Inherited from GridSettingsBase.
CaptionGets or sets the text to render in an HTML caption element in a GridView.
CellEditorInitializeEnables initializing the cell editors displayed within the grid edit cells.
ClientLayoutEnables you to save and restore the previously saved layout of the extension. Inherited from GridSettingsBase.
ClientSideEventsGets an object that lists the client-side events specific to the GridView.
ClientVisibleGets or sets a value that specifies the initial visibility state of an extension on the client. Inherited from GridSettingsBase.
ColumnsProvides access to a GridView’s column collection.
CommandButtonInitializeEnables individual row cells containing command column items to be initialized.
CommandColumnProvides access to the GridView’s command column.
ContextMenuInitializeEnables you to customize the context menu when it is initialized.
ContextMenuItemClickEnables you to perform custom actions when a context menu item has been clicked.
ContextMenuItemVisibilityEnables you to dynamically control the context menu item visibility and availability.
ControlStyleProvides access to the style settings declared at the root level of the extension’s wrapped web server control. Inherited from GridSettingsBase.
CustomActionRouteValuesDefines the custom callback routing logic by specifying the names of a Controller and an Action which should handle custom callbacks initiated by the MVCxClientGridView.PerformCallback method. Inherited from GridSettingsBase.
CustomBindingRouteValuesCollectionDefines the callback routing logic by specifying the names of Controllers and Actions that handle callbacks related to grid data operations such as paging, sorting, grouping and filtering.
CustomButtonInitializeEnables you to initialize custom command buttons.
CustomCallbackObsolete. Fires when a callback has been initiated.
CustomCellMergeEnables you to merge grid cells manually.
CustomColumnDisplayTextEnables you to specify a cell’s display text.
CustomColumnGroupProvides the capability to group data using custom rules.
CustomColumnSortEnables you to sort data using custom rules.
CustomDataActionRouteValuesDefines the custom callback routing logic by specifying the names of a Controller and an Action which should handle custom data callbacks initiated by the MVCxClientGridView.GetValuesOnCustomCallback method. Inherited from GridSettingsBase.
CustomDataCallbackObsolete. Fires when a round trip to the server has been initiated by a call to the ASPxClientGridView.GetValuesOnCustomCallback method.
CustomGroupDisplayTextEnables you to provide custom content for group rows.
CustomJSPropertiesEnables you to supply any server data that can then be parsed on the client.
CustomSummaryCalculateEnables you to calculate summary values manually.
CustomUnboundColumnDataEnables data to be supplied to unbound columns.
DataBindingAllows you to perform custom actions before a GridView is bound to a data source. Inherited from GridSettingsBase.
DataBoundAllows you to perform actions after the GridView is bound to a data source. Inherited from GridSettingsBase.
DeleteSelectedRowsRouteValuesDefines the callback routing logic by specifying the names of a Controller and an Action which should handle callbacks related to selected rows deletion.
DetailRowExpandedChangedAllows you to perform custom actions in response to expanding or collapsing a master row.
DetailRowGetButtonVisibilityEnables you to hide/show expand buttons displayed within individual data rows.
EditFormLayoutCreatedEnables you to perform custom actions in response to the layout creation.
EditFormLayoutPropertiesContains settings allowing you to customize the edit form layout.
EnableCallbackAnimationGets or sets a value that specifies whether a specific animation effect is used when a GridView’s content is updated via a callback. Inherited from GridSettingsBase.
EnableCallbackCompressionGets or sets whether callback compression is enabled. Inherited from GridSettingsBase.
EnabledGets or sets a value that indicates whether the MVC Extension is enabled, allowing it to respond to end-user interactions. Inherited from SettingsBase.
EnablePagingCallbackAnimationGets or sets a value that specifies whether a specific animation effect is used when changing pages. Inherited from GridSettingsBase.
EnablePagingGesturesGets or sets a value specifying whether an end-user can switch pages with a swipe gesture. Inherited from GridSettingsBase.
EnableRowsCacheGets or sets whether data caching is enabled.
EnableThemingGets or sets a value indicating whether themes apply to this extension. Inherited from SettingsBase.
EncodeHtmlThis property is not in effect for the GridSettingsBase class. Inherited from GridSettingsBase.
FilterControlColumnsCreatedEnables you to customize the filter control column collection after it is created. Inherited from GridSettingsBase.
FilterControlCriteriaValueEditorCreateEnables you to replace the default criteria value editor with a custom one. Inherited from GridSettingsBase.
FilterControlCriteriaValueEditorInitializeEnables the editors displayed within the criteria value to be initialized. Inherited from GridSettingsBase.
FilterControlCustomValueDisplayTextEnables you to specify the entered filter value’s custom display text to be displayed when the filter’s condition value editor is inactive. Inherited from GridSettingsBase.
FilterControlOperationVisibilityEnables you to dynamically hide operation items (such as the Equals, Contains, etc.) of the FilterControl’s operation dropdown menu. Inherited from GridSettingsBase.
FilterControlParseValueEnables you to process and modify an entered value before it is actually accepted by the filter. Inherited from GridSettingsBase.
FormatConditionsProvides access to a collection of format condition rules.
GroupSummaryProvides access to group summary items.
GroupSummarySortInfoEnables sorting group rows by their summary values.
HeaderFilterEditorInitializeOccurs when a header filter editor is initialized.
HeaderFilterFillItemsAllows you to populate a filter dropdown with custom filter items.
HeightGets or sets the height of the extension. Inherited from SettingsBase.
HtmlCommandCellPreparedAllows you to change the settings of individual command column cells.
HtmlDataCellPreparedEnables the settings of individual data cells to be changed.
HtmlEditFormCreatedEnables you to initialize elements contained within the grid’s Edit Form template.
HtmlFooterCellPreparedEnables the settings of individual footer cells to be changed.
HtmlRowCreatedAllows you to initialize elements contained within the grid templates, when a table row has been created.
HtmlRowPreparedEnables the settings of individual rows to be changed.
ImagesProvides access to the settings that define images for various elements within the GridView.
ImagesEditorsProvides access to the settings that define images displayed within the GridView’s editors.
ImagesFilterControlProvides access to the settings that define images displayed within the Filter Builder. Inherited from GridSettingsBase.
InitEnables you to perform custom actions when an extension is initialized. Inherited from SettingsBase.
InitNewRowEnables you to initialize added rows.
KeyboardSupportGets or sets a value that specifies whether keyboard navigation is available within the GridView extension.
KeyFieldNameGets or sets the name of the data source key field. Inherited from GridSettingsBase.
NameSpecifies the unique identifier name for the extension. Inherited from SettingsBase.
PageIndexChangedObsolete. Enables you to perform custom actions when the selected page has been changed.
PreRenderAllows custom processing to be implemented before the extension is rendered to the page. Inherited from SettingsBase.
PreviewEncodeHtmlGets or sets whether to encode preview row content.
PreviewFieldNameGets or sets the name of the data source field whose values are displayed within the preview rows.
ProcessColumnAutoFilterEnables you to apply custom filter criteria.
ProcessOnClickRowFilterEnables you to apply custom filter criteria when the filter row is in the OnClick mode.
RightToLeftSpecifies whether to apply right-to-left representation to the extension. Inherited from GridSettingsBase.
SearchPanelEditorCreateEnables you to replace the default search panel editor with a custom one.
SearchPanelEditorInitializeEnables you to customize the properties of an editor displayed within the search panel.
SettingsProvides access to the GridView’s display options.
SettingsAdaptivityProvides access to the grid layout adaptivity settings.
SettingsBehaviorProvides access to the GridView’s behavior settings.
SettingsCommandButtonProvides access to the settings of the GridView’s command buttons.
SettingsContextMenuProvides access to the GridView’s context menu settings.
SettingsCookiesProvides access to the extension’s cookie settings.
SettingsCustomizationDialogProvides access to the Customization Dialog’s settings.
SettingsCustomizationWindowObsolete. Provides access to the Customization Window‘s settings.
SettingsDataSecurityProvides access to the GridView’s security settings that allow you to disable data modification operations (edit, insert, delete).
SettingsDetailProvides access to the GridView’s master-detail options.
SettingsEditingProvides access to the GridView ‘s edit settings.
SettingsExportProvides access to the GridView’s export settings.
SettingsFilterControlProvides access to the filter control’s settings.
SettingsLoadingPanelProvides access to the loading panel’s settings.
SettingsPagerProvides access to the pager‘s settings.
SettingsPopupProvides access to the settings of different grid popup elements.
SettingsResizingProvides access to the GridView’s resizing settings.
SettingsSearchPanelProvides access to the search panel’s settings.
SettingsTextProvides access to the GridView’s text settings.
SkinIDGets or sets the skin to apply to the control. Inherited from SettingsBase.
StyleGets a collection of all cascading style sheet (CSS) properties applied to an extension. Inherited from SettingsBase.
StylesProvides access to the style settings that control the appearance of the extension’s visual elements.
StylesContextMenuProvides access to the style settings that control the appearance of the context menu displayed within the GridView.
StylesEditorsProvides access to style settings used to paint the GridView’s editors.
StylesFilterControlProvides access to the style settings defining the appearance of the Filter Builder. Inherited from GridSettingsBase.
StylesPagerProvides access to the style settings that control the appearance of the Pager displayed within the GridView.
StylesPopupProvides access to the style settings defining the appearance of different popup elements within a grid.
StylesToolbarProvides access to the style settings that define the appearance of toolbars. Inherited from GridSettingsBase.
SubstituteFilterAllows you to replace a filter applied with another filter. Inherited from GridSettingsBase.
SummaryDisplayTextEnables custom display text to be provided for any summary value.
SummaryTextGets or sets a value that specifies the table summary attribute.
TabIndexGets or sets the tab index of the control element of the web page. Inherited from SettingsBase.
ThemeGets or sets the name of the theme to be applied to the extension. Inherited from SettingsBase.
ToolbarItemClickEnables you to perform custom actions when a toolbar item has been clicked.
ToolbarsGets the collection of toolbars in the GridViewSettings control.
ToolTipGets or sets a UI element’s tooltip text. Inherited from SettingsBase.
TotalSummaryProvides access to total summary items.
WidthGets or sets the width of the extension. Inherited from SettingsBase.

See Also

GridViewSettings Class

GridViewSettings Members

DevExpress.Web.Mvc Namespace