diff --git a/Document-Processing/Excel/Spreadsheet/Blazor/cell-range.md b/Document-Processing/Excel/Spreadsheet/Blazor/cell-range.md index 5eaaad9c8..d5ed784be 100644 --- a/Document-Processing/Excel/Spreadsheet/Blazor/cell-range.md +++ b/Document-Processing/Excel/Spreadsheet/Blazor/cell-range.md @@ -25,6 +25,35 @@ Autofill can be performed in one of the following ways: * Drag and drop the cell using the fill handle element. * Use the [AutofillAsync()](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Spreadsheet.SfSpreadsheet.html#Syncfusion_Blazor_Spreadsheet_SfSpreadsheet_AutofillAsync_System_String_System_String_) method programmatically. +### Autofill options + +Autofill supports multiple behaviors that control how adjacent cells are populated when using the fill handle. The available options are: + +- Copy Cells +- Fill Series +- Fill Formatting Only +- Fill Without Formatting + +#### Copy Cells + +Copies the source cell content and formatting to the selected destination range. After dragging the fill handle from the selection to the target area, choose **Copy Cells** from the **AutoFillOption** menu to replicate both values and presentation. When the source contains formulas, relative references are adjusted to match the destination. + +#### Fill Series + +Extends a recognizable pattern—such as numbers (1, 2, 3), days or months (Mon, Tue; Jan, Feb), or dates—into the destination range while preserving the source formatting. Drag the fill handle to the target cells and choose **Fill Series** in the **AutoFillOptions** menu to continue the detected sequence. + +#### Fill Formatting Only + +Applies only the source styling—number format, font, fill color, borders, and alignment—to the destination range, leaving existing values unchanged. Drag the fill handle over the target cells and select **Fill Formatting Only** from the **AutoFillOptions** menu to unify appearance without altering data. + +#### Fill Without Formatting + +Continues the detected series into the destination range but retains the destination’s existing formatting. After dragging the fill handle, choose **Fill Without Formatting** from the **AutoFillOptions** menu to apply only the new values while keeping the target style intact. + +The following illustration demonstrates the use of autofill in the Spreadsheet component. + +![Autofill Illustration](images/autofill.gif) + The `AutofillAsync()` method accepts string parameters in A1 notation for `fillRange` and `dataRange`. The available parameters are: | Parameter | Type | Description | @@ -65,10 +94,6 @@ The `AutofillAsync()` method accepts string parameters in A1 notation for `fillR {% endhighlight %} {% endtabs %} -The following illustration demonstrates the use of autofill in the Spreadsheet component. - -![Autofill Illustration](images/autofill.gif) - ## Events The Blazor Spreadsheet provides events that are triggered during autofill operations, such as [AutofillActionBegin](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Spreadsheet.AutofillActionBeginEventArgs.html) and [AutofillActionEnd](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Spreadsheet.AutofillActionEndEventArgs.html). These events enable the execution of custom actions before and after an autofill operation, allowing for validation, customization, and response handling. diff --git a/Document-Processing/Excel/Spreadsheet/Blazor/formatting.md b/Document-Processing/Excel/Spreadsheet/Blazor/formatting.md index 7d5c00ecc..85ba0191b 100644 --- a/Document-Processing/Excel/Spreadsheet/Blazor/formatting.md +++ b/Document-Processing/Excel/Spreadsheet/Blazor/formatting.md @@ -90,7 +90,7 @@ Number formats can be applied programmatically to the current selection or a spe {% endhighlight %} {% endtabs %} -> If the built-in formats do not meet specific requirements, custom patterns can be applied programmatically using the `NumberFormatAsync` method. Patterns must be compatible with Excel-style format strings. +N> If the built-in formats do not meet specific requirements, custom patterns can be applied programmatically using the `NumberFormatAsync` method. Patterns must be compatible with Excel-style format strings. ## Text and Cell Formatting @@ -178,7 +178,7 @@ Borders can be applied through the UI using the following method: ### Applying Borders Programmatically -Borders can be applied programmatically to a specific cell or range of cells using the [SetBordersAsync](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Spreadsheet.SfSpreadsheet.html#Syncfusion_Blazor_Spreadsheet_SfSpreadsheet_SetBordersAsync_Syncfusion_Blazor_Spreadsheet_BorderType_Syncfusion_XlsIO_ExcelLineStyle_System_String_System_String) method. The available parameters in the `SetBordersAsync` method are: +Borders can be applied programmatically to a specific cell or range of cells using the [SetBordersAsync](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Spreadsheet.SfSpreadsheet.html#Syncfusion_Blazor_Spreadsheet_SfSpreadsheet_SetBordersAsync_Syncfusion_Blazor_Spreadsheet_BorderType_Syncfusion_XlsIO_ExcelLineStyle_System_String_System_String_) method. The available parameters in the `SetBordersAsync` method are: | Parameter | Type | Description | | -- | -- | -- | diff --git a/Document-Processing/Excel/Spreadsheet/Blazor/images/autofill.gif b/Document-Processing/Excel/Spreadsheet/Blazor/images/autofill.gif index 19637ebf1..c4b929e26 100644 Binary files a/Document-Processing/Excel/Spreadsheet/Blazor/images/autofill.gif and b/Document-Processing/Excel/Spreadsheet/Blazor/images/autofill.gif differ diff --git a/Document-Processing/Excel/Spreadsheet/Blazor/merge-cell.md b/Document-Processing/Excel/Spreadsheet/Blazor/merge-cell.md index 0653c50d8..953dd30a2 100644 --- a/Document-Processing/Excel/Spreadsheet/Blazor/merge-cell.md +++ b/Document-Processing/Excel/Spreadsheet/Blazor/merge-cell.md @@ -47,11 +47,11 @@ N> Clicking the **Merge Cells** button (not the drop-down) applies the default a ### Merge cells programmatically -The [MergeAsync](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Spreadsheet.SfSpreadsheet.html#Syncfusion_Blazor_Spreadsheet_SfSpreadsheet_MergeAsync_System_String_System_String_) method merges cells based on the specified merge type. If the **cellRange** parameter is not provided, the current selection is used. This method provides a programmatic way to merge cells without using the UI. The available parameters in the `MergeAsync` method are: +The [MergeAsync](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Spreadsheet.SfSpreadsheet.html#Syncfusion_Blazor_Spreadsheet_SfSpreadsheet_MergeAsync_Syncfusion_Blazor_Spreadsheet_MergeType_System_String_) method merges cells based on the specified merge type. If the **cellRange** parameter is not provided, the current selection is used. This method provides a programmatic way to merge cells without using the UI. The available parameters in the `MergeAsync` method are: | Parameter | Type | Description | | -- | -- | -- | -| mergeType | **MergeType** | Specifies the merge behavior.

the Default MergeType is `MergeType.Cells`. Supported values:
- `Cells` - Merge the entire selection into one cell and preserve the top-left value;
- `Center` - Merge the entire selection and horizontally center the resulting cell’s content;
- `Across` - For each row in the selection, merge the cells across columns and preserve each row’s first cell value. | +| mergeType | **MergeType** | Specifies the merge behavior.

The default **MergeType** is `MergeType.Cells`. Supported values:
• `Cells` - Merge the entire selection into one cell and preserve the top-left value;
• `Center`- Merge the entire selection and horizontally center the resulting cell’s content;
• `Across` - For each row in the selection, merge the cells across columns and preserve each row’s first cell value. | | cellRange | string (optional) | Specifies the A1-style address of the range to unmerge (e.g., `"A1:D1"`). If not provided, the currently selected range will be unmerged. | {% tabs %} @@ -112,7 +112,7 @@ The [MergeAsync](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Spreads ### Unmerge cells programmatically. -The [UnmergeAsync](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Spreadsheet.SfSpreadsheet.html#Syncfusion_Blazor_Spreadsheet_SfSpreadsheet_UnmergeAsync_System_String_System_String_) method reverses a merge and restores individual cells. If the **cellRange** parameter is not provided, the current selection cell is unmerged. This method provides a programmatic way to unmerge cells without using the UI. The available parameters in the `UnmergeAsync` method are: +The [UnmergeAsync](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Spreadsheet.SfSpreadsheet.html#Syncfusion_Blazor_Spreadsheet_SfSpreadsheet_UnmergeAsync_System_String_) method reverses a merge and restores individual cells. If the **cellRange** parameter is not provided, the current selection cell is unmerged. This method provides a programmatic way to unmerge cells without using the UI. The available parameters in the `UnmergeAsync` method are: | Parameter | Type | Description | | -- | -- | -- | @@ -149,7 +149,7 @@ The [UnmergeAsync](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Sprea {% endhighlight %} {% endtabs %} -### Limitations of Merge +## Limitations of Merge When merging cells in the Blazor Spreadsheet, certain constraints apply to ensure data integrity. In these cases, validation messages are displayed: diff --git a/Document-Processing/Excel/Spreadsheet/Blazor/worksheet.md b/Document-Processing/Excel/Spreadsheet/Blazor/worksheet.md index 9b444dc2b..cc92a26d9 100644 --- a/Document-Processing/Excel/Spreadsheet/Blazor/worksheet.md +++ b/Document-Processing/Excel/Spreadsheet/Blazor/worksheet.md @@ -71,6 +71,83 @@ This method inserts one or more sheets at a specified position in the workbook w {% endhighlight %} {% endtabs %} + +### Get Active Worksheet Programmatically + +The [GetActiveWorksheet](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Spreadsheet.SfSpreadsheet.html#Syncfusion_Blazor_Spreadsheet_SfSpreadsheet_GetActiveWorksheet) method retrieves properties of the active worksheet. This method is useful when it is necessary to obtain details about the currently active sheet. If no worksheet is active, this method returns null. + +**Retrieve the active worksheet** + +This method retrieves details of the currently active worksheet. Properties of the active worksheet, such as sheet name, index, or selected range, can be accessed for diagnostics, automation, or integration with other logic. + +{% tabs %} +{% highlight razor %} +@using Syncfusion.Blazor.Spreadsheet + + + + + + +@code { + public byte[] DataSourceBytes { get; set; } + public SfSpreadsheet SpreadsheetInstance; + + protected override void OnInitialized() + { + string filePath = "wwwroot/Sample.xlsx"; + DataSourceBytes = File.ReadAllBytes(filePath); + } + + public async Task GetActiveWorksheet() + { + // Get the active sheet snapshot + var active = SpreadsheetInstance.GetActiveWorksheet(); + } +} +{% endhighlight %} +{% endtabs %} + +### Get Worksheet Data Programmatically + +The [GetData](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Spreadsheet.SfSpreadsheet.html#Syncfusion_Blazor_Spreadsheet_SfSpreadsheet_GetData_System_String_) method retrieves content from the worksheet. This method provides data as a dictionary, where each entry consists of a cell address and its associated `CellData` object. The returned data includes the actual value, number format, display text, wrap and lock status, hyperlinks, and calculated style of each cell in the target area. If the specified cell address is invalid or not set, the method returns null. + +**Retrieve cell or range data from an active worksheet** + +Call this method by passing the desired cell or range as the address. For example, provide a reference such as "A1" for a single cell, "A2:B5" for a range, or "Sheet1!A2:B5" to target a range on a specific sheet. The result can be iterated to read individual cell data for further processing, logging, or custom display. + +| Parameter | Type | Description | +| :-- | :-- | :-- | +| cellAddress | string | Specifies the cell or range to read. Supports addresses such as "A1", "A2:B5", or "Sheet1!A2:B5". If omitted or invalid, the return value is null. | + +{% tabs %} +{% highlight razor %} +@using Syncfusion.Blazor.Spreadsheet + + + + + + +@code { + public byte[] DataSourceBytes { get; set; } + public SfSpreadsheet SpreadsheetInstance; + + protected override void OnInitialized() + { + string filePath = "wwwroot/Sample.xlsx"; + DataSourceBytes = File.ReadAllBytes(filePath); + } + + public async Task GetData() + { + // Get the cellData snapshot + var data = SpreadsheetInstance.GetData("Sheet2!D5:E6"); + } +} +{% endhighlight %} +{% endtabs %} + **Insert a single sheet with a user-defined name** This method adds one sheet at a specific position with a user-defined name. Each call to this method adds only one sheet. Using meaningful names like "Budget" or "Inventory" makes the workbook easier to understand. If a negative index value is provided, the method will exit without adding any sheet.