MVCGrid
Header text to display for the current column, if different from ColumnName.
A unique name for this column
Enables sorting on this column
Disables html encoding on the data for the current cell. Turn this off if your ValueExpression or ValueTemplate returns HTML.
Enables filtering on this column
Indicates whether column is visible.
Object to pass to QueryOptions when this column is sorted on. Only specify if different from ColumnName
Gets or sets a value indicating whether the column visibility can be changed.
This is the method that will actually query the data to populate the grid. Use entity framework, a module from you IoC container, direct SQL queries, etc. to get the data. Inside the providee GridContext there is a QueryOptions object which will be populated with the currently requested sorting, paging, and filtering options which you must take into account. See the QueryOptions documentation below. You must return a QueryResult object which takes an enumerable of your type and a count of the total number of records which must be provided if paging is enabled.
Use this to specify a custom css class based on data for the current row
Use this to specify a custom css class based on data for the current row
A prefix to add to all query string parameters for this grid, for when there are more than 1 grids on the same page
Enables data loading when the page is first loaded so that the initial ajax request can be skipped.
Specifies if the data should be loaded as soon as the page loads
Enables paging on the grid
Enables paging on the grid
Enables paging on the grid
Number of items to display on each page
Enables sorting on the grid. Note, sorting must also be enabled on each column where sorting is wanted
Enables sorting on the grid. Note, sorting must also be enabled on each column where sorting is wanted
Enables sorting on the grid. Note, sorting must also be enabled on each column where sorting is wanted
The default column to sort by when no sort is specified
The default order to sort by when no sort is specified
Text to display when there are no results.
Name of function to call before ajax call begins
Name of function to call before ajax call ends
Enables filtering on the grid. Note, filtering must also be enabled on each column where filtering is wanted
Sets the default rendering engine name (which should match a name from the RenderingEngines property) which
will be used when no rendering engine name is specified in the request
Name of the rendering engine.
Adds a rendering engine to the list of configured rendering engines.
A unique name.
The type.
Adds a rendering engine to the list of configured rendering engines.
A unique name.
The type.
Add an arbitrary additional settings
Remove an additional setting
The rendering mode to use for this grid. By default it will use the RenderingEngine rendering mode. If you want to use a custom Razor view to display your grid, change this to Controller
When RenderingMode is set to Controller, this is the path to the razor view to use.
When RenderingMode is set to Controller, this is the path to the container razor view to use.
HTML to display in place of the grid when an error occurs
Add a name to additional query options which are additional parameters that can be passed from client to server side
Names of additional parameters that can be passed from client to server side
Names of page parameters that will be passed from the view
Allows changing of page size from client-side
Sets the maximum of items per page allowed when AllowChangingPageSize is enabled
Indicated the authorization type. Anonymous access is the default.
A unique name for this column
Header text to display for the current column, if different from ColumnName.
Enables sorting on this column
Disables html encoding on the data for the current cell. Turn this off if your ValueExpression or ValueTemplate returns HTML.
This is how to specify the contents of the current cell. If this contains HTML, set HTMLEncode to false
This is how to specify the contents of the current cell. If this contains HTML, set HTMLEncode to false
This is how to specify the contents of the current cell when used in an export file, if different that ValueExpression
This is how to specify the contents of the current cell when used in an export file, if different that ValueExpression
Use this to return a custom css class based on data for the current cell
Use this to return a custom css class based on data for the current cell
Enables filtering on this column
Indicates whether column is visible.
Indicates whether column is visible.
Template for formatting cell value
Template for formatting cell value
Object to pass to QueryOptions when this column is sorted on. Only specify if different from ColumnName
Gets or sets a value indicating whether the column visibility can be changed.
Arbitrary settings for this context
Paging data. Will be null if paging should not be displayed
A prefix to add to all query string parameters for this grid, for when there are more than 1 grids on the same page
Enables data loading when the page is first loaded so that the initial ajax request can be skipped.
Specified if the data should be loaded as soon as the page loads
Enables paging on the grid
Number of items to display on each page
Enables sorting on the grid. Note, sorting must also be enabled on each column where sorting is wanted
The default column to sort by when no sort is specified
The default order to sort by when no sort is specified
Text to display when there are no results.
Name of function to call before ajax call begins
Name of function to call before ajax call ends
Enables filtering on the grid. Note, filtering must also be enabled on each column where filtering is wanted
Arbitrary additional settings
The rendering mode to use for this grid. By default it will use the RenderingEngine rendering mode. If you want to use a custom Razor view to display your grid, change this to Controller
When RenderingMode is set to Controller, this is the path to the razor view to use.
When RenderingMode is set to Controller, this is the path to the container razor view to use.
HTML to display in place of the grid when an error occurs
Names of additional parameters that can be passed from client to server side
Names of page parameters that will be passed from the view
Allows changing of page size from client-side
Sets the maximum of items per page allowed when AllowChangingPageSize is enabled
Indicated the authorization type. Anonymous access is the default.
The list of configured rendering engines availble for this grid
The rendering engines, each with a unique name
The unique rendering engine name to use when none is specified in the request
The default name of the rendering engine.
A unique name for this column
Header text to display for the current column, if different from ColumnName.
Template for formatting cell value
This is how to specify the contents of the current cell. If this contains HTML, set HTMLEncode to false
This is how to specify the contents of the current cell when used in an export file, if different that ValueExpression
Use this to return a custom css class based on data for the current cell
Enables sorting on this column
Disables html encoding on the data for the current cell. Turn this off if your ValueExpression or ValueTemplate returns HTML.
Enables filtering on this column
Indicates whether column is visible.
Object to pass to QueryOptions when this column is sorted on. Only specify if different from ColumnName
Gets or sets a value indicating whether the column visibility can be changed.
This is the method that will actually query the data to populate the grid. Use entity framework, a module from you IoC container, direct SQL queries, etc. to get the data. Inside the providee GridContext there is a QueryOptions object which will be populated with the currently requested sorting, paging, and filtering options which you must take into account. See the QueryOptions documentation below. You must return a QueryResult object which takes an enumerable of your type and a count of the total number of records which must be provided if paging is enabled.
Use this to specify a custom css class based on data for the current row
A prefix to add to all query string parameters for this grid, for when there are more than 1 grids on the same page
Enables data loading when the page is first loaded so that the initial ajax request can be skipped.
Specified if the data should be loaded as soon as the page loads
Enables paging on the grid
Number of items to display on each page
Enables sorting on the grid. Note, sorting must also be enabled on each column where sorting is wanted
The default column to sort by when no sort is specified
The default order to sort by when no sort is specified
Enables filtering on the grid. Note, filtering must also be enabled on each column where filtering is wanted
Text to display when there are no results.
Name of function to call before ajax call begins
Name of function to call before ajax call ends
Arbitrary additional settings
The rendering mode to use for this grid. By default it will use the RenderingEngine rendering mode. If you want to use a custom Razor view to display your grid, change this to Controller
When RenderingMode is set to Controller, this is the path to the razor view to use.
When RenderingMode is set to Controller, this is the path to the container razor view to use.
HTML to display in place of the grid when an error occurs
Names of additional parameters that can be passed from client to server side
Names of page parameters that will be passed from the view
Allows changing of page size from client-side
Sets the maximum of items per page allowed when AllowChangingPageSize is enabled
Indicated the authorization type. Anonymous access is the default.