Essential Studio® for Blazor - v31.1.17 Release Notes

Common

Features

  • The following components have been developed to meet industry standards and are now marked production-ready:
    • Smart Paste Button
    • Smart TextArea

Breaking Changes

  • We have streamlined the Blazor Sample Browser (SB) setup by reducing the number of production links from three to two. This change enhances accessibility and simplifies navigation. The previous configuration for “Web App Auto Mode” and “Standalone WASM” has been removed. Moving forward, now blazor samples production links will point to:
    • Web App Interactive Server
    • Web App Interactive WebAssembly
  • We have segregated the following components and libraries from the main Blazor Sample Browser, and they are now maintained in separate production links:
    • Document Processing
    • PDF Viewer
    • Spreadsheet
    • Document Editor
  • The Syncfusion Blazor AI integration has undergone significant API changes to align with modern AI service patterns. The previous AIServiceCredentials class and ConfigureCredentials method have been removed in favor of using Microsoft.Extensions.AI for improved flexibility and direct service integration.

    Before 31.1.17 From 31.1.17 Description Example
    AIServiceCredentials class IChatClient interface Configuration class for AI services replaced with Microsoft.Extensions.AI’s IChatClient for direct integration. Service Registration
    Before:
    builder.Services.AddSyncfusionSmartComponents().ConfigureCredentials(new AIServiceCredentials(apiKey, deploymentName, endpoint)).InjectOpenAIInference();
    After:
    builder.Services.AddSyncfusionSmartComponents().InjectOpenAIInference();
    builder.Services.AddChatClient(azureOpenAIChatClient);
    No specific packages Required NuGet packages New packages required for Microsoft.Extensions.AI integration. Required Packages:
    - Microsoft.Extensions.AI.Azure.AI.OpenAI (Azure OpenAI)
    - OpenAI (OpenAI)
    - OllamaSharp (Ollama)
    ConfigureCredentials method Direct AI client registration Credentials configuration now handled via platform-specific AI clients. OpenAI Configuration
    Before:
    builder.Services.AddSyncfusionSmartComponents().ConfigureCredentials(new AIServiceCredentials(apiKey, deploymentName, endpoint))
    After:
    OpenAIClient openAIClient = new OpenAIClient(apiKey);
    IChatClient chatClient = openAIClient.GetChatClient(modelName).AsIChatClient();
    builder.Services.AddChatClient(chatClient);
    builder.Services.AddSyncfusionSmartComponents().InjectOpenAIInference();
    Built-in credentials handling Manual client configuration Credentials now configured through platform-specific clients. Azure OpenAI Configuration
    Before:
    new AIServiceCredentials(apiKey, deploymentName, endpoint)
    After:
    AzureOpenAIClient azureClient = new AzureOpenAIClient(new Uri(endpoint), new ApiKeyCredential(apiKey));
    IChatClient chatClient = azureClient.GetChatClient(deploymentName).AsIChatClient();
    builder.Services.AddSyncfusionSmartComponents().InjectOpenAIInference();
    Self-hosted configuration Ollama integration Self-hosted models now use dedicated clients like OllamaSharp. Ollama Configuration
    Before:
    new AIServiceCredentials { SelfHosted=true, Endpoint=uri, DeploymentName=model }
    After:
    IChatClient chatClient = new OllamaApiClient("http://localhost:11434", model);
    builder.Services.AddChatClient(chatClient);
    builder.Services.AddSyncfusionSmartComponents().InjectOpenAIInference();

Accumulation Chart

Features

  • Users can now use the NoDataTemplate property in SfAccumulationChart to define a custom template that clearly indicates when chart data is unavailable.

AI AssistView

Features

  • FB68560 - A new event AttachmentUploadChange has been introduced with the Blazor AI AssistView which allows users to upload the files in the Blazor application without specifying the server-side API end point.

Chart

Features

  • #F196133 - Axis labels in the Blazor Chart component can now be customized using HTML templates via the LabelTemplate property in ChartAxis, enabling more flexible and expressive chart designs.
    Explore the demo here

  • Added support in Chart to highlight the last value of a data series with a label and grid line indicator, configurable via the ChartLastDataLabel property, to provide a clear visual reference for the series endpoint and enhance data readability.
    Explore the demo here

  • Users can now use the NoDataTemplate property in SfChart to define a custom template that clearly indicates when chart data is unavailable.
    Explore the demo here

  • Users can now personalize the appearance of chart axis scrollbars by adjusting their color and height. Zooming functionality within the scrollbar can also be disabled using properties in ChartAxisScrollbarSettings, offering greater control over user interactions.

Breaking Changes

  • The deprecated Description property in the SfChart component has been removed. Use the AccessibilityDescription property to define the description of the chart for accessibility purposes.

  • The deprecated Description property in the ChartLegendSettings component has been removed. Use the AccessibilityDescriptionFormat property to define the description format for each item in the chart legend to enhance accessibility.

Chat UI

Features

  • Now we have provided @mention support in the Chat UI, enabling users to tag others from a suggested list. This functionality is controlled using the MentionUsers property.

Explore the demo here

Circular Gauge

Breaking Changes

The following methods and events that were deprecated in previous releases have now been removed. Where applicable, suitable alternatives have been provided to ensure a smooth transition.

Deprecated Method Recommended Alternative
SetPointerValue Use the SetPointerValueAsync method to dynamically update the pointer value.
SetAnnotationValue Use the SetAnnotationValueAsync method to dynamically update the annotation content.
Print Use the PrintAsync method to print the rendered Circular Gauge component.
Export Use the ExportAsync method to export the rendered Circular Gauge component as an image or PDF document.
Refresh Use the RefreshAsync method to re-render the Circular Gauge component when external properties are updated.
Deprecated Event Recommended Alternative
OnDragMove Use the OnDragEnd event to handle updates in the gauge after the pointer or range drag operation is completed.

Dashboard Layout

Breaking Changes

  • The Resizing event has been marked as deprecated due to concerns about its impact on the performance of the component.

  • The following methods that were deprecated in previous releases have now been removed. Where applicable, suitable alternatives have been provided to ensure a smooth transition.

Class Deprecated Type Recommended Alternative
SfDashboardLayout AddPanel Method AddPanelAsync - Allows to add a panel to the Dashboardlayout.
SfDashboardLayout RemovePanel Method RemovePanelAsync - Removes a panel from the DashboardLayout.
SfDashboardLayout Refresh Method RefreshAsync - Updates and refreshes the DashboardLayout component.

Data Form

Bug Fixes

  • #F69287 - Added support for DateTimeOffset and DateTimeOffset? to enhance the rendering capabilities of the DateTimePicker.

Data Grid

Bug Fixes

  • #I755822 , FB69353 - Resolved an issue where the args.Cell.AddClass method in the HeaderCellInfo event did not correctly apply the specified CSS class to column headers.

Features

  • #FB69003 #F158895 #I328363 #F163061 #I498614 #I507469 #FB19363 - Tooltips have been implemented to display contextual information when hovering over grid content and header cells. For header cells, the tooltip presents the column header text; for content cells, it shows the corresponding data value. This feature enables quick access to relevant information without interaction.

  • The TooltipTemplate option allows customization of tooltip content, supporting rich and dynamic rendering based on specific requirements. Explore the demo here.

    Code Example:

      <SfGrid DataSource="@Orders" ShowTooltip="true">
          <GridTemplates>
              <TooltipTemplate>
                  var tooltip = context as TooltipTemplateContext;
                  <span><b>@tooltip.Value</b></span>
              </TooltipTemplate>
          </GridTemplates>
          <GridColumns>
              <GridColumn Field="CustomerID" HeaderText="Customer ID" Width="150"></GridColumn>
          </GridColumns>
      </SfGrid>
    
    
  • #F148011 #I510189 #FB29838- Provided support to preserve the expand or collapse state of grouped rows during data operations such as sorting, filtering, editing, and exporting. This enhancement ensures that the user’s grouping preferences remain intact across interactions, offering a consistent and uninterrupted experience when working with grouped data. Explore the demo here.

    Code Example:

      <SfGrid DataSource="@Orders" AllowGrouping="true">
          <GridGroupSettings PersistGroupState="true"></GridGroupSettings>
      </SfGrid>
    
    
  • #I315145 #I32706 #I424347 #I441518 #I504806 #I685279 - The SelectRowAsync method has been enhanced to support row selection across all pages. Previously, selection was limited to rows visible on the current page. With this update, the method automatically navigates to the target page and selects the specified row, enabling seamless and accurate selection across the entire DataGrid.

    Code Example:

      <button id="SelectRow" @onclick="SelectionHandler">SelectRow</button>
      <SfGrid @ref="grid" AllowSelection="true" AllowPaging="true" DataSource="@Orders">
      ....   
      </SfGrid>
      @code {
          SfGrid<Order> grid;
          private async Task SelectionHandler()
          {
             // To select a row across pages, set selectAcrossPages to true. For example, passing a row index of 15 with a default page size of 12 navigates to the second page and selects the third row on that page.
             await grid.SelectRowAsync(index: 15, selectAcrossPages: true);
          }
      }
    
    

Performance Benchmark

#I709735 #FB66748 - Significant improvements have been made to the performance of lazy load grouping with paging. Benchmark results indicate substantial reductions in rendering time when expanding child rows across various page sizes. These enhancements greatly increase the responsiveness and efficiency of lazy load grouping in the DataGrid. Explore the demo here.

Scenario: Expanding Child Rows (2 Lakh) Before After Performance Improvement
Page Size: 10 ~8801 ms ~87 ms ~99% faster
Page Size: 100 ~9241 ms ~138 ms ~98% faster
Page Size: 1000 ~9106 ms ~1476 ms ~84% faster

Breaking changes

The following properties, events, methods, and APIs that were deprecated in previous releases have now been removed. Where applicable, suitable alternatives have been provided to ensure a smooth transition.

Deprecated Method Recommended Alternative
AddRecord(TValue, Nullable) [AddRecordAsync(TValue, Nullable)](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Grids.SfGrid-1.html#Syncfusion_Blazor_Grids_SfGrid_1_AddRecordAsync__0_System_Nullable_System_Int32__) to adds a new record to the grid at a specific index.
AddRecord AddRecordAsync to adds a new record to the grid.
AutoFitColumns AutoFitColumnsAsync to automatically adjusts all column widths based on content.
AutoFitColumns(String[]) AutoFitColumnsAsync(String[]) to auto-fit specified columns based on content.
AutoFitColumns(String) AutoFitColumnAsync(String) to auto-fit a single column based on content.
ClearCellSelection ClearCellSelectionAsync to clears selected cells in the grid.
ClearFiltering ClearFilteringAsync to removes all filters applied to the grid.
ClearFiltering(List) [ClearFilteringAsync(List)](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Grids.SfGrid-1.html#Syncfusion_Blazor_Grids_SfGrid_1_ClearFilteringAsync_System_Collections_Generic_List_System_String__) to removes filters from specified columns.
ClearFiltering(String) ClearFilteringAsync(String) to removes filter from a specific column.
ClearGrouping ClearGroupingAsync to removes all groupings from the grid.
ClearRowSelection ClearRowSelectionAsync to clears selected rows.
ClearSelection ClearSelectionAsync to clears all selections.
ClearSorting ClearSortingAsync to removes sorting from all columns.
ClearSorting(List) [ClearSortingAsync(List)](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Grids.SfGrid-1.html#Syncfusion_Blazor_Grids_SfGrid_1_ClearSortingAsync_System_Collections_Generic_List_System_String__) to removes sorting from specified columns.
CloseEdit CloseEditAsync to cancels the current edit operation.
Copy(Nullable) [CopyAsync(Nullable)](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Grids.SfGrid-1.html#Syncfusion_Blazor_Grids_SfGrid_1_CopyAsync_System_Nullable_System_Boolean__) to copies selected rows or cells to clipboard.
CsvExport(ExcelExportProperties) ExportToCsvAsync(ExcelExportProperties) to exports the grid data to a CSV file.
DeleteRecord DeleteRecordAsync to deletes a record from the grid.
DeleteRecord(String, TValue) DeleteRecordAsync(String, TValue) to deletes a record by column name and value.
EditCell(Int32, String) EditCellAsync(Int32, String) to enables editing for a specific cell.
EnableToolbarItems(List, Boolean) [EnableToolbarItemsAsync(List, Boolean)](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Grids.SfGrid-1.html#Syncfusion_Blazor_Grids_SfGrid_1_EnableToolbarItemsAsync_System_Collections_Generic_List_System_String__System_Boolean_) to enables or disables toolbar items.
EndEdit EndEditAsync to save the edited values.
ExcelExport(ExcelExportProperties) ExportToExcelAsync(ExcelExportProperties) to exports the grid data to a excel file.
DetailExpandCollapseRow(TValue) ExpandCollapseDetailRowAsync(TValue) to expands or collapses a detail row.
DetailExpandCollapseRow(String, object) ExpandCollapseDetailRowAsync(String, object) to expands or collapses a detail row by field and value.
DetailExpandAll ExpandAllDetailRowAsync to expands all detail rows.
DetailCollapseAll CollapseAllDetailRowAsync to collapses all detail rows.
FilterByColumn(String, String, Object, String, Nullable, Nullable, Object, Object) [FilterByColumnAsync(String, String, Object, String, Nullable, Nullable, Object, Object, String)](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Grids.SfGrid-1.html#Syncfusion_Blazor_Grids_SfGrid_1_FilterByColumnAsync_System_String_System_String_System_Object_System_String_System_Nullable_System_Boolean__System_Nullable_System_Boolean__System_Object_System_Object_System_String_) to filters the grid row by a specified column with the given options.
GetBatchChanges GetBatchChangesAsync to retrieves unsaved changes in batch mode.
GetColumnByField(String) GetColumnByFieldAsync(String) to gets column configuration by field name.
GetColumnByUid(String) GetColumnByUidAsync(String) to gets column configuration by UID.
GetColumnFieldNames GetColumnFieldNamesAsync to gets all column field names.
GetColumnIndexByField(String) GetColumnIndexByFieldAsync(String) to gets index of column by field name.
GetColumnIndexByUid(String) GetColumnIndexByUidAsync(String) to gets index of column by UID.
GetColumns(Nullable) [GetColumnsAsync(Nullable)](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Grids.SfGrid-1.html#Syncfusion_Blazor_Grids_SfGrid_1_GetColumnsAsync_System_Nullable_System_Boolean__) to gets the list of columns details.
GetCurrentViewRecords GetCurrentViewRecordsAsync to gets records currently visible in the grid.
GetFilteredRecords GetFilteredRecordsAsync(Boolean) to gets records that match current filters.
GetForeignKeyColumns GetForeignKeyColumnsAsync to gets foreign key column configurations.
GetHiddenColumns GetHiddenColumnsAsync to gets columns currently hidden in the grid.
GetPersistData GetPersistDataAsync to gets grid state data for persistence.
GetPrimaryKeyFieldNames GetPrimaryKeyFieldNamesAsync to gets names of primary key columns.
GetRowIndexByPrimaryKey(Object) GetRowIndexByPrimaryKeyAsync(Object) to gets row index using primary key value.
GetSelectedRecords GetSelectedRecordsAsync to gets currently selected records.
GetSelectedRowCellIndexes GetSelectedRowCellIndexesAsync to gets cell indexes from selected rows.
GetSelectedRowIndexes GetSelectedRowIndexesAsync to gets indexes of selected rows.
GetUidByColumnField(String) GetUidByColumnFieldAsync(String) to gets UID of column by field name.
GetVisibleColumns GetVisibleColumnsAsync to gets currently visible columns.
GoToPage(Int32) GoToPageAsync(Int32) to navigates to a specific page number.
GroupColumn(String) GroupColumnAsync(String) to groups rows by a specific column.
GroupCollapseAll CollapseAllGroupAsync to collapses all grouped rows.
GroupExpandAll ExpandAllGroupAsync to expands all grouped rows.
HideColumns(String, String) HideColumnAsync(String, String) to hides a column by field or header text.
HideColumns(String[], String) HideColumnsAsync(String[], String) to hides multiple columns by field or header text.
HideSpinner HideSpinnerAsync to hide the spinner.
OpenColumnChooser(Nullable, Nullable) [OpenColumnChooserAsync(Nullable, Nullable)](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Grids.SfGrid-1.html#Syncfusion_Blazor_Grids_SfGrid_1_OpenColumnChooserAsync_System_Nullable_System_Double__System_Nullable_System_Double__) to open the column chooser pop-up at a given position.
PdfExport(PdfExportProperties) ExportToPdfAsync(Boolean, PdfExportProperties) to export grid data to PDF document.
Print PrintAsync to print all pages of the grid and hide the pager.
RefreshColumns RefreshColumnsAsync to refresh the grid with column changes.
RefreshHeader RefreshHeaderAsync to refresh the grid header.
ReorderColumns(String, String) ReorderColumnAsync(String, String) to change the position of a column by its field name.
ReorderColumnByIndex(Int32, Int32) ReorderColumnByIndexAsync(Int32, Int32) to move column positions from one index to another.
ReorderColumnByTargetIndex(String, Int32) ReorderColumnByTargetIndexAsync(String, Int32) to move a column by field name to a target index.
ReorderColumns(List, String) [ReorderColumnsAsync(List, String)](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Grids.SfGrid-1.html#Syncfusion_Blazor_Grids_SfGrid_1_ReorderColumnsAsync_System_Collections_Generic_List_System_String__System_String_) to change column positions based on field names.
ReorderColumns(String[], String) ReorderColumnsAsync(String[], String) to change column positions based on field names.
ReorderRows(Int32, Int32) ReorderRowAsync(Int32, Int32) to change row position with given indexes.
ResetPersistData ResetPersistDataAsync to reset the current state.
SaveCell SaveCellAsync to save the cell currently being edited.
Search(String) SearchAsync(String) to search grid records using a search key.
SelectCell(ValueTuple<Int32, Int32>, Nullable) [SelectCellAsync(ValueTuple<Int32, Int32>, Nullable)](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Grids.SfGrid-1.html#Syncfusion_Blazor_Grids_SfGrid_1_SelectCellAsync_System_ValueTuple_System_Int32_System_Int32__System_Nullable_System_Boolean__) to select a cell by index.
SelectCells(ValueTuple<Int32, Int32>[]) SelectCellsAsync(ValueTuple<Int32, Int32>[]) to select multiple cells by indexes.
SelectCellsByRange(ValueTuple<Int32, Int32>, Nullable<ValueTuple<Int32, Int32») SelectCellsByRangeAsync(ValueTuple<Int32, Int32>, Nullable<ValueTuple<Int32, Int32») to select a range of cells.
SelectRow(Int32, Nullable) [SelectRowAsync(Int32, Nullable)](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Grids.SfGrid-1.html#Syncfusion_Blazor_Grids_SfGrid_1_SelectRowAsync_System_Int32_System_Nullable_System_Boolean__) to select a row by index.
SelectRows(Int32[]) SelectRowsAsync(Int32[]) to select multiple rows by indexes.
SelectRowsByRange(Int32, Nullable) [SelectRowsByRangeAsync(Int32, Nullable)](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Grids.SfGrid-1.html#Syncfusion_Blazor_Grids_SfGrid_1_SelectRowsByRangeAsync_System_Int32_System_Nullable_System_Int32__) to select a range of rows.
SetCellValue(Object, String, Object) SetCellValueAsync(Object, String, Object) to update a cell value by primary key.
SetPersistData(String) SetPersistDataAsync(String) to get grid properties maintained in persisted state.
SetRowData(Object, TValue) SetRowDataAsync(Object, TValue) to update and refresh a row by primary key.
ShowColumns(String, String) ShowColumnAsync(String, String) to show a column by field or header text.
ShowColumns(String[], String) ShowColumnsAsync(String[], String) to show multiple columns by field or header text.
ShowSpinner ShowSpinnerAsync to show a spinner on the grid.
SortColumn(String, SortDirection, Nullable) [SortColumnAsync(String, SortDirection, Nullable)](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Grids.SfGrid-1.html#Syncfusion_Blazor_Grids_SfGrid_1_SortColumnAsync_System_String_Syncfusion_Blazor_Grids_SortDirection_System_Nullable_System_Boolean__) to sort a column with options.
SortColumns(List) [SortColumnsAsync(List)](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Grids.SfGrid-1.html#Syncfusion_Blazor_Grids_SfGrid_1_SortColumnsAsync_System_Collections_Generic_List_Syncfusion_Blazor_Grids_SortColumn__) to sort multiple columns.
SortColumns(List, Boolean) [SortColumnsAsync(List, Boolean)](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Grids.SfGrid-1.html#Syncfusion_Blazor_Grids_SfGrid_1_SortColumnsAsync_System_Collections_Generic_List_Syncfusion_Blazor_Grids_SortColumn__System_Boolean_) to clear previous sorting and apply new sorting.
StartEdit StartEditAsync to start editing the selected row.
UngroupColumn(String) UngroupColumnAsync(String) to ungroup a previously grouped column.
UpdateBatchRow(TValue) UpdateBatchRowAsync(TValue) to update edited fields in batch mode.
UpdateCell(Int32, String, Object) UpdateCellAsync(Int32, String, Object) to update a cell value without entering edit mode.
UpdateExternalMessage(String) UpdateExternalMessageAsync(String) to define the external message text.
UpdateRow(Int32, TValue) UpdateRowAsync(Int32, TValue) to save the currently edited row.
Event Name Removed Property
BeforeBatchDeleteArgs The Row property has been removed. It is no longer available for use.
BeginEditArgs The Row property has been removed. It is no longer available for use.
BeginEditArgs The Type property has been removed. It is no longer available for use.
CellDeselectEventArgs The Cells property has been removed. It is no longer available for use.
CellEditArgs The Cell property has been removed. It is no longer available for use.
CellEditArgs The ColumnObject property has been removed. Use Column to retrieve the column details.
CellEditArgs The Row property has been removed. It is no longer available for use.
CellEditArgs The Type property has been removed. It is no longer available for use.
CellSavedArgs The Cell property has been removed. It is no longer available for use.
CellSavedArgs The ColumnObject property has been removed. Use Column to retrieve the column details.
CellSelectEventArgs The Cancel property has been removed. It is no longer available for use.
CellSelectEventArgs The Cells property has been removed. It is no longer available for use.
CellSelectEventArgs The CurrentCell property has been removed. It is no longer available for use.
CellSelectEventArgs The PreviousRowCell property has been removed. It is no longer available for use.
CellSelectEventArgs The PreviousRowCellIndex property has been removed. Use PreviousCellIndex to achieve.
CellSelectingEventArgs The Cells property has been removed. It is no longer available for use.
CellSelectingEventArgs The CurrentCell property has been removed. It is no longer available for use.
CellSelectingEventArgs The PreviousRowCell property has been removed. It is no longer available for use.
CellSelectingEventArgs The PreviousRowCellIndex property has been removed. Use PreviousCellIndex to achieve.
ColumnChooserEventArgs The RequestType property has been removed. It is no longer available for use.
ColumnChooserEventArgs The Element property has been removed. It is no longer available for use.
ColumnMenuClickEventArgs The Name property has been removed. It is no longer available for use.
ColumnMenuOpenEventArgs The Element property has been removed. It is no longer available for use.
ColumnMenuOpenEventArgs The Name property has been removed. It is no longer available for use.
CommandClickEventArgs The Target property has been removed. It is no longer available for use.
ContextMenuClickEventArgs The Name property has been removed. It is no longer available for use.
ContextMenuOpenEventArgs The ContextMenuObj property has been removed. Use contextMenu to achieve.
ContextMenuOpenEventArgs The Event property has been removed. It is no longer available for use.
ContextMenuOpenEventArgs The Name property has been removed. It is no longer available for use.
DetailDataBoundEventArgs The DetailElement property has been removed. It is no longer available for use.
HeaderCellInfoEventArgs The Node property has been removed. It is no longer available for use.
QueryCellInfoEventArgs The ColSpan property has been removed. It is no longer available for use.
QueryCellInfoEventArgs The RequestType property has been removed. It is no longer available for use.
QueryCellInfoEventArgs The RowSpan property has been removed. It is no longer available for use.
RecordClickEventArgs The Cell property has been removed. It is no longer available for use.
RecordClickEventArgs The Name property has been removed. It is no longer available for use.
RecordClickEventArgs The Row property has been removed. It is no longer available for use.
RecordClickEventArgs The Target property has been removed. It is no longer available for use.
RowDataBoundEventArgs The RowHeight property has been removed. It is no longer available for use.
RowDeselectEventArgs The Row property has been removed. It is no longer available for use.
RowDeselectEventArgs The Target property has been removed. It is no longer available for use.
RowDragEventArgs The Target property has been removed. It is no longer available for use.
RowDroppingEventArgs The Target property has been removed. It is no longer available for use.
RowInfo The Cell property has been removed. It is no longer available for use.
RowInfo The Row property has been removed. It is no longer available for use.
RowSelectEventArgs The Cancel property has been removed. It is no longer available for use.
RowSelectEventArgs The PreviousRow property has been removed. It is no longer available for use.
RowSelectEventArgs The Row property has been removed. It is no longer available for use.
RowSelectEventArgs The Target property has been removed. It is no longer available for use.
RowSelectingEventArgs The PreviousRow property has been removed. It is no longer available for use.
RowSelectingEventArgs The Row property has been removed. It is no longer available for use.
RowSelectingEventArgs The Target property has been removed. It is no longer available for use.
ActionEventArgs The Form property has been removed. It is no longer available for use.
ActionEventArgs The MovableForm property has been removed. It is no longer available for use.
ActionEventArgs The Target property has been removed. It is no longer available for use.
ActionEventArgs The Tr property has been removed. It is no longer available for use.
ActionEventArgs The Row property has been removed. It is no longer available for use.
  • The Selection property in the Action enum class has been removed from RequestType. It is no longer available for use.
  • The OnRowDragStart event and the RowDragEventArgs class have been removed. They are no longer available for use. Use the RowDragStarting event instead, which is triggered when rows are dragged to perform reordering. This event uses the RowDragStartingEventArgs class as its argument.
  • The EnableHeaderFocus property has been removed from the SfGrid component. It is no longer available for use.
  • The Type property in GridColumn component, Enum ColumnType.Number has been removed. It is no longer available for use. Use specific number data types:
    - ColumnType.Integer for int values
    - ColumnType.Double for double values
    - ColumnType.Long for long or long int values
    - ColumnType.Decimal for decimal values

    Code Example:

      <SfGrid DataSource="@Orders">
      <GridColumns>
          <GridColumn Field=@nameof(OrderData.OrderID) HeaderText="Order ID" Type="ColumnType.Integer" Width="120" />
          <GridColumn Field=@nameof(OrderData.Freight) HeaderText="Freight" Type="ColumnType.Double" Width="120" />
      </GridColumns>
      </SfGrid>
    
    
  • DragSelection behavior in the DataGrid has been updated—selection now occurs only when the left mouse button is pressed and dragged, while right-click drag selection has been disabled to prevent unintended interactions.

  • In both HeaderCellInfo and QueryCellInfo events, when the same style attribute (such as style="color") is applied using both SetAttribute and AddStyle, the property value provided through AddStyle (e.g., blue, yellow) will take precedence over the one set via SetAttribute.

Date Picker

Bug Fixes

  • I738696 - Resolved an issue where users were unable to paste a date value in the datepicker when the mask feature was enabled.

Diagram

Features

  • Enable/Disable tooltip for symbol palette elements - The Symbol Palette now offers improved tooltip customization through the ShowTooltip property. This enhancement allows developers to enable or disable tooltips for shapes and connectors, override default tooltip content (which previously displayed only the element ID), and deliver a more contextual and user-friendly experience for diagram elements.

  • Vertical Orientation Support in Mind Map Diagrams - Mind Map diagrams now support Vertical orientation, expanding the existing LayoutOrientation options. This update enables top-down hierarchical visualization, improves readability for complex structures, and offers greater layout flexibility for diverse mind mapping scenarios.

  • Segment Thumb Restriction for Connectors - A new MaxSegmentThumbs property has been introduced to limit the number of segment thumbs (interactive control points) on connectors. This feature helps maintain diagram clarity, prevents excessive customization, and enhances performance—particularly for orthogonal connectors—by reducing unnecessary interaction points.

Bug Fixes

  • #I756830 - Diagram panning now works on iPad devices.

Breaking Changes

  • The obsolete methods and properties marked on or before the 2024 Volume 3 release such as EndUpdate, AddDiagramElements, DoLayout, ShowTooltip, HideTooltip, RefreshDataSource, LoadDiagram, AddChild, Template, TextOverflow, TextWrapping and Source have now been removed.

Features

  • Enhanced the Blazor Dropdown Tree component’s performance when opening popups.

Performance Improvements - The Dropdown Tree component’s performance has been improved during the dropdown popup opening. The following improvements demonstrate the performance enhancement.

Scenario Improved percentage (%)
10k nodes checked (100 parent nodes, 100 child nodes) 35
10k nodes selected (100 parent nodes, 100 child nodes) 82

Bug Fixes

  • #I758209 - Fixed an issue where the selected value in the Dropdown Tree component could not be cleared using the clear icon on iOS devices.

Breaking Changes

  • The Level property is deprecated and will no longer be used in the DropDownTreeField class of the Dropdown Tree component.

File Manager

Features

  • Enhanced the context menu module performance by setting the Blazor File Manager as the target to perform frequent interactions over submenu.
  • The Blazor File Manager component’s performance has been enhanced to shorten the initial rendering time.

Performance Benchmark Comparison:

Environment Scenario Performance Improvement
Server 5k files in the root directory only 25% Faster
WebAssembly (WASM) 5k files in the root directory only 10% Faster

Breaking Changes

  • The following properties that were deprecated in previous releases have now been removed. Where applicable, suitable alternatives have been provided to ensure a smooth transition.
Class Deprecated Type Recommended Alternative
BeforeSendEventArgs AjaxSettings Property The AjaxSettings property in the BeforeSendEventArgs event has been marked as deprecated and should no longer be used. Use HttpClientInstance instead.
FileManagerToolbarSettings Items Property The Items property in the FileManagerToolbarSettings is now deprecated. You can now use the ToolbarItems property to customize the toolbar items.

Gantt Chart

Bug fixes

  • #I756192 - Fixed an issue where updating the predecessor value during cell edit did not reflect the newly added predecessor in the Gantt chart.
  • #I745953 - Resolved an issue where drag selection with virtual scrolling caused inconsistent row selection during simultaneous up/down scroll actions.
  • #I751643 - Restricted right-click drag selection when the context menu is enabled to prevent unintended selection behavior.

Features

  • #FB67593 - Provided support for drag selection-related events in the Gantt Chart, including RowDragSelectionStarting, RowDragSelectionCompleting, and RowDragSelectionCompleted, for enhanced control over selection behavior.
  • #FB60984 - Provided support for Excel-style filtering in the Blazor Gantt Chart by setting the FilterType to Excel, enhancing filtering customization and usability.
  • Provided timezone support in the Blazor Gantt Chart to ensure task start and end dates are accurately displayed based on the configured timezone.
  • Provided support for Work Breakdown Structure (WBS) in the Blazor Gantt Chart, allowing tasks to be displayed with hierarchical codes (e.g., 1, 1.1, 1.1.1) based on their position in the task hierarchy.
  • #I750020 - Improved support for deleting multiple selected records in the Gantt Chart.

Breaking changes

  • The following event properties that were deprecated in previous releases have now been removed. Where applicable, suitable alternatives have been provided to ensure a smooth transition.

    Event Name Removed Property
    CellDeselectEventArgs The Cells property has been removed.
    CellEditArgs The Cell property has been removed.
    CellEditArgs The ColumnObject property has been removed. Use Column to retrieve the column details.
    CellEditArgs The Row property has been removed.
    CellEditArgs The Type property has been removed.
    CellSavedArgs The Cell property has been removed.
    CellSavedArgs The ColumnObject property has been removed. Use Column to retrieve the column details.
    CellSelectEventArgs The Cancel property has been removed.
    CellSelectEventArgs The Cells property has been removed.
    CellSelectEventArgs The CurrentCell property has been removed.
    CellSelectEventArgs The PreviousRowCell property has been removed.
    CellSelectEventArgs The PreviousRowCellIndex property has been removed. Use PreviousCellIndex to achieve.
    CellSelectingEventArgs The Cells property has been removed.
    CellSelectingEventArgs The CurrentCell property has been removed.
    CellSelectingEventArgs The PreviousRowCell property has been removed.
    CellSelectingEventArgs The PreviousRowCellIndex property has been removed. Use PreviousCellIndex to achieve.
    ColumnMenuClickEventArgs The Name property has been removed.
    ContextMenuClickEventArgs The Name property has been removed.
    ContextMenuOpenEventArgs The ContextMenuObj property has been removed. Use ContextMenu to achieve.
    ContextMenuOpenEventArgs The Event property has been removed.
    ContextMenuOpenEventArgs The Name property has been removed.
    QueryCellInfoEventArgs The ColSpan property has been removed.
    QueryCellInfoEventArgs The RequestType property has been removed.
    QueryCellInfoEventArgs The RowSpan property has been removed.
    RowDataBoundEventArgs The RowHeight property has been removed.
    RowDeselectEventArgs The Row property has been removed.
    RowDeselectEventArgs The Target property has been removed.
    RowDroppingEventArgs The Target property has been removed.
    RowSelectEventArgs The Cancel property has been removed.
    RowSelectEventArgs The PreviousRow property has been removed.
    RowSelectEventArgs The Row property has been removed.
    RowSelectEventArgs The Target property has been removed.
    RowSelectingEventArgs The PreviousRow property has been removed.
    RowSelectingEventArgs The Row property has been removed.
    RowSelectingEventArgs The Target property has been removed.
  • The Type property in GanttColumn component, Enum ColumnType.Number, has been removed. It is no longer available for use. Use specific number data types instead:
    - ColumnType.Integer for int values
    - ColumnType.Double for double values
    - ColumnType.Long for long or long int values
    - ColumnType.Decimal for decimal values

    Code Example:

      <SfGantt DataSource="@TaskCollection">
          <GanttTaskFields Id="TaskId" Name="TaskName" StartDate="StartDate" EndDate="EndDate"
                          Duration="Duration" Progress="Progress" ParentID="ParentId" Work="Work">
          </GanttTaskFields>
          <GanttColumns>
              <GanttColumn Field="TaskId" Width="150" Type="Syncfusion.Blazor.Grids.ColumnType.Integer"></GanttColumn>
              <GanttColumn Field="Duration" HeaderText="Duration" Width="150" Type="Syncfusion.Blazor.Grids.ColumnType.Double"></GanttColumn>
          </GanttColumns>
      </SfGantt>
    
    
  • The AllowDragSelection behavior in the Gantt Chart has been updated. Row selection now occurs only when the left mouse button is pressed and dragged. Drag selection using the right mouse button has been disabled to prevent unintended interactions.

  • In the QueryCellInfo event, when the same style attribute (such as style="color") is applied using both SetAttribute and AddStyle, the property value provided through AddStyle (e.g., blue, yellow) will take precedence over the one set via SetAttribute.

HeatMap

Breaking Changes

  • The following methods that were deprecated in previous releases have now been removed. Where applicable, suitable alternatives have been provided to ensure a smooth transition.
Deprecated Method Recommended Alternative
ClearSelection Use the ClearSelectionAsync method to clear any selection made in the HeatMap.
Print Use the PrintAsync method to print the rendered HeatMap component.
Export Use the ExportAsync method to export the rendered HeatMap component as an image or PDF document.
RefreshBound Use the RefreshBoundAsync method to re-render the HeatMap component when external properties are updated.
  • The following properties in HeatMapAxisMultiLevelLabelsTextStyle that were deprecated in previous releases have now been removed. Where applicable, suitable alternatives have been provided to ensure a smooth transition.
Deprecated Property Recommended Alternative
TextAlignment Use the Alignment property to modify the alignment of text in multi-level labels.
TextOverflow Use the Overflow property to control how text overflow is handled in multi-level labels.

Linear Gauge

Breaking Changes

The following methods that were deprecated in previous releases have now been removed. Where applicable, suitable alternatives have been provided to ensure a smooth transition.

Deprecated Method Recommended Alternative
Print Use the PrintAsync method to print the rendered Linear Gauge component.
Export Use the ExportAsync method to export the rendered Linear Gauge component as an image or PDF document.
Refresh Use the RefreshAsync method to re-render the Linear Gauge component when external properties are updated.

ListBox

Breaking Changes

The following APIs were deprecated in previous releases and have now been removed. Where applicable, suitable alternatives have been provided to ensure a smooth transition.

  • The Name property has been removed from the component. It is no longer available for use.

  • The ItemSelected event has been removed. Use the Filtering event instead to handle filtering logic when AllowFiltering is enabled.

Maps

Breaking Changes

MultiSelect

Feature

  • #I749725 - Provided the support for the SelectingAll event, which fires before the SelectAll action in checkbox mode, allowing cancellation of the SelectAll action by setting the Cancel property to true, and includes a SuppressItemEvents feature to prevent individual item events (OnValueSelect, OnValueRemove, and ValueRemoved) from triggering during the SelectAll operation.

PDF

Features

  • I710068 - Added support for multi-region redaction based on QuadPoints in redaction annotations.

Pivot Table

Bug Fixes

  • #I753434 - Number formatting is now correctly applied to OLAP fields in the drill-through popup.

Features

  • A new public method, RefreshAsync, has been introduced to facilitate dynamic refreshing of the Pivot Table component. This method offers a more streamlined and efficient way to update the layout.

Breaking Changes

  • As part of the introduction of the new public method RefreshAsync, the previously existing method LayoutRefreshAsync has been deprecated. Its functionality is now fully covered by the new RefreshAsync method, ensuring backward compatibility while promoting a cleaner API.

Rich Text Editor

Features

  • Table Row/Column Quick Insert: The Rich Text Editor now features an intuitive mechanism for inserting rows and columns. When users hover over the first row’s columns or the first column’s cells, a subtle dot icon appears. Hovering over this dot reveals a + icon, which users can click to instantly insert a new row or column at that position. Please find the demo here.

  • Source Code View Alignment: The Rich Text Editor now supports a more polished source code view, featuring improved formatting and indentation for both block-level and inline HTML elements. This enhancement ensures a cleaner, more readable, and user-friendly editing experience. Please find the demo here.

  • Selection Change Event: The Rich Text Editor now supports the SelectionChanged event, triggered when a non-empty selection text, image, or range is made or updated via mouse, keyboard, or code. It provides detailed context through SelectionChangedEventArgs, and works in both HTML and Markdown modes, enabling dynamic UI updates and custom logic. Please find the demo here.

  • Bullet/Number List via Execute Command: Added support for BulletFormatList and NumberFormatList in the ExecuteCommandAsync method. These commands allow developers to programmatically apply numbered and bulleted list formatting to selected content within the Rich Text Editor.

  • Word Import Enhancement: The Import Word feature has been enhanced to display the import option in a dialog, improving customization for importing Word documents. While uploading a Word document, existing file upload-related events will be triggered. You can also restrict the upload file size using the MaxFileSize property. Please find the demo here.

Schedule

Features

  • #I618429 - Added the GroupIndex value to the DateHeaderTemplate when the date header is grouped by resource. This enables resource-specific customization of date headers. Applicable only for Day, Week, WorkWeek, and Agenda views when resource-specific date headers are rendered.

Breaking changes

The following classes, properties, events, and APIs that were deprecated in previous releases have now been removed. Where applicable, suitable alternatives have been provided to ensure a smooth transition.

Class Deprecated Type Recommended Alternative
CellDOM CellDOM Class The CellDOM class has been removed.
NavigatingEventArgs Action Property Use the ActionType property instead.
DragEventArgs<T> Top Property Use the ClientY property of MouseEventArgs instead.
DragEventArgs<T> Left Property Use the ClientX property of MouseEventArgs instead.
EventRenderedArgs<T> ElementReference Property The ElementReference property is deprecated since DOM elements are no longer passed as arguments. Use the Data property, which represents the data object of the appointment.

Bug Fixes

  • #I760052 - An exception issue while utilizing CloseOnDocumentClick property in the sidebar component has been resolved.

Splitter

Bug Fixes

  • #I758171 - Resolved an issue where the inconsistent border thickness rendering for expand/collapse icons in the Splitter Component.

Stepper

Bug Fixes

  • #I758572 - Resolved an issue where the tooltip was not properly displayed on hover for the steps in the Stepper component.

Stock Chart

Features

  • Added support in Stock Chart to highlight the last value of a data series with a label and grid line indicator, configurable via the StockChartLastDataLabel property, to provide a clear visual reference for the series endpoint and enhance data readability.
    Explore the demo here

  • Users can now use the NoDataTemplate property in SfStockChart to define a custom template that clearly indicates when chart data is unavailable.

Tab

Breaking changes

The following properties of the events that were deprecated in previous releases have now been removed. Where applicable, suitable alternatives have been provided to ensure a smooth transition.

Class Deprecated Type Recommended Alternative
SelectEventArgs Cancel Property Use the SwipeMode property instead to enable or disable Tab selection during swipe actions.

Tooltip

Breaking changes

The following methods, properties, and class were deprecated in previous releases and have now been removed. Where applicable, suitable alternatives have been provided to ensure a smooth transition.

Deprecated Recommended Alternative
Open OpenAsync to show the tooltip animation and target element.
close CloseAsync to hide the tooltip with animation settings.
Refresh RefreshAsync to update the tooltip when the target element is dynamically used.
RefreshPosition RefreshPositionAsync to reposition the tooltip based on the target element.
TooltipTemplates ContentTemplate to define and render custom tooltip content.
Name Removed. previously used to specify tooltip event names like beforeRender, beforeOpen
Element Removed. previously used to denote the tooltip DOM element.

Tree Grid

Features

  • Introduced the EnableStickyHeader property to keep column headers fixed at the top of the Tree Grid during vertical scrolling. When enabled, the headers remain visible while navigating through records, improving readability and context in large hierarchical datasets.

  • Introduced the EmptyRecordTemplate feature to customize the UI when no records are available in the Tree Grid. Custom messages, icons, or interactive components can be displayed instead of the default “No records to display.”

  • Added support for binding observable data collections in the Tree Grid to automatically reflect changes during add, delete, or update operations without requiring manual refresh.

  • Provided support for the [RefreshDataAsync]
    (https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.TreeGrid.SfTreeGrid-1.html#Syncfusion_Blazor_TreeGrid_SfTreeGrid_1_RefreshDataAsync)method to reload the Tree Grid data source and optionally preserve query states. This method simplifies data refresh workflows by enabling programmatic updates without requiring manual UI interaction or full component reinitialization.

Method Parameters

Parameter Type Description
PreserveState bool Indicates whether to retain existing query states such as sorting, filtering, searching, and paging during the data source refresh. When set to false, all query actions are reset to their initial state.

Code Example

    <button @onclick="() => ReloadDataAsync(preserveState: true)">UpdateTreeGridDataSource</button> 
    <SfTreeGrid @ref="MyTreeGrid" DataSource="@TreeItems"> 
    <TreeGridColumns> 
        <TreeGridColumn Field="Name" HeaderText="Name"></TreeGridColumn> 
        <TreeGridColumn Field="Category" HeaderText="Category"></TreeGridColumn> 
    </TreeGridColumns> 
    </SfTreeGrid> 
    @code { 
        SfTreeGrid<MyModel> MyTreeGrid; 
        List<MyModel> TreeItems = new List<MyModel>(); 

        private async Task ReloadDataAsync(bool preserveState) 
        { 
            // Load fresh data from API or database 
            TreeItems = await LoadDataFromApiAsync(); 

            // Update TreeGrid with new data 
            await MyTreeGrid.RefreshDataAsync(preserveState); 
        } 
    }
  • Provided support for the [GetEditContextAsync]
    (https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.TreeGrid.SfTreeGrid-1.html#Syncfusion_Blazor_TreeGrid_SfTreeGrid_1_GetEditContextAsync)method to access the currently edited data item in the Tree Grid. Enables retrieval of in-progress changes for validation, logic execution, or external integration. Works seamlessly in editing for consistent edit tracking.

Code Example

    <SfTreeGrid @ref="treegrid" DataSource="@Orders">
    <TreeGridEditSettings AllowEditing="true" AllowAdding="true" Mode="EditMode.Row"></TreeGridEditSettings>
    </SfTreeGrid>
    @code {
        SfTreeGrid<Order> treegrid;        
        private async Task GetCurrentEditItem()        
        {        
            var currentEditItem = await treegrid.GetEditContextAsync();  
            // Custom logic 
        }      
    }

Breaking Changes

  • The following properties and methods that were deprecated in previous releases have now been removed. Where applicable, suitable alternatives have been provided to ensure a smooth transition.
Class Deprecated Type Recommended Alternative
RowDataBoundEventArgs<TValue> Row Property The Row property is deprecated since DOM elements are no longer passed as arguments. Use the Data property - Represents the data object of the row being bound.
QueryCellInfoEventArgs<TValue> Row Property The Row property is deprecated since DOM elements are no longer passed as arguments. Use the Data property - Represents the data object of the cell’s row.
RowExpandingEventArgs<TValue> Row Property The Row property is deprecated since DOM elements are no longer passed as arguments. Use the Data property - Represents the data object of the row being expanded.
RowCollapsingEventArgs<TValue> Row Property The Row property is deprecated since DOM elements are no longer passed as arguments. Use the Data property - Represents the data object of the row being collapsed.
TreeGridEvents<TValue> OnRowDragStart Event RowDragStarting - Raised when row dragging starts for reordering. Receives a RowDragStartingEventArgs object with details about the dragged rows.
SfTreeGrid<TValue> AddRecord Method AddRecordAsync - Adds a new record to the TreeGrid. Without passing parameters, it adds empty rows. TreeGridEditSettings.AllowAdding should be true.
SfTreeGrid<TValue> AddRecord Method AddRecordAsync - Renders a new row with input fields in the TreeGrid, enabling the addition and saving of a new record.
SfTreeGrid<TValue> AutoFitColumns Method AutoFitColumnsAsync - Changes the column width to automatically fit its content to ensure that the width shows the content without wrapping/hiding. This method ignores the hidden columns. Uses the AutoFitColumns method in the dataBound event to resize at initial rendering.
SfTreeGrid<TValue> ClearFiltering Method ClearFilteringAsync - Clears all the filtered rows of the Grid.
SfTreeGrid<TValue> ClearFiltering Method ClearFilteringAsync - Clears all the filtered rows of the Grid.
SfTreeGrid<TValue> ClearSelection Method ClearSelectionAsync - Deselects the currently selected rows and cells.
SfTreeGrid<TValue> ClearSorting Method ClearSortingAsync - Clears all the sorted columns of the TreeGrid.
SfTreeGrid<TValue> CloseEdit Method CloseEditAsync - Cancels the current edited state in Tree Grid.
SfTreeGrid<TValue> CollapseAll Method CollapseAllAsync - Collapses All the rows in Tree Grid.
SfTreeGrid<TValue> CollapseAtLevel Method CollapseAtLevelAsync - Collapses the records at specific hierarchical level.
SfTreeGrid<TValue> CollapseRow Method CollapseRowAsync - Collapses child rows of the specified record.
SfTreeGrid<TValue> Copy Method CopyAsync - Copy the selected rows or cells data into clipboard.
SfTreeGrid<TValue> CsvExport Method ExportToCsvAsync - Export TreeGrid data to CSV file with customization.
SfTreeGrid<TValue> DeleteRecord Method DeleteRecordAsync - Deletes the selected record from Tree grid. TreeGridEditSettings.AllowDeleting should be true.
SfTreeGrid<TValue> DeleteRecord Method DeleteRecordAsync - Delete a record with Given options. If field name and data is not given then grid will delete the selected record. TreeGridEditSettings.AllowDeleting should be true.
SfTreeGrid<TValue> EditCell Method EditCellAsync - To edit any particular cell using row index and cell index.
SfTreeGrid<TValue> EnableToolbarItems Method EnableToolbarItemsAsync - Enables or disables ToolBar items.
SfTreeGrid<TValue> EndEdit Method EndEditAsync - If TreeGrid is in editable state, you can save a record by invoking endEdit.
SfTreeGrid<TValue> ExcelExport Method ExportToExcelAsync - Export TreeGrid data to Excel file with customization(.xlsx).
SfTreeGrid<TValue> ExcelExport Method ExportToExcelAsync - Export TreeGrid data to Excel file(.xlsx).
SfTreeGrid<TValue> ExcelExport Method ExportToExcelAsync - Export TreeGrid data to Excel file with Tree Grid Customization(.xlsx).
SfTreeGrid<TValue> ExpandAtLevel Method ExpandAtLevelAsync - Expands the records at specific hierarchical level.
SfTreeGrid<TValue> ExpandRow Method ExpandRowAsync - Expands child rows.
SfTreeGrid<TValue> FilterByColumn Method FilterByColumnAsync - Filters TreeGrid row by column name with the given options.
SfTreeGrid<TValue> GetBatchChanges Method GetBatchChangesAsync - Returns the added, edited,and deleted data before bulk save to the DataSource in batch mode.
SfTreeGrid<TValue> GetCheckedRecords Method GetCheckedRecordsAsync - Get the records of checked rows.
SfTreeGrid<TValue> GetCheckedRowIndexes Method GetCheckedRowIndexesAsync - Returns the row indexes of checked checkbox column.
SfTreeGrid<TValue> GetColumnByField Method GetColumnByFieldAsync - Gets a Column by column name.
SfTreeGrid<TValue> GetColumnByUid Method GetColumnByUidAsync - Gets a column by UID.
SfTreeGrid<TValue> GetColumnFieldNames Method GetColumnFieldNamesAsync - Gets the collection of column fields.
SfTreeGrid<TValue> GetColumnIndexByField Method GetColumnIndexByFieldAsync - Gets a column index by column name.
SfTreeGrid<TValue> GetColumnIndexByUid Method GetColumnIndexByUidAsync - Gets a column index by UID.
SfTreeGrid<TValue> GetColumns Method GetColumnsAsync - Gets the columns from the TreeGrid.
SfTreeGrid<TValue> GetPrimaryKeyFieldNames Method GetPrimaryKeyFieldNamesAsync - Returns the names of the primary key columns of the TreeGrid.
SfTreeGrid<TValue> GetSelectedRecords Method GetSelectedRecordsAsync - Returns the collection of selected records.
SfTreeGrid<TValue> GetSelectedRowCellIndexes Method GetSelectedRowCellIndexesAsync - Gets the collection of selected row and cell indexes.
SfTreeGrid<TValue> GetSelectedRowIndexes Method GetSelectedRowIndexesAsync - Gets the collection of selected row indexes.
SfTreeGrid<TValue> GetRowIndexByPrimaryKey Method GetRowIndexByPrimaryKeyAsync - Get row index by primary key.
SfTreeGrid<TValue> GetUidByColumnField Method GetUidByColumnFieldAsync - Gets UID by column name.
SfTreeGrid<TValue> GetVisibleColumns Method GetVisibleColumnsAsync - Gets the visible columns from the TreeGrid.
SfTreeGrid<TValue> GoToPage Method GoToPageAsync - Navigates to the specified target page.
SfTreeGrid<TValue> HideColumns Method HideColumnsAsync - Hides a column by column name.
SfTreeGrid<TValue> HideColumns Method HideColumnAsync - Hides a column by column name.
SfTreeGrid<TValue> OpenColumnChooser Method OpenColumnChooserAsync - Column chooser can be displayed on screen by given position(X and Y axis).
SfTreeGrid<TValue> Paste Method PasteAsync - Paste data from clipboard to selected cells.
SfTreeGrid<TValue> PdfExport Method ExportToPdfAsync - Export TreeGrid data to PDF document with Customization.
SfTreeGrid<TValue> PdfExport Method ExportToPdfAsync - Export TreeGrid data to PDF document with Tree Grid Customization.
SfTreeGrid<TValue> PdfExport Method ExportToPdfAsync - Export TreeGrid data to PDF document.
SfTreeGrid<TValue> Print Method PrintAsync - By default, prints all the pages of the TreeGrid and hides the pager. You can customize print options using the PrintMode.
SfTreeGrid<TValue> Refresh Method RefreshAsync - Refreshes the Tree Grid header and content.
SfTreeGrid<TValue> RefreshColumns Method RefreshColumnsAsync - Refreshes the TreeGrid column changes.
SfTreeGrid<TValue> RefreshHeader Method RefreshHeaderAsync - Refreshes the TreeGrid header.
SfTreeGrid<TValue> ReorderColumns Method ReorderColumnsAsync - Changes the Grid column positions by field names.
SfTreeGrid<TValue> ReorderRows Method ReorderRowAsync - Changes the Tree Grid Row position with given indexes.
SfTreeGrid<TValue> SaveCell Method SaveCellAsync - Saves the cell that is currently edited. It does not save the value to the DataSource.
SfTreeGrid<TValue> Search Method SearchAsync - Searches TreeGrid records using the given key.
SfTreeGrid<TValue> SelectCell Method SelectCellAsync - Selects a cell by the given index.
SfTreeGrid<TValue> SelectCheckboxes Method SelectCheckboxesAsync - Checked the checkboxes using rowIndexes.
SfTreeGrid<TValue> SelectRow Method SelectRowAsync - Selects a row by given index.
SfTreeGrid<TValue> SelectRows Method SelectRowsAsync - Selects a collection of rows by indexes.
SfTreeGrid<TValue> SetCellValue Method SetCellValueAsync - Updates particular cell value based on the given primary key value. Primary key column must be specified using Columns.isPrimaryKey property.
SfTreeGrid<TValue> SetRowData Method SetRowDataAsync - Updates and refresh the particular row values based on the given primary key value. Primary key column must be specified using Columns.isPrimaryKey property.
SfTreeGrid<TValue> ShowColumns Method ShowColumnsAsync - Shows a column by its column name.
SfTreeGrid<TValue> ShowColumns Method ShowColumnAsync - Shows a column by its column name.
SfTreeGrid<TValue> ShowSpinner Method ShowSpinnerAsync - By default, TreeGrid shows the spinner for all its actions. You can use this method to show spinner at your needed time.
SfTreeGrid<TValue> SortByColumn Method SortByColumnAsync - Sorts a column with the given options.
SfTreeGrid<TValue> StartEdit Method StartEditAsync - To edit any particular row by TR element.
SfTreeGrid<TValue> UpdateCell Method UpdateCellAsync - To update the specified cell by given value without changing into edited state.
SfTreeGrid<TValue> UpdateRow Method UpdateRowAsync - To update the specified row by given values without changing into edited state.

TreeMap

Breaking Changes

The following methods that were deprecated in previous releases have now been removed. Where applicable, suitable alternatives have been provided to ensure a smooth transition.

Deprecated Method Recommended Alternative
SelectItem Use the SelectItemAsync method to select or deselect a specific TreeMap item.
Print Use the PrintAsync method to print the rendered TreeMap component.
Export Use the ExportAsync method to export the rendered TreeMap component as an image or PDF document.
Refresh Use the RefreshAsync method to re-render the TreeMap component when external properties are updated.

TreeView

Bug Fixes

  • #I745411 - Fixed an issue in Blazor TreeView where updating the data source after expanding a node failed to reflect the new data correctly.

Breaking Changes

  • The following methods that were deprecated in previous releases have now been removed. Where applicable, suitable alternatives have been provided to ensure a smooth transition.
Class Deprecated Type Recommended Alternative
SfTreeView<TValue> BeginEdit Method BeginEditAsync - Enables editing of a TreeView node without clicking on it. Passing the node ID or element through this method will create an edit text box for the specified node, allowing it to be edited.
SfTreeView<TValue> CheckAll Method CheckAllAsync - Checks all the unchecked nodes in the TreeView. Specific nodes can be checked by passing an array of unchecked node IDs as an argument to this method.
SfTreeView<TValue> ClearState Method ClearStateAsync - This method clears the expanded, selected, and checked interaction states in the TreeView. This method is useful when dynamically changing the data source.
SfTreeView<TValue> CollapseAll Method CollapseAllAsync - Collapses all the expanded nodes in the TreeView. Specific nodes can also be collapsed by passing an array of node IDs as an argument to this method.
SfTreeView<TValue> DisableNodes Method DisableNodesAsync - Disables a collection of nodes by passing the ID of nodes or node elements in the array.
SfTreeView<TValue> EnableNodes Method EnableNodesAsync - Enables a collection of disabled nodes by passing the ID of nodes or node elements in the array.
SfTreeView<TValue> EnsureVisible Method EnsureVisibleAsync - Ensures visibility of the TreeView node by using the node ID or node element. When many TreeView nodes are present and a particular node has to be found, EnsureVisibleAsync method brings the node to visibility by expanding the TreeView and scrolling to the specific node.
SfTreeView<TValue> ExpandAll Method ExpandAllAsync - Expands all the collapsed TreeView nodes. Specific nodes can be expanded by passing the array of collapsed nodes ID.
SfTreeView<TValue> GetDisabledNodes Method GetDisabledNodesAsync - Gets all the disabled nodes including child, whether it is loaded or not.
SfTreeView<TValue> UncheckAll Method UncheckAllAsync - Unchecks all the checked nodes. Specific nodes can also be unchecked by passing array of checked nodes as an argument to this method.
SfTreeView<TValue> RefreshNode Method RefreshNodeAsync - Replaces the text of the TreeView node with the given text.

Test Results

Component Name Test Cases Passed Failed Remarks
3DChart 202 202 0 All Passed
Accordion 232 232 0 All Passed
AiAssistView 300 300 0 All Passed
Appbar 102 102 0 All Passed
Autocomplete 444 444 0 All Passed
Bulletchart 237 237 0 All Passed
Button 255 255 0 All Passed
Calendar 146 146 0 All Passed
Carousel 174 174 0 All Passed
Charts 3917 3917 0 All Passed
ChatUI 130 130 0 All Passed
Chips 196 196 0 All Passed
CircularGauge 927 927 0 All Passed
ColorPicker 113 113 0 All Passed
ComboBox 233 233 0 All Passed
DashboardLayout 252 252 0 All Passed
DataForm 547 547 0 All Passed
DataGrid 4896 4896 0 All Passed
DatePicker 574 574 0 All Passed
DateRangePicker 365 365 0 All Passed
DateTimePicker 474 474 0 All Passed
Diagram 15098 15098 0 All Passed
Dialog 389 389 0 All Passed
DocumentEditor 1929 1929 0 All Passed
DropdownList 577 577 0 All Passed
Dropdowntree 131 131 0 All Passed
FileManager 3104 3104 0 All Passed
FileUpload 328 328 0 All Passed
FloatingActionButton 128 128 0 All Passed
Gantt 4675 4675 0 All Passed
HeatMap 337 337 0 All Passed
ImageEditor 3561 3561 0 All Passed
InPlaceEditor 763 763 0 All Passed
Kanban 388 388 0 All Passed
LinearGauge 797 797 0 All Passed
ListBox 138 138 0 All Passed
ListView 439 439 0 All Passed
Maps 1570 1570 0 All Passed
Mention 150 150 0 All Passed
Message 242 242 0 All Passed
MultiselectDropdown 379 379 0 All Passed
NumericTextbox 440 440 0 All Passed
OtpInput 123 123 0 All Passed
PivotTable 1371 1371 0 All Passed
ProgressBar 198 198 0 All Passed
progressbutton 101 101 0 All Passed
QueryBuilder 584 584 0 All Passed
RangeNavigator 196 196 0 All Passed
Rating 106 106 0 All Passed
Ribbon 440 440 0 All Passed
RichTextEditor 2150 2150 0 All Passed
Scheduler 5183 5183 0 All Passed
SfPdfViewer2 12313 12313 0 All Passed
Sidebar 105 105 0 All Passed
Signature 106 106 0 All Passed
Skeleton 247 247 0 All Passed
Slider 200 200 0 All Passed
SmithChart 212 212 0 All Passed
SpeechToText 112 112 0 All Passed
SpeedDial 278 278 0 All Passed
Spinner 184 184 0 All Passed
Splitter 538 538 0 All Passed
Stepper 285 285 0 All Passed
StockChart 211 211 0 All Passed
Switch 724 724 0 All Passed
Tabs 287 287 0 All Passed
TextArea 165 165 0 All Passed
Textbox 698 698 0 All Passed
Timeline 236 236 0 All Passed
TimePicker 346 346 0 All Passed
Toast 262 262 0 All Passed
Toolbar 164 164 0 All Passed
Tooltip 474 474 0 All Passed
TreeGrid 3923 3923 0 All Passed
TreeMap 174 174 0 All Passed
TreeView 1565 1565 0 All Passed
DocIO 16538 16538 0 All Passed
Metafilerenderer 863 863 0 All Passed
PDF 13522 13522 0 All Passed
Presentation 54312 54312 0 All Passed
XlsIO 17351 17351 0 All Passed