Blazor

Code Examples Upgrade Guide User Guide Demos Support Forums Download
  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Namespace Syncfusion.Blazor.Grids

    Show / Hide Table of Contents

    Namespace Syncfusion.Blazor.Grids

    Classes

    Action

    Defines Actions of the Grid.

    ActionEventArgs<T>

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

    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.
    AggregateTemplateContext

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

    AggregateType

    Defines the aggregate types.

    BatchChanges<T>

    Defines the batch changes.

    BeforeAutoFillCellEventArgs<T>

    Provides information about the BeforeAutoFillCell event.

    BeforeAutoFillEventArgs

    Provides information about the BeforeAutoFill event.

    BeforeBatchAddArgs<T>

    Defines the event argument of before batch add action.

    BeforeBatchCancelArgs<T>

    Defines the event argument of batch cancel action.

    BeforeBatchDeleteArgs<T>

    Defines the event argument of before batch delete action.

    BeforeBatchSaveArgs<T>

    Defines the event argument of before batch save action.

    BeforeCellPasteEventArgs<T>

    Provides information about the BeforeCellPaste event.

    BeforeCopyPasteEventArgs

    Provides information about the BeforeCopyPaste event.

    BeforeDataBoundArgs<T>

    Defines the event argument of before data bound action.

    BeginEditArgs<T>

    Defines the event argument of begin edit action.

    BooleanEditCellParams

    Defines edit params for in-built checkbox.

    Border

    Class that defines the cell border details.

    BorderLineStyle

    Defines border line style.

    CaptionTemplateContext

    Class that defines template context detail of CaptionTemplate. CaptionTemplate

    CellDeselectEventArgs<T>

    Class that defines event argument of the cell deselection operation.

    CellDOM

    Handles cell and row customization.

    CellEditArgs<T>

    Class that defines event argument of the cell edit.

    CellSaveArgs<T>

    Class that defines event argument of the cell save operation.

    CellSelectEventArgs<T>

    Class that defines event argument of the cell selection operation.

    CellSelectingEventArgs<T>

    Class that defines event argument of the cell selection operation.

    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.
    ColumnChooserEventArgs

    Defines the event arguments of the column chooser actions.

    ColumnChooserFooterTemplateContext

    Defines members of the ColumnChooser FooterTemplate context.

    ColumnChooserTemplateContext

    Defines members of the column chooser template context.

    ColumnMenuClickEventArgs

    Class that defines event argument of the column menu item click.

    ColumnMenuItemModel

    Class that defines column menu item model.

    ColumnMenuOpenEventArgs

    Class that defines event argument of the column menu open.

    ColumnModel

    Defines the Column model.

    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

    Defines the Column Type.

    • StringA string type column.
    • NumberA number type column. Primitive types such as int, int?, floar, double, decimal etc. are consider as number 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.
    CommandButtonOptions

    Defines options for command buttons.

    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.
    CommandClickEventArgs<T>

    Class that defines event argument of the command button click.

    CommandModel

    Define options for command buttons.

    ContentType

    Defines the content type.

    ContextMenuClickEventArgs<T>

    Defines the context menu click event argument.

    ContextMenuItemModel

    Defines the context menu item model.

    ContextMenuOpenEventArgs<T>

    Class that defines event argument of the context menu open.

    ContextMenuTarget
    DateEditCellParams

    Defines edit params for in-built datepicker.

    DetailDataBoundEventArgs<T>

    Defines thee event arguments of detail template open.

    DetailsCollapsedEventArgs<T>

    Defines the event arguments of detail template after the row is collapsed.

    DetailsCollapsingEventArgs<T>

    Defines the event arguments of detail template when row is clicked to collapse.

    DetailsExpandedEventArgs<T>

    Defines the event arguments of detail template after the row is expanded.

    DetailsExpandingEventArgs<T>

    Defines the event arguments of detail template when row is clicked to expand.

    DialogSettings

    Defines model for Dialog.

    Dimension

    Defines the dimension of selected target.

    DropDownEditCellParams

    Defines edit params for in-built dropdownlist.

    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

    Defines the Edit Type of the column.

    • 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.
    EmptyRecordTemplateContext

    Class that defines template context detail of EmptyRecordTemplate. EmptyRecordTemplate

    ExcelAggregateEventArgs

    Defines event argument of excel aggregate event.

    ExcelCaptionTemplateArgs

    Defines event argument of group caption template event.

    ExcelCell

    Defines the cell of exported excel.

    ExcelExportCompleteArgs

    Defines the event argument of excel export complete.

    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

    Defines event argument of excel header query cell event.

    ExcelHorizontalAlign

    Defines Excel horizontal alignment.

    ExcelQueryCellInfoEventArgs<T>

    Defines event argument of excel query cell 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.

    ExcelVerticalAlign

    Defines Excel vertical alignment.

    ExportGroupCaptionEventArgs

    Defines event argument of excel group caption event.

    ExportType

    Defines Export Type.

    FailureEventArgs

    Defines event argument of grid action failure event.

    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.
    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.

    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.
    FilterUI

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

    FreezeDirection

    Defines direction of freeze column.

    • NoneColumn will not freeze.
    • LeftFreeze the column at left side.
    • RightFreeze the column at right side.
    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.

    GridKeySettings

    Configures keyboard navigation for grid.

    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.
    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.

    HeaderCellInfoEventArgs

    Defines event argument of header query cell event.

    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.
    Hyperlink

    Defines hyper link options for exporting.

    MultipleExport

    Defines multi-export options.

    MultipleExportType

    Defines Multiple Export Type.

    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
    NumericEditCellParams

    Defines edit params for in-build numerictextbox.

    PageOrientation

    Defines the PDF page orientation.

    PagerModel

    Defines member of the pager.

    PdfAggregateEventArgs

    Defines event argument of pdf aggregate event.

    PdfBorder

    Defines pdf cell border options.

    PdfCaptionTemplateArgs

    Defines event argument of group caption template event.

    PdfContentStyle

    Defines pdf cell style options.

    PdfDashStyle

    Defines the PDF dash style.

    PdfExportCompleteArgs

    Defines pdf export completion event arguments.

    PdfExportProperties

    Defines pdf export customization options.

    PdfFooter

    Defines pdf footer options.

    PdfGridFont

    Defines pdf grid font options.

    PdfHeader

    Defines pdf header options.

    PdfHeaderFooterContent

    Defines pdf header footer options.

    PdfHeaderQueryCellInfoEventArgs

    Defines pdf header query cell event arguments.

    PdfHorizontalAlign

    Defines PDF horizontal alignment.

    PdfPageNumberType

    Defines the pdf page number type.

    PdfPageSize

    Defined the PDF page size.

    PdfPoints

    Defines pdf points.

    PdfPosition

    Defines pdf position.

    PdfQueryCellInfoEventArgs<T>

    Defines pdf query cell event argument.

    PdfSize

    Defines pdf size.

    PdfStyle

    Defines pdf cell style.

    PdfTheme

    Defines pdf export theme.

    PdfThemeStyle

    Defines pdf export theme.

    PdfVerticalAlign

    Defines PDF vertical alignment.

    PredicateModel

    Defines predicate model class for generating filter criteria.

    PredicateModel<T>

    Defines predicate model class for generating filter criteria.

    PrintMode

    Print mode options are.

    • AllPagesPrint all pages records of the Grid.
    • CurrentPagePrint current page records of the Grid.
    QueryCellInfoEventArgs<T>

    Defines event argument of query cell event.

    RecordClickEventArgs<T>

    Defines the event arguments of record click event.

    RecordDoubleClickEventArgs<T>

    Defines the event arguments of record double click event.

    RefreshAggregate<TValue>
    ResizeArgs

    Defines the event arguments of resize action.

    RowDataBoundEventArgs<T>

    Defines the event arguments of row databound.

    RowDeselectEventArgs<T>

    Defines the event arguments of row deselect.

    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..
    RowDragEventArgs<T>

    Provides information about the OnRowDragStart event.

    RowDragStartingEventArgs<T>

    Provides information about the RowDragStarting event.

    RowDroppedEventArgs<T>

    Provides information about the RowDropped event.

    RowDroppingEventArgs<T>

    Provides information about the RowDropping event.

    RowInfo<T>

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

    RowSelectEventArgs<T>

    Defines the event arguments of row select event.

    RowSelectingEventArgs<T>

    Defines the event arguments of row selecting event.

    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.
    SfGrid<TValue>

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

    SortColumn

    Defines the Sort Column.

    SortDirection

    Defines the sort direction.

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

    Defines edit params for in-built textbox.

    TextAlign

    Defines alignments of text.

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

    Defines the column validation rules.

    ValidatorTemplateContext

    Defines members of validator template context object.

    WrapMode

    Defines the wrap mode.

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

    Interfaces

    IEditorSettings

    Interface for editor customization.

    IGridColumn
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved