WebGridLayoutSet Properties
VirtualLoadMode | Description Gets the VirtualLoadMode property value. ValueType string Default Value "Default" |
AllowContextMenu | Description Allows or disallows context menu for the grid. ValueType boolean Default Value true |
Culture | Description Specifies the culture settings for current WebGrid instance. ValueType string Default Value "Default" |
EditOnClick | Description Gets or sets whether to enter edit mode upon a cell click. ValueType boolean Default Value false |
EditFocusCellStyle | Description The style of the focused cell object. ValueType string Default Value null |
AllowGrouping | Description Enables or disables grouping feature on the client side. ValueType string Default Value "No" |
VirtualPageSize | Description Gets the number of rows to retrieve when PagingMode is set to VirtualLoad. ValueType integer Default Value 50 |
ClientSideEvents | Description Returns ClientEvents object. ValueType object (WebGridClientEvents) Default Value - |
SizeHeightBy | Description Specifies the grid height adjustment when working in AutoHeight mode. ValueType integer Default Value 0 |
SizeWidthBy | Description Specifies the grid width adjustment when working in AutoHeight mode. ValueType integer Default Value 0 |
AllowAddNew | Description Allows or disallows users to add a new row. ValueType string Default Value "No" |
AllowColumnSizing | Description Specifies whether to allow users to resize the column width. ValueType string Default Value "Yes" |
AllowColumnMove | Description Gets the property value that indicates whether column moving is allowed. ValueType string Default Value "No" |
AllowEdit | Description Specifies whether to allow users to edit and modify data. ValueType string Default Value "No" |
AllowDelete | Description Specifies whether to allow users to delete data within the grid. ValueType string Default Value "No" |
AllowFilter | Description Specifies whether to allow users to filter the grid data. ValueType string Default Value "No" |
AllowSelectColumns | Description Specifies whether to allow users to select columns within the grid. ValueType string Default Value "No" |
AllowSorting | Description Specifies whether to allow users to sort columns within the grid. ValueType string Default Value "No" |
AutoWidth | Description Specifies whether WebGrid will automatically calculate its height based on available page height. ValueType boolean Default Value false |
AutoHeight | Description Specifies whether WebGrid will automatically calculate its width based on available page width. ValueType boolean Default Value false |
AlternatingColors | Description Specifies whether to display alternate rows with AlternateRowStyle style. ValueType boolean Default Value true |
CellClickAction | Description Specifies the action when a user clicks on a cell. ValueType string Default Value "RowSelect" |
PagingMode | Description Specifies the paging mode that determines the rows retrieval behavior in WebGrid. ValueType string Default Value "None" |
ColumnHeaders | Description Specifies whether to display column headers. ValueType string Default Value "Yes" |
ColumnFooters | Description Indicates whether to display column footers. ValueType string Default Value "No" |
HeaderClickAction | Description Specifies the action when users click on column's header. ValueType string Default Value "SortSingle" |
GroupByBoxVisible | Description Indicates whether to show group by box. ValueType boolean Default Value false |
GroupByBox | Description Gets or sets the GroupByBoxObject that is used to control the appearance of GroupBox. ValueType object (GroupByBoxObject) Default Value - |
GroupRowInfoFormatDefault | Description Gets or sets the default group row format. ValueType string Default Value "[caption]: [value]" |
RowHeaders | Description Specifies whether to display row headers. ValueType string Default Value "Yes" |
Hierarchical | Description Indicates whether WebGrid is using hierarchical data structure. ValueType boolean Default Value false |
ImageSettings | Description Gets the ImageSettings object which is used to store the images used by WebGrid. ValueType object (WebGridImageSettings) Default Value - |
RowHeaderWidth | Description Gets the width of RowHeader in Unit. ValueType integer Default Value 18 |
RowHeightDefault | Description Gets the default row height in Unit. ValueType string Default Value "20px" |
HideColumnsWhenGrouped | Description Specifies whether the column headers of the grouped columns is hidden. ValueType string Default Value "Yes" |
Grid | Description Gets the grid object that owns this LayoutSet. ValueType object (WebGrid) Default Value - |
StatusBarVisible | Description Specifies whether the status bar is visible. ValueType boolean Default Value true |
ScriptDirectory | Description Specifies the WebGrid client-script files directory. ValueType string Default Value "/CommonLibrary/WebGrid/V4_0_6200/" |
AlwaysShowHelpButton | Description Specifies whether Help button is always shown in WebGrid UI. ValueType boolean Default Value true |
NewRowLostFocusAction | Description Specifies the action to take when the New Row loses its focus after any of its cells has been modified (row marked as dirty). ValueType string Default Value "NeverUpdate" |
RowLostFocusAction | Description Specifies the action to take when a row loses its focus after any of its cells has been modified (row marked as dirty). ValueType string Default Value "AlwaysUpdate" |
TextSettings | Description This property provides a convenient way to change textual settings used in WebGrid. ValueType object (WebGridTextSettings) Default Value - |
AllowExport | Description Indicates whether grid exporting is allowed in UI. ValueType string Default Value "No" |
ChildRowEmptyAction | Description Indicates what action to take if a row's child table is empty. ValueType string Default Value "ShowChildContent" |
CustomFilterString | Description Gets or sets the custom filtering string. ValueType string Default Value - |
ResetNewRowValuesOnError | Description Indicates whether the cell values of NewRow should be cleared if an error occurred during AddRow server event. ValueType boolean Default Value true |
InProgressUIBehavior | Description Specifies the UI behavior when a request is in progress. ValueType string Default Value "DisplayMessageBox" |
ColumnSetHeaders | Description Indicates whether the ColumnSet headers should be visible or not. ValueType string Default Value "Yes" |
RowHeaderStyle | Description Gets the style applied to the row header. ValueType string Default Value - |
TreeLines | Description Specifies whether the tree lines is shown for Hierarchical mode. ValueType Default Value |
ChildTableSpacing | Description Gets or sets the spacing width between each child table at the same level. ValueType integer Default Value 4 |
ShowRefreshButton | Description Specifies whether the grid should display Refresh button in the status bar. ValueType boolean Default Value true |
AutoFitColumns | Description Indicates whether all displayed columns' width should be fitted to grid. ValueType boolean Default Value false |
FilterBarVisible | Description Specifies whether the filter bar would initially be visible. ValueType boolean Default Value true |
ClientVisible | Description Specifies a value indicating grid's visibility on client side. ValueType boolean Default Value true |
AutoColMinWidth | Description The minimum width for WebGridColumn when IsAutoWidth is set to true. ValueType integer Default Value 100 |
PromptBeforeDelete | Description Indicates whether to display a confirmation box before deleting a row. ValueType boolean Default Value false |
ApplyFiltersKey | Description Gets or sets the key used to apply all filters. ValueType string Default Value "ShiftEnter" |
HelpURL | Description Returns the URL of the custom Help document. ValueType string Default Value - |
PersistRowChecker | Description Specifies whether to persist row checker values between Page Postbacks. ValueType boolean Default Value false |