Skip to content

Commit 3677301

Browse files
996176: Added the UG for completed features, API and events.
1 parent 6f10b77 commit 3677301

File tree

12 files changed

+50
-37
lines changed

12 files changed

+50
-37
lines changed

Document-Processing/Excel/Spreadsheet/Blazor/cell-range.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ The event uses the [AutofillActionBeginEventArgs](https://help.syncfusion.com/cr
125125
{% endhighlight %}
126126
{% endtabs %}
127127

128-
**AutofillActionEnd**
128+
### AutofillActionEnd
129129

130130
The `AutofillActionEnd` event is triggered after an autofill operation has been successfully completed. This event provides detailed information about the completed autofill action, enabling further processing or logging if required.
131131

Document-Processing/Excel/Spreadsheet/Blazor/editing.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -86,11 +86,11 @@ To exit edit mode without saving changes, press the **ESCAPE** key. This action
8686

8787
## Events
8888

89-
The Blazor Spreadsheet provides events that are triggered during editing operations, such as [CellEditing](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Spreadsheet.CellEditingEventArgs.html) and [CellSaved](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Spreadsheet.CellSavedEventArgs.html). These events enable the execution of custom actions before and after a cell edit, allowing for validation, customization, and response handling.
89+
The Blazor Spreadsheet component provides events that are triggered during editing operations, such as [CellEditing](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Spreadsheet.CellEditingEventArgs.html) and [CellSaved](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Spreadsheet.CellSavedEventArgs.html). These events allow you to perform custom actions before a cell enters edit mode and after its value has been successfully saved, enabling scenarios such as data validation or logging changes.
9090

9191
### CellEditing
9292

93-
The `CellEditing` event is triggered before a cell enters edit mode, allowing for validation or cancellation of the edit operation.
93+
The `CellEditing` event is triggered before a cell enters edit mode. It provides an opportunity to validate or cancel the edit operation.
9494

9595
**Purpose**
9696

@@ -102,10 +102,10 @@ The event uses the [CellEditingEventArgs](https://help.syncfusion.com/cr/blazor/
102102

103103
| Event Arguments | Description |
104104
|---|---|
105-
| RowIndex | The zero-based row index of the cell being edited. |
106-
| ColIndex | The zero-based column index of the cell being edited. |
107-
| Address | The address of the cell being edited (e.g., "A1"). |
108-
| Value | The current value of the cell before editing. |
105+
| RowIndex (read-only)| The zero-based row index of the cell being edited. |
106+
| ColIndex (read-only)| The zero-based column index of the cell being edited. |
107+
| Address (read-only)| The address of the cell being edited (e.g., "Sheet1!A1"). |
108+
| Value (read-only)| The current value of the cell before editing. |
109109
| Cancel | Set to `true` to cancel the editing operation. |
110110

111111
{% tabs %}
@@ -140,22 +140,22 @@ The event uses the [CellEditingEventArgs](https://help.syncfusion.com/cr/blazor/
140140

141141
### CellSaved
142142

143-
The `CellSaved` event is raised after a cell's value has been successfully saved, providing details about the change and the action that triggered it.
143+
The `CellSaved` event is triggered after a cells value has been successfully saved, providing details about the updated value and the action that caused the change (such as Edit, Cut, Paste, or Autofill).
144144

145145
**Purpose**
146146

147-
This event is useful for scenarios where post-editing actions are needed, such as logging the cell change, updating related data, or triggering additional UI updates.
147+
This event is useful for scenarios where post-editing actions are needed, such as logging the cell change or refreshing the UI.
148148

149149
**Event Arguments**
150150

151151
The event uses the [CellSavedEventArgs](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Spreadsheet.CellSavedEventArgs.html) class, which includes the following properties:
152152

153153
| Event Arguments | Description |
154154
|---|---|
155-
| Address | The address of the cell whose value was saved (e.g., "A1"). |
156-
| Value | The new value of the cell after saving. |
157-
| OldValue | The original value of the cell before saving. |
158-
| Action | The action that triggered the save (e.g., "Edit", "Cut", "Paste", "Autofill"). |
155+
| Address (read-only)| The address of the cell whose value was saved (e.g., "Sheet1!A1"). |
156+
| Value (read-only)| The new value of the cell after saving. |
157+
| OldValue (read-only)| The original value of the cell before saving. |
158+
| Action (read-only)| The action that triggered the save (e.g., "Edit", "Cut", "Paste", "Autofill"). |
159159

160160
{% tabs %}
161161
{% highlight razor tabtitle="Index.razor" %}

Document-Processing/Excel/Spreadsheet/Blazor/events.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,17 @@ The Blazor Spreadsheet component provides various events that allow you to inter
1313

1414
| Event Name | Description |
1515
|---|---|
16-
| [AutoFillActionBegin](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Spreadsheet.AutofillActionBeginEventArgs.html) | Triggers when an autofill operation starts. |
17-
| [AutoFillActionEnd](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Spreadsheet.AutofillActionEndEventArgs.html) | Triggers when an autofill operation completes. |
16+
| [AutofillActionBegin](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Spreadsheet.AutofillActionBeginEventArgs.html) | Triggers when an autofill operation starts. |
17+
| [AutofillActionEnd](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Spreadsheet.AutofillActionEndEventArgs.html) | Triggers when an autofill operation completes. |
18+
| [BeforeSave](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Spreadsheet.BeforeSaveEventArgs.html) | Triggers just before the workbook is saved. |
1819
| [CellEditing](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Spreadsheet.CellEditingEventArgs.html) | Triggers when a cell enters edit mode. |
1920
| [CellSaved](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Spreadsheet.CellSavedEventArgs.html) | Triggers when a cell's value is saved. |
21+
| [ColumnResizing](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Spreadsheet.ColumnResizingEventArgs.html) | Triggers when a column is being resized. |
2022
| [CutCopyActionBegin](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Spreadsheet.CutCopyActionBeginEventArgs.html) | Triggers when a cut or copy operation starts. |
2123
| [HyperlinkClick](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Spreadsheet.HyperlinkClickEventArgs.html) | Triggers when a hyperlink is clicked. |
2224
| [HyperlinkCreated](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Spreadsheet.HyperlinkCreatedEventArgs.html) | Triggers when a hyperlink is successfully added. |
2325
| [HyperlinkCreating](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Spreadsheet.HyperlinkCreatingEventArgs.html) | Triggers when a hyperlink is being created. |
2426
| [Pasting](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Spreadsheet.PastingEventArgs.html) | Triggers when a paste operation starts. |
27+
| [RowResizing](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Spreadsheet.RowResizingEventArgs.html) | Triggers when a row is being resized. |
28+
| [Selected](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Spreadsheet.SelectedEventArgs.html) | Triggers when a cell or range of cells is selected. |
29+
| [WorksheetAdding](https://help.syncfusion.com/cr/blazor/Syncfusion.Blazor.Spreadsheet.WorksheetAddingEventArgs.html) | Triggers before a new worksheet is added. |

Document-Processing/Excel/Spreadsheet/Blazor/formatting.md

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,15 @@ The Blazor Spreadsheet component provides several built-in number format categor
4040
| Long Date | `dddd, mmmm dd, yyyy` | Saturday, March 15, 2025 |
4141
| Time | `h:mm:ss AM/PM` | 3:45:30 PM |
4242

43-
### Applying Number Formats via the UI
43+
### Applying Number Formats via UI
4444

4545
Number formats can be applied through the UI using the following method:
4646

47-
* **Ribbon**: Navigate to the **Home** tab and use the **Number Format** dropdown. This dropdown displays previews of built-in formats based on the current culture.
47+
* Click the **Home** tab in the Ribbon.
48+
* Open the **Number Format** dropdown.
49+
* The dropdown displays previews of built-in formats based on the current culture.
4850

49-
![Blazor Spreadsheet showing Number Format Dropdown in Ribbon](./images/number-format-ribbon.png)
51+
![Blazor Spreadsheet showing Number Format Dropdown in Ribbon](./images/number-format-ribbon.gif)
5052

5153
### Applying Number Formats Programmatically
5254

@@ -55,7 +57,7 @@ Number formats can be applied programmatically to the current selection or a spe
5557
| Parameter | Type | Description |
5658
| -- | -- | -- |
5759
| format | string | The built-in format or a supported custom pattern. |
58-
| cellAddress | string (Optional) | The address of the target range where the number format was applied (e.g., `"Sheet1!A2:A5"` or `"A2:A5"`).When cellAddress is omitted, the current selection is formatted. |
60+
| cellAddress | string (Optional) | The address of the target range where the number format is applied (e.g., `"Sheet1!A2:A5"` or `"A2:A5"`). If the sheet name is not specified, the number format is applied to the specified range in the active sheet. When cellAddress is omitted, the current selection is formatted. |
5961

6062
{% tabs %}
6163
{% highlight razor tabtitle="Index.razor" %}
@@ -88,13 +90,15 @@ Number formats can be applied programmatically to the current selection or a spe
8890
{% endhighlight %}
8991
{% endtabs %}
9092

91-
If the built-in formats do not meet specific requirements, custom patterns can be applied programmatically using the `NumberFormatAsync` method. Currently, a dedicated UI dialog for defining custom formats is not available. They are exclusively supported through the API. Patterns must be compatible with Excel-style format strings.
93+
> 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.
9294
9395
## Text and Cell Formatting
9496

9597
Text and cell formatting enhances the visual presentation of data by applying styles such as font changes, colors, borders, and alignment to individual cells or cell ranges. This helps organize content and emphasize important information for faster interpretation.
9698

97-
### Text and cell formatting options include:
99+
### Text Formatting
100+
101+
Text formatting options include:
98102

99103
* **Bold** - Applies a heavier font weight to make the text stand out in the Spreadsheet.
100104

@@ -110,6 +114,10 @@ Text and cell formatting enhances the visual presentation of data by applying st
110114

111115
* **Font Color** - Changes the color of the text to improve visual hierarchy or to organize information using color codes.
112116

117+
### Cell Formatting
118+
119+
Cell formatting options include:
120+
113121
* **Fill Color** - Adds color to the cell background to visually organize data or highlight important information.
114122

115123
* **Horizontal Alignment** - Controls the position of text from left to right within a cell. Options include:
@@ -150,21 +158,23 @@ Border color, size, and style can also be customized. The supported sizes and st
150158

151159
| Type | Description |
152160
|--------|----------------------------------|
153-
| Thin | Specifies a `1px` border size (default). |
161+
| Thin | Specifies a `1px` border size. |
154162
| Medium | Specifies a `2px` border size. |
155163
| Thick | Specifies a `3px` border size. |
156-
| Solid | Creates a `solid` border (default). |
164+
| Solid | Creates a `solid` border. |
157165
| Dashed | Creates a `dashed` border.|
158166
| Dotted | Creates a `dotted` border.|
159167
| Double | Creates a `double` border.|
160168

161-
### Applying Borders via the UI
169+
### Applying Borders via UI
162170

163171
Borders can be applied through the UI using the following method:
164172

165-
* **Ribbon**: Navigate to the **Home** tab in the Ribbon toolbar and select the **Borders** dropdown. Styling options such as color, size, and style are available within the same menu.
173+
* Click the **Home** tab in the Ribbon.
174+
* Open the **Borders** dropdown.
175+
* Select the desired border style, color, and size from the dropdown.
166176

167-
![Blazor Spreadsheet displaying available border options on the Home tab in the Ribbon toolbar](./images/borders.png)
177+
![Blazor Spreadsheet displaying available border options on the Home tab in the Ribbon toolbar](./images/borders.gif)
168178

169179
### Applying Borders Programmatically
170180

319 KB
Loading
-121 KB
Binary file not shown.
132 KB
Loading
Binary file not shown.
319 KB
Loading
Binary file not shown.

0 commit comments

Comments
 (0)