Namespace Syncfusion.Blazor.Grids

Classes

ActionEventArgs<T>

Provides information about the OnActionBegin event when grid action start's. Also, provides information about the OnActionComplete event when grid action completed. Provides information about the OnActionBegin event when a grid action begins and the OnActionComplete event when a grid action is completed.

AggregateTemplateContext

Class that defines template context detail of FooterTemplate, GroupFooterTemplate and GroupCaptionTemplate. FooterTemplate GroupCaptionTemplate GroupFooterTemplate

AutoCompleteFilterParams

Provides filter settings to customize the SfAutoComplete<TValue, TItem> component used in the filter menu and the Excel-like filter dialogs of the Grid.

BatchChanges<T>

Defines the batch changes.

BeforeAutoFillCellEventArgs<T>

Provides information about the BeforeAutoFillCell event.

BeforeAutoFillEventArgs

Provides information about the BeforeAutoFill event.

BeforeBatchAddArgs<T>

Provides information about an OnBatchAdd event.

BeforeBatchCancelArgs<T>

Defines the event argument of batch cancel action. Provides information about an OnBatchCancel event.

BeforeBatchDeleteArgs<T>

Provides information about an OnBatchDelete event.

BeforeBatchSaveArgs<T>

Provides information about an OnBatchSave event.

BeforeCellPasteEventArgs<T>

Provides information about the BeforeCellPaste event.

BeforeCopyPasteEventArgs

Provides information about the BeforeCopyPaste event.

BeforeDataBoundArgs<T>

Provides information about an OnDataBound event.

BeginEditArgs<T>

Provides information about the OnBeginEdit event.

BooleanEditCellParams

Defines edit params for in-built checkbox.

Border

Class that defines the cell border details.

CaptionTemplateContext

Class that defines template context detail of CaptionTemplate. CaptionTemplate

CellDOM

Handles cell and row customization.

CellDeselectEventArgs<T>

Provides information about the CellDeselecting event, and CellDeselected event.

CellEditArgs<T>

Provides information about the OnCellEdit event.

CellSaveArgs<T>

Provides information about the OnCellSave event.

CellSavedArgs<T>

Provides information about the CellSaved event.

CellSelectEventArgs<T>

Provides information about the CellSelected event.

CellSelectingEventArgs<T>

Provides information about an CellSelecting event.

CheckboxFilterSearchingEventArgs

Provides information about the CheckboxFilterSearching event.

ColumnChooserEventArgs

Provides information about an BeforeOpenColumnChooser event.

ColumnChooserFooterTemplateContext

Defines members of the ColumnChooser FooterTemplate context.

ColumnChooserTemplateContext

Defines members of the column chooser template context.

ColumnMenuClickEventArgs

Provides information about an ColumnMenuItemClicked event.

ColumnMenuItemModel

Class that defines column menu item model.

ColumnMenuOpenEventArgs

Provides information about an OnColumnMenuOpen event.

ColumnReorderedEventArgs

Provides information about the ColumnReordered event.

ColumnReorderingEventArgs

Provides information about the ColumnReordering event.

ColumnVisibilityChangedEventArgs

Provides information about the ColumnVisibilityChanged event.

ColumnVisibilityChangingEventArgs

Provides information about the ColumnVisibilityChanging event.

CommandButtonOptions

Defines options for command buttons.

CommandClickEventArgs<T>

Provides information about an CommandClicked event.

CommandModel

Define options for command buttons.

ContextMenuClickEventArgs<T>

Provides information about an ContextMenuItemClicked event.

ContextMenuItemModel

Defines the context menu item model.

ContextMenuOpenEventArgs<T>

Provides information about an ContextMenuOpen event.

DateEditCellParams

Defines edit params for in-built datepicker.

DateFilterParams

Provides filter settings to customize the SfDatePicker<TValue> component used in the filter menu and the Excel-like filter dialogs of the Grid.

DateTimeEditCellParams<T>

Provides edit params for customizing the DateTimePicker component during cell editing.

DateTimeFilterParams

Provides filter settings to customize the SfDateTimePicker<TValue> component used in the filter menu and the Excel-like filter dialogs of the Grid.

DetailDataBoundEventArgs<T>

Provides information about an DetailDataBound event.

DetailTemplateCell

DetailTemplateRow

DetailTemplateSettings

DetailsCollapsedEventArgs<T>

Provides information about an DetailsCollapsed event.

DetailsCollapsingEventArgs<T>

Provides information about an DetailsCollapsing event.

DetailsExpandedEventArgs<T>

Provides information about an DetailsExpanded event.

DetailsExpandingEventArgs<T>

Provides information about an DetailsExpanding event.

DialogSettings

Defines model for Dialog.

Dimension

Defines the dimension of selected target.

DropDownEditCellParams

Defines edit params for in-built dropdownlist.

DropDownFilterParams

Provides filter settings to customize the SfDropDownList<TValue, TItem> component used in the filter menu and the Excel-like filter dialogs of the Grid.

EditCanceledEventArgs<T>

Provides information about the EditCanceled event.

EditCancelingEventArgs<T>

Provides information about the EditCanceling event.

EmptyRecordTemplateContext

Class that defines template context detail of EmptyRecordTemplate. EmptyRecordTemplate

ExcelAggregateEventArgs

Provides information about an ExcelAggregateTemplateInfo event.

ExcelCaptionTemplateArgs

Provides information about an ExcelGroupCaptionTemplateInfo event.

ExcelCell

Defines the cell of exported excel.

ExcelDetailTemplateCell

ExcelDetailTemplateEventArgs<T>

ExcelDetailTemplateRow

ExcelDetailTemplateRowSettings

ExcelExportProperties

Defines the options for customizing the excel document during export.

ExcelFooter

Defines the excel footer option class.

ExcelHeader

Defines the excel header options.

ExcelHeaderQueryCellInfoEventArgs

Provides information about an ExcelHeaderQueryCellInfoEvent event.

ExcelQueryCellInfoEventArgs<T>

Provides information about an ExcelQueryCellInfoEvent event.

ExcelRow

Defines excel export row of grid.

ExcelStyle

Defines option for styling excel cell/row.

ExcelTheme

Defines options for customizing theme during excel export.

FailureEventArgs

Provides information about an OnActionFailure event.

FilterDialogOpenedEventArgs

Provides information about the FilterDialogOpened event.

FilterDialogOpeningEventArgs

Provides information about the FilterDialogOpening event.

FilterItemTemplateContext

Defines the context details of the FilterItemTemplate of checkbox and excel filter.

FilterSettings

Defines the filter param class which provides column level filter operator and read method to get data from Filter bar template.

FilterUI

Defines the filter UI option that can be used to get filter menu details.

FilteredEventArgs

Provides information about the Filtered event.

FilteringEventArgs

Provides information about the Filtering event.

FreezeLineMovedEventArgs

Provides information about FreezeLineMoved event callback.

FreezeLineMovingEventArgs

Provides information about FreezeLineMoving event callback.

GridAggregate

Configures grid aggregate.

GridAggregateColumn

Configures grid aggregate column.

GridAggregateColumns

Configures grid aggregate columms.

GridAggregates

Configures grid aggregates.

GridColumn

Configures grid columm.

GridColumnChooserItem

GridColumnChooserItemGroup

GridColumnChooserSettings

Configures grid column chooser settings.

GridColumns

Configures grid columns.

GridCommandColumn

Configures grid command column.

GridCommandColumns

Configures grid command columns.

GridEditSettings

Configures grid edit settings.

GridEventBaseArgs

GridEvents<TValue>

Configures grid events.

GridFilterColumn

Configures grid filter column.

GridFilterColumns

Configures grid filter columns.

GridFilterSettings

Configures grid filtering.

GridForeignColumn<TValue>

GridGroupSettings

Configures grid grouping.

GridInfiniteScrollSettings

Configures grid infinite scrolling.

GridKeySettings

Configures keyboard navigation for grid.

GridPageChangedEventArgs

Provides information about the PageChanged event.

GridPageChangingEventArgs

Provides information about the PageChanging event.

GridPageSettings

Configures grid paging.

GridRowDropSettings

Configures grid row drag and drop.

GridSearchSettings

Configures grid searching.

GridSelectionSettings

Configures grid selection.

GridSortColumn

Configures grid sort column.

GridSortColumns

Configures grid sort columns.

GridSortSettings

Configures grid sorting.

GridTemplates

Configures grid templates.

GridTextWrapSettings

Configures grid text wrapping.

GroupedEventArgs

Provides information about the Grouped event.

GroupingEventArgs

Provides information about the Grouping event.

HeaderCellInfoEventArgs

Provides information about the HeaderCellInfo event.

Hyperlink

Defines hyper link options for exporting.

NumericEditCellParams

Defines edit params for in-build numerictextbox.

NumericFilterParams

Provides filter settings to customize the SfNumericTextBox<TValue> component used in the filter menu and the Excel-like filter dialogs of the Grid.

OnRowEditStartEventArgs

Provides information about the OnRowEditStart event.

ParentRowInfo<T>

PdfAggregateEventArgs

Provides information about an PdfAggregateTemplateInfo event.

PdfBorder

Defines pdf cell border options.

PdfCaptionTemplateArgs

Provides information about an PdfGroupCaptionTemplateInfo event.

PdfContentStyle

Defines pdf cell style options.

PdfDetailTemplateCell

PdfDetailTemplateEventArgs<T>

PdfDetailTemplateRow

PdfDetailTemplateRowSettings

PdfElementStyle

Represents a class that provides style configuration for elements in a PDF document.

PdfExportProperties

Defines pdf export customization options.

PdfExportPropertiesBase

Represents the PDF export customization options for the PDF document.

PdfFooter

Defines pdf footer options.

PdfGridFont

Defines pdf grid font options.

PdfHeader

Defines pdf header options.

PdfHeaderFooterContent

Defines pdf header footer options.

PdfHeaderFooterElement

Represents class that provides Pdf header or footer customization options for the Pdf document.

PdfHeaderQueryCellInfoEventArgs

Provides information about an PdfHeaderQueryCellInfoEvent event.

PdfPoints

Defines pdf points.

PdfPosition

Defines pdf position.

PdfQueryCellInfoEventArgs<T>

Provides information about an PdfQueryCellInfoEvent event.

PdfSize

Defines pdf size.

PdfTextStyle

Represents class that provides style configuration of text content in the exported Pdf.

PdfTheme

Defines pdf export theme.

PdfThemeStyle

Defines pdf export theme.

PredicateModel

Defines predicate model class for generating filter criteria.

PredicateModel<T>

Defines predicate model class for generating filter criteria.

QueryCellInfoEventArgs<T>

Provides information about an QueryCellInfo event.

RecordClickEventArgs<T>

Provides information about an OnRecordClick event.

RecordDoubleClickEventArgs<T>

Provides information about an OnRecordDoubleClick event.

RefreshAggregate<TValue>

ResizeArgs

Provides information about an OnResizeStart event.

RowCreatedEventArgs<T>

Provides information about the RowCreated event.

RowCreatingEventArgs<T>

Provides information about the RowCreating event.

RowDataBoundEventArgs<T>

Provides information about an RowDataBound event.

RowDeletedEventArgs<T>

Provides information about the RowDeleted event.

RowDeletingEventArgs<T>

Provides information about the RowDeleting event.

RowDeselectEventArgs<T>

Provides information about the RowDeselecting event. Also, provides information about the RowDeselected event.

RowDragSelectedEventArgs<T>

Provides information about the RowDragSelectionCompleting and RowDragSelectionCompleted events, which occur when drag based selection ends in the Grid.

RowDragSelectionEventArgs<T>

Provides information about the RowDragSelectionStarting event, which occurs when drag based selection of rows or cells is initiated in the Grid.

RowDragStartingEventArgs<T>

Provides information about the RowDragStarting event.

RowDroppedEventArgs<T>

Provides information about the RowDropped event.

RowDroppingEventArgs<T>

Provides information about the RowDropping event.

RowEditedEventArgs<T>

Provides information about the RowEdited event.

RowEditingEventArgs<T>

Provides information about the RowEditing event.

RowInfo<T>

Defines the row info such as data, row index and cell index.

RowSelectEventArgs<T>

Provides information about the RowSelected event.

RowSelectingEventArgs<T>

Provides information about the RowSelecting event.

RowUpdatedEventArgs<T>

Provides information about the RowUpdated event.

RowUpdatingEventArgs<T>

Provides information about the RowUpdating event.

SearchedEventArgs

Provides information about the Searched event.

SearchingEventArgs

Provides information about the Searching event.

SfGrid<TValue>

Blazor Grid component displays tabular data and it has in-built support for various data binding, editing, sorting and filtering.

SortedEventArgs

Provides information about the Sorted event.

SortingEventArgs

Provides information about the Sorting event.

StringEditCellParams

Defines edit params for in-built textbox.

TimeEditCellParams

A class which holds edit setting to customize SfTimePicker<TValue> component while editing in grid.

TimeFilterParams

Provides filter settings to customize the SfTimePicker<TValue> component used in the filter menu and the Excel-like filter dialogs of the Grid.

TooltipTemplateContext

Provides contextual information for customizing tooltip content in the Blazor DataGrid via the TooltipTemplate.

ValidationRules

Defines the column validation rules.

ValidatorTemplateContext

Defines members of validator template context object.

Structs

SortColumn

Defines the Sort Column.

Interfaces

IEditorSettings

Interface for editor customization.

IFilterOperator

Represents a custom filter operator that can be used in the Menu filter.

IFilterSettings

Interface for defining filter parameters used to customize filter components in both the Filter Menu dialog and Excel-like filter dialog of the Grid.

IGridColumn

Enums

Action

Defines Actions of the Grid.

AdaptiveMode

AdaptiveMode Defines the mode of AdaptiveUI layout. The available Adaptive modes are:

  • Both Default.Render the Adaptive Layout for both mobile and desktop.
  • MobileRender the Adaptive Layouts only on the smaller devices.
  • DesktopRender the Adaptive Layouts only on the desktop.

AggregateTemplateType

Specifies the template type used for rendering aggregate cells in a grid during exporting. This property allows differentiation between cells in the group caption, grid footer, or group footer.

  • GroupCaptionIndicates that the aggregate cell is part of the group caption.
  • FooterIndicates that the aggregate cell is part of the grid footer.
  • GroupFooterIndicates that the aggregate cell is part of the group footer.

AggregateType

Defines the aggregate types.

BorderLineStyle

Defines border line style.

CellSelectionMode

Defines mode of cell selection.

  • FlowDefault. Selects the range of cells between start index and end index that also includes the other cells of the selected rows..
  • BoxSelects the range of cells within the start and end column indexes that includes in between cells of rows within the range

CheckboxSelectionType

Defines type of checkbox selection. This helps to reset selection when CheckboxOnly property is enabled.

  • DefaultDefault. In this mode, user can select multiple rows by clicking rows one by one.
  • ResetOnRowClickIn ResetOnRowClick mode, on clicking a row it will reset previously selected row and also multiple rows can be selected by using CTRL or SHIFT key.

ClipMode

Defines the cell content's overflow mode. The available modes are.

  • ClipTruncates the cell content when it overflows its area.
  • EllipsisDisplays ellipsis when the cell content overflows its area.
  • EllipsisWithTooltipDisplays ellipsis when the cell content overflows its area also it will display tooltip while hover on ellipsis applied cell.

ColumnQueryModeType

ColumnQueryMode provides options to retrive data from the datasource.

  • AllIt retrives whole data source
  • SchemaRetrives data for all the defined columns in grid from the data source.
  • ExcludeHiddenRetrives data only for visible columns of grid from the data source.

ColumnType

Specifies the column type of the GridColumn, denoting the type of data it displays.

  • StringA string type column.
  • NumberA number type column. Primitive types such as int, int?, floar, double, decimal etc. are consider as number type column.
  • IntegerA integer type column.
  • DoubleA double type column.
  • LongA Long type column.
  • DecimalA Decimal type column.
  • BooleanA boolean type column.
  • DateA date type column. Primitive types such as datetime and datetimeoffset are consider as date type column.
  • DateTimeA datetime type column. Primitive types such as datetime and datetimeoffset are consider as date type column.
  • CheckBoxEnables checkbox column for selection purpose. No data operation is assosiated with this column.

CommandButtonType

Defines the Command Buttons type.

  • NoneDefault. A command button with no default action. Use this for custom command actions.
  • EditA edit command button that edit current record.
  • DeleteA delete command button that delete current record.
  • SaveA save command button that saves the current edited record.
  • CancelA cancel command button that cancels the edit state.

ContentType

Defines the content type.

ContextMenuTarget

EditMode

Defines modes of editing.

  • NormalDefault. Editing is done in an inline form. Edit form is rendered inline as one of the table rows.
  • DialogEditing is done in a Dialog/Pop component.
  • BatchEnables cell editing. Multiple cells can be edited, added or deleted and saved.

EditType

Specifies the edit type of the GridColumn. It is used to render the specified editor component in the grid edit form to edit the corresponding cell value.

  • DefaultEditDefault. Text box is used for editing.
  • DropDownEditDropDownList is used for editing.
  • BooleanEditCheckbox is used for editing.
  • DatePickerEditDate picker is used for editing.
  • DateTimePickerEditDatetime picker is used for editing.
  • NumericEditNumeric textbox is used for editing.

ExcelDetailRowMode

Defines the mode for exporting the detail rows to Excel file format

ExcelHorizontalAlign

Defines Excel horizontal alignment.

ExcelVerticalAlign

Defines Excel vertical alignment.

ExportType

Defines Export Type.

FilterBarMode

Specified the Filter bar mode.

  • OnEnterInitiate filter operation after Enter key is pressed.
  • ImmediateInitiate filter operation after certain time interval. By default time interval is 1500ms.

FilterType

Defines types of Filter.

  • FilterBarDefault. Specifies the filter type as filter bar.
  • MenuSpecifies the filter type as menu.
  • CheckBoxSpecifies the filter type as check box.
  • ExcelSpecifies the filter type as excel.

FreezeDirection

Defines direction of freeze column.

  • NoneColumn will not freeze.
  • LeftFreeze the column at left side.
  • RightFreeze the column at right side.
  • FixedFreeze the column at current position.

GridLine

Defines modes of GridLine, They are.

  • BothDisplays both the horizontal and vertical grid lines.
  • NoneNo grid lines are displayed.
  • HorizontalDisplays the horizontal grid lines only.
  • VerticalDisplays grid lines based on the theme.

HierarchyGridPrintMode

Hierarchy Grid Print modes are.

  • ExpandedPrints the master grid with expanded child grids.
  • AllPrints the master grid with all the child grids.
  • NonePrints the master grid alone.

NewRowPosition

Defines add new row position.

  • TopDefault. Add form is placed at the first row of the grid.
  • BottomAdd form is placed at the last row of the grid

PageOrientation

Defines the PDF page orientation.

PdfDashStyle

Defines the PDF dash style.

PdfDetailRowMode

Defines the mode for exporting the detail rows to the PDF file format.

PdfHorizontalAlign

Defines PDF horizontal alignment.

PdfPageNumberType

Defines the pdf page number type.

PdfPageSize

Defined the PDF page size.

PdfVerticalAlign

Defines PDF vertical alignment.

PrintMode

Print mode options are.

  • AllPagesPrint all pages records of the Grid.
  • CurrentPagePrint current page records of the Grid.

RowDirection

Defines data row rendering direction of the grid that helps to view the grid in a compact way which is suitable for small screen.

  • HorizontalDisplay the data rows in Horizontal direction.
  • VerticalDisplay the data rows in Vertical direction..

SelectionMode

Defines modes of Selection.

  • RowDefault. Row selection is enabled
  • CellCell selection is enabled.
  • BothBoth Row and Cell selection is enabled.

SelectionType

Defines types of Selection.

  • SingleDefault. Allows user to select a row or cell.
  • MultipleAllows user to select a multiple rows or cells.

SortDirection

Defines the sort direction.

  • AscendingDefault. Sorts records in ascending order.
  • DescendingSorts records in descending order.

TextAlign

Defines alignments of text.

  • LeftDefault. Text is left aligned.
  • RightText is right aligned.
  • CenterText is centered.
  • JustifyText is justified.

WrapMode

Defines the wrap mode.

  • BothDefault. Wraps both header and content.
  • HeaderWraps header alone.
  • ContentWraps content alone.