Name:
AllowChangingItemsPerPage
Type:
bool
Default:
True
Description:
When true, the user can change the number of items displayed per page.
Name:
AllowEdit
Type:
bool
Default:
False
Description:
Should the option be available for the user to turn on inline editing for the grid.
Name:
AllowEditOnRowDoubleClick
Type:
bool
Default:
True
Description:
If a button is present that has the set to true,
and this is set to 'true', then the event delegate will be called for the record.
Name:
AllowSearch
Type:
bool
Default:
True
Description:
Should the user be allowed to search the grid.
Name:
BorderVisible
Type:
bool
Default:
True
Description:
Controls whether a visible border is rendered around the grid.
Name:
Buttons
Type:
RenderFragment?
Description:
Optional render fragment used to define the button toolbar displayed above the grid.
Name:
CustomViewDefinitions
Type:
List<GridViewDefinition>?
Description:
Custom views to display in the dropdown.
Name:
DefaultItemsPerPage
Type:
int
Default:
50
Description:
Default number of records to load on a page.
Name:
DefaultViewId
Type:
Guid?
Description:
Id of the view that the grid should display upon initial load.
Name:
Editable
Type:
bool
Default:
False
Description:
Is inline editing turned on for the grid.
Name:
FullSize
Type:
bool
Default:
False
Description:
When true, the grid expands to fill all available vertical space instead of using a fixed minimum height.
Name:
HidePaging
Type:
bool
Default:
False
Description:
Force the page size and paging components to be hidden.
Only do this when the number of items is known and the page size is set to something greater than the item count.
Name:
IsDirty
Type:
bool
Default:
False
Description:
Indicates whether the grid has unsaved create, update, or delete operations pending.
Name:
MaxHeight
Type:
string?
Description:
Max Height that the grid control should expand to.
Name:
MinHeight
Type:
string?
Default:
250px
Description:
Minimum height that the grid control should occupy.
Name:
Mode
Type:
GridMode
Default:
RecordSelection
Description:
Sets the behavioural mode of the grid, such as default interaction or record-selection mode.
Name:
OnBeforeQuery
Type:
Func<FetchXMLBuilder, Task<FetchXMLBuilder>>?
Description:
Optional callback to apply additional filter criteria to the FetchXML query before it is executed.
Name:
PageSizes
Type:
IEnumerable<int>
Description:
Collection of available page sizes for the grid.
Name:
PagingMode
Type:
GridPagingMode
Default:
Paged
Description:
Determines whether the grid uses traditional paging or infinite-scroll virtualisation.
Name:
Record
Type:
TableRecord?
Description:
The parent record supplied via a cascading parameter; related records are filtered by this record's identity.
Name:
RelationshipName
Type:
string
Description:
The schema name of the relationship used to filter and display related records in this sub-grid.
Name:
SelectedRecords
Type:
IEnumerable<TableRecord>
Description:
Records that are currently selected in the Grid.
Name:
SelectedViewQueryParameter
Type:
string?
Description:
Query parameter to persist the selected view to.
Name:
SelectFromEntireRow
Type:
bool
Default:
True
Description:
When true, clicking anywhere on a row selects it; when false, only the checkbox selects the row.
Name:
SelectMode
Type:
DataGridSelectMode
Default:
Multiple
Description:
Controls whether the grid allows single or multiple row selection.
Name:
Title
Type:
string?
Description:
Name to display when the view dropdown is not displayed.
Name:
ViewIds
Type:
IEnumerable<Guid>?
Description:
List of id's of the views that the grid should limit to in the view dropdown.
Name:
ViewSort
Type:
ViewSort
Default:
NameAscending
Description:
Sort order of the views in the view dropdown.