Enum GridWebMcpToolCommand

Specifies the built-in WebMCP tools and configuration values supported by an SfGrid<TValue> instance.

Namespace: Syncfusion.Blazor.Grids

Assembly: Syncfusion.Blazor.Grids.dll

Syntax

[JsonConverter(typeof(JsonStringEnumConverter))]
public enum GridWebMcpToolCommand

Remarks

Use members of this enumeration with Command to configure, customize, enable, disable, or rename WebMCP tools exposed by the grid.

The None member represents the default unconfigured state and should not be used for a configured tool entry. The Custom member identifies an application-defined tool whose execution is handled through OnWebMcpExecute.

All remaining members represent built-in grid tools. Built-in tool metadata, such as names, descriptions, and input schemas, can be customized through GridWebMcpTool without changing the underlying functionality associated with the command.

The available tools support data retrieval, navigation, sorting, filtering, grouping, selection, editing, exporting, layout management, clipboard operations, state management, and other grid interactions.

Fields

Name	Description
AutoFitColumns	Automatically adjusts column widths to fit their content.
BatchEditWorkflow	Inspects or applies a batch-edit workflow.
ClearCellSelection	Clears the current cell selection without clearing row selection.
ClearFiltering	Removes all active filters from the grid.
ClearGrouping	Removes all grouping applied to the grid.
ClearSelection	Clears the current selection.
ClearSorting	Removes all sorting applied to the grid.
ClearSortingByFields	Removes sorting from the specified columns.
CollapseAllDetailRows	Collapses all detail rows.
CollapseAllGroups	Collapses all grouped rows.
CopyToClipboard	Copies selected rows or cells to the clipboard.
CrudLifecycle	Performs create, update, or delete operations.
Custom	Specifies an application-defined custom tool.
DeleteRow	Deletes a data row by its current-view index.
EditCell	Places a cell into edit mode.
ExcelExport	Exports grid data to an Excel file.
ExpandAllDetailRows	Expands all detail rows.
ExpandAllGroups	Expands all grouped rows.
ExpandCollapseDetailRow	Expands or collapses the detail row associated with a record.
FilterByColumn	Applies filtering to a column.
FindAndHighlight	Finds matching content and highlights the results.
FocusGrid	Moves focus to the grid.
GetCellValue	Retrieves the formatted value of a cell in the current view.
GetColumnByField	Retrieves the column definition associated with the specified field.
GetColumnByUid	Retrieves a column definition by its unique identifier.
GetColumnFieldNames	Retrieves the field names of all grid columns.
GetColumnIndexByField	Retrieves the index of a column by its field name.
GetCurrentViewRecords	Retrieves the records currently displayed in the grid view.
GetEditState	Retrieves metadata about the active edit context.
GetFilteredRecords	Retrieves the records that satisfy the current filter criteria.
GetHiddenColumns	Retrieves the columns that are currently hidden.
GetSelectedRecords	Retrieves the records currently selected in the grid.
GetSelectedRowCellIndexes	Retrieves the indexes of selected row cells.
GetSelectedRowIndexes	Retrieves the indexes of the currently selected rows.
GetUidByColumnField	Retrieves the unique identifier associated with a column field.
GetVisibleColumns	Retrieves the columns that are currently visible.
GroupByColumn	Groups the grid by the specified column.
HideColumns	Hides the specified columns.
HideSpinner	Hides the grid's loading spinner.
IsDirty	Checks whether the grid has pending batch edits.
MergeCells	Merges the specified rectangular range of cells.
MergeCellsBulk	Merges multiple cell ranges.
NavigateToPage	Navigates to the specified page.
None	Indicates that no tool command has been specified.
OpenColumnChooser	Opens the column chooser dialog.
PasteFromClipboard	Pastes clipboard content into the grid.
PdfExport	Exports grid data to a PDF file.
PersistGridState	Reads, loads, or resets the persisted grid state.
PreventRender	Enables or disables grid rendering.
PrintGrid	Prints the grid.
RefreshColumns	Refreshes the grid's column definitions.
RefreshGrid	Refreshes the grid data and UI.
RefreshHeader	Refreshes the grid header.
ReorderColumn	Reorders one or more columns relative to another column.
ReorderColumnByIndex	Reorders a column from one index to another.
ReorderColumnByTargetIndex	Reorders a column to the specified target index.
ReorderColumns	Moves one or more columns to the location of another column.
ReorderRow	Reorders a row within the current view.
SaveCell	Saves the current cell edit.
ScrollIntoView	Scrolls the grid to bring the specified cell into view.
SearchText	Searches the grid using the specified text.
SelectCell	Selects a single cell.
SelectCells	Selects multiple cells.
SelectCellsByRange	Selects cells within a specified range.
SelectRows	Selects one or more rows.
SelectRowsByRange	Selects rows within a specified range.
SetCellValue	Updates the value of the specified cell.
SetRowData	Updates the data associated with the specified row.
ShowColumns	Displays the specified hidden columns.
ShowSpinner	Displays the grid's loading indicator.
SortByColumn	Sorts the grid by a single column.
SortColumns	Applies sorting to multiple columns.
SortColumnsWithClear	Applies sorting to multiple columns after clearing existing sorting.
UndoRedoHistory	Performs undo and redo history operations.
UngroupColumn	Removes grouping from the specified column.
UnmergeAll	Removes all merged regions.
UnmergeCells	Removes the merged region anchored at the specified cell.
UnmergeCellsBulk	Removes multiple merged regions.
UpdateExternalMessage	Updates the pager's external message.
UpdateGridData	Updates row or cell data without entering edit mode.
UpdatePageSize	Updates the grid page size.