Skip to content

Commit 9b5c5bb

Browse files
Merge pull request #1952 from syncfusion-content/EJ2-996216-notes
996216: Update the Notes enhancement options in the Notes UG section
2 parents c0875fe + ef67afc commit 9b5c5bb

File tree

11 files changed

+187
-57
lines changed

11 files changed

+187
-57
lines changed

Document-Processing/Excel/Spreadsheet/Angular/notes.md

Lines changed: 79 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ documentation: ug
99

1010
# Notes in Angular Spreadsheet component
1111

12-
The **Notes** feature is used to insert comments, provide feedback, suggest changes, or leave remarks on specific cells while reviewing documents in the Spreadsheet. You can enable or disable the notes functionality using the [`enableNotes`](https://ej2.syncfusion.com/angular/documentation/api/spreadsheet/#enablenotes) property, which defaults to **true**.
12+
The **Notes** feature is used to insert comments, provide feedback, suggest changes, or leave remarks on specific cells while reviewing documents in the Spreadsheet. You can enable or disable the notes functionality using the [enableNotes](https://ej2.syncfusion.com/angular/documentation/api/spreadsheet/index-default#enablenotes) property, which defaults to **true**.
1313

1414
When opening the Excel document with notes in the Spreadsheet, they will be displayed in the control. The cells containing notes will be indicated with a red colored triangle at the top-right corner. Hovering the mouse over these cells will display the content of the notes.
1515

@@ -33,38 +33,103 @@ In the below example, you can add, edit, save, and delete notes.
3333

3434
In the active worksheet, you can add a note in the following ways:
3535

36-
* To add a note, right-click the cell to open the context menu and choose the **"Add Note"** option from the context menu. This will open a dialog box to add the content as a note.
37-
* You can also use the `Shift` + `F2` keyboard shortcut to add a note to the desired cell. A dialog box will be opened to add the content as a note.
38-
* After entering the content in the dialog box, you can either click on other cells or press the `Esc` button on the keyboard to automatically save the note in the cell and close the dialog box.
36+
* **Context Menu**: Right-click the desired cell and select **Add Note**.
37+
* **Ribbon**: Select the cell, navigate to the **Review** tab, click the **Notes** dropdown, and select **Add Note**.
38+
* **Keyboard Shortcut**: Select the cell and press <kbd>Shift</kbd> + <kbd>F2</kbd>.
39+
* **Programmatically**:
40+
* Use the `updateCell` method with the note model to add a note to a specific cell.
41+
* Bind notes via code-behind during initial load by associating the note model with the cell model.
42+
43+
A dialog box will open where you can enter the note content. After entering the content, you can either click on other cells or press the <kbd>Esc</kbd> button to automatically save the note and close the dialog box.
3944

4045
![Adding a note in Spreadsheet](./images/spreadsheet_add_note.gif)
4146

4247
## Editing a note
4348

44-
In the active worksheet, you can modify the content of existing notes in the document.
49+
In the active worksheet, you can modify the content of existing notes in the document:
50+
51+
* **Context Menu**: Right-click the cell containing the note and select **Edit Note**.
52+
* **Ribbon**: Select the cell containing the note, navigate to the **Review** tab, click the **Notes** dropdown, and select **Edit Note**.
53+
* **Keyboard Shortcut**: Select the cell containing the note and press <kbd>Shift</kbd> + <kbd>F2</kbd>.
4554

46-
* To edit a note, right-click on the desired cell containing the note, which will open the context menu.
47-
* Select the **"Edit Note"** option from the context menu.
48-
* You can also use the `Shift` + `F2` keyboard shortcut to edit the note of the desired cell. A dialog box will be opened to edit the note.
49-
* After editing the content in the dialog box, you can either click on other cells or press the `Esc` button on the keyboard to automatically save the note in the cell and close the dialog box.
55+
The note editor dialog box will open with the existing content. After editing the content, you can either click on other cells or press the <kbd>Esc</kbd> button to automatically save the changes and close the dialog box.
5056

5157
![Editing a note in Spreadsheet](./images/spreadsheet_edit_note.gif)
5258

5359
## Deleting a note
5460

55-
In the active worksheet, right-click on the desired cell containing the note that you want to remove, which opens the context menu. In the context menu, select the **"Delete Note"** option to delete the note.
61+
You can remove notes from cells using the following ways:
62+
63+
* **Context Menu**: Right-click the cell containing the note and select **Delete Note**.
64+
* **Ribbon**: Select the cell containing the note, navigate to the **Review** tab, click the **Notes** dropdown, and select **Delete Note**.
65+
66+
The note will be removed from the cell, and the red triangle indicator will be removed.
5667

5768
![Deleting a note in Spreadsheet](./images/spreadsheet_delete_note.gif)
5869

70+
## Navigating between notes
71+
72+
The Syncfusion Spreadsheet provides intuitive navigation to quickly move between cells containing notes in your worksheet. These options are accessible through the **Notes** dropdown in the **Review** tab.
73+
74+
### Previous Note
75+
76+
To navigate to the previous note:
77+
78+
* In the **Review** tab, open the **Notes** dropdown and select **Previous Note**.
79+
* The Spreadsheet will automatically select the previous note in the current worksheet, searching leftward and then upward.
80+
* If no prior note exists in the sheet, the search continues to the previous worksheet in order.
81+
* If the workbook contains no notes, the selection remains on the current cell.
82+
83+
### Next Note
84+
85+
To navigate to the next note:
86+
87+
* In the **Review** tab, open the **Notes** dropdown and select **Next Note**.
88+
* The Spreadsheet will automatically select the next note in the current worksheet, searching rightward and then downward.
89+
* If no subsequent note exists in the sheet, the search continues to the next worksheet in order.
90+
* If the workbook contains no notes, the selection remains on the current cell.
91+
92+
This functionality streamlines the process of reviewing notes across worksheets, ensuring efficient traversal and discovery.
93+
94+
## Show/Hide Note
95+
96+
The **Show/Hide Note** option allows you to toggle the visibility of individual notes as sticky notes within the worksheet. When enabled, the note appears as a persistent floating text box, making it convenient to reference key information without hovering over the cell.
97+
98+
To toggle the visibility of a note:
99+
100+
* **Context Menu**: Right-click the cell containing the note and select **Show/Hide Note**.
101+
* **Ribbon**: Select the cell, go to the **Review** tab, click the **Notes** dropdown, and choose **Show/Hide Note**.
102+
103+
**Behavior:**
104+
105+
* **Default State (Hidden)**: Notes are hidden by default and only appear when hovering over the cell, which displays a red triangle indicator.
106+
* **Sticky State (Visible)**: Toggling Show/Hide Note on a hidden note makes it visible as a sticky note, which remains on display even when navigating to other cells or selections.
107+
* **Toggle Functionality**: Selecting Show/Hide Note again on a visible note hides it, reverting to the default state.
108+
* **Independent Control**: Each note can be toggled individually, allowing you to display only the most relevant notes for your current task.
109+
110+
## Show All Notes
111+
112+
The **Show All Notes** option enables you to display all notes in the current worksheet simultaneously as sticky notes, simplifying the review of multiple comments at a glance.
113+
114+
To activate:
115+
116+
* Navigate to the **Review** tab, click the **Notes** dropdown, and select **Show All Notes**.
117+
118+
All notes in the worksheet will appear as floating text boxes near their respective cells.
119+
120+
> **Note**: After using Show All Notes, you can hide individual notes selectively via the **Show/Hide Note** option. Additionally, any new notes added to the worksheet will automatically appear as visible sticky notes when Show All Notes is active.
121+
122+
This functionality enhances workflow efficiency by providing flexible control over note visibility, whether for individual focus or comprehensive review.
123+
59124
## Saving the document with notes
60125

61-
The Spreadsheet data, including notes, can be saved and exported as an Excel document by selecting **File > Save As** in the ribbon menu. Exporting worksheets with notes is supported in Excel file formats such as MS Excel (.xlsx) and MS Excel 97-2003 (.xls).
126+
The Spreadsheet data, including notes, can be saved and exported as an Excel document by selecting **File > Save As** in the ribbon menu. Exporting worksheets with notes is supported in Excel file formats such as Microsoft Excel (.xlsx) and Microsoft Excel 97-2003 (.xls).
62127

63128
> When exporting the Spreadsheet to file formats such as Comma Separated Values (.csv), Excel Macro-Enabled Workbook (.xlsm), Excel Binary Workbook (.xlsb), and PDF Document (.pdf), the notes will not be available.
64129
65130
## Disabling notes
66131

67-
To disable the note functionality, you need to set the [`enableNotes`](https://ej2.syncfusion.com/angular/documentation/api/spreadsheet/#enablenotes) property to **false**. After disabling, the notes in the document will not be shown when opened in the Spreadsheet. The **"Add Note"** option will not be shown in the context menu. The keyboard shortcuts for the note functionality will not work.
132+
To disable the note functionality, you need to set the [enableNotes](https://ej2.syncfusion.com/angular/documentation/api/spreadsheet/index-default#enablenotes) property to **false**. After disabling, the notes in the document will not be shown when opened in the Spreadsheet. The **"Add Note"** option will not be shown in the context menu. The keyboard shortcuts for the note functionality will not work.
68133

69134
![Spreadsheet with notes feature disabled](./images/spreadsheet_notes_disable.png)
70135

@@ -86,6 +151,8 @@ In the below example, the note functionality is disabled in the Spreadsheet.
86151

87152
The notes can be added initially when the Spreadsheet loads using cell data binding. You need to use the `notes` property in the cell settings to add notes to the Spreadsheet.
88153

154+
In the below example, you can navigate between notes using **Previous Note** and **Next Note** options, toggle individual note visibility with **Show/Hide Note**, display all notes at once using **Show All Notes** and see how notes are added using the `updateCell` method in the `created` event.
155+
89156
{% tabs %}
90157
{% highlight ts tabtitle="app.component.ts" %}
91158
{% include code-snippet/spreadsheet/angular/note-cs3/src/app.component.ts %}

Document-Processing/Excel/Spreadsheet/Javascript-ES6/notes.md

Lines changed: 79 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ documentation: ug
99

1010
# Notes in EJ2 TypeScript Spreadsheet control
1111

12-
The **Notes** feature is used to insert comments, provide feedback, suggest changes, or leave remarks on specific cells while reviewing documents in the Spreadsheet. You can enable or disable the notes functionality using the [`enableNotes`](https://ej2.syncfusion.com/documentation/api/spreadsheet/#enablenotes) property, which defaults to **true**.
12+
The **Notes** feature is used to insert comments, provide feedback, suggest changes, or leave remarks on specific cells while reviewing documents in the Spreadsheet. You can enable or disable the notes functionality using the [enableNotes](https://ej2.syncfusion.com/documentation/api/spreadsheet/index-default#enablenotes) property, which defaults to **true**.
1313

1414
When opening the Excel document with notes in the Spreadsheet, they will be displayed in the control. The cells containing notes will be indicated with a red colored triangle at the top-right corner. Hovering the mouse over these cells will display the content of the notes.
1515

@@ -32,38 +32,103 @@ In the below example, you can add, edit, save, and delete notes.
3232

3333
In the active worksheet, you can add a note in the following ways:
3434

35-
* To add a note, right-click the cell to open the context menu and choose the **"Add Note"** option from the context menu. This will open a dialog box to add the content as a note.
36-
* You can also use the `Shift` + `F2` keyboard shortcut to add a note to the desired cell. A dialog box will be opened to add the content as a note.
37-
* After entering the content in the dialog box, you can either click on other cells or press the `Esc` button on the keyboard to automatically save the note in the cell and close the dialog box.
35+
* **Context Menu**: Right-click the desired cell and select **Add Note**.
36+
* **Ribbon**: Select the cell, navigate to the **Review** tab, click the **Notes** dropdown, and select **Add Note**.
37+
* **Keyboard Shortcut**: Select the cell and press <kbd>Shift</kbd> + <kbd>F2</kbd>.
38+
* **Programmatically**:
39+
* Use the `updateCell` method with the note model to add a note to a specific cell.
40+
* Bind notes via code-behind during initial load by associating the note model with the cell model.
41+
42+
A dialog box will open where you can enter the note content. After entering the content, you can either click on other cells or press the <kbd>Esc</kbd> button to automatically save the note and close the dialog box.
3843

3944
![Adding a note in Spreadsheet](./images/spreadsheet_add_note.gif)
4045

4146
## Editing a note
4247

43-
In the active worksheet, you can modify the content of existing notes in the document.
48+
In the active worksheet, you can modify the content of existing notes in the document:
49+
50+
* **Context Menu**: Right-click the cell containing the note and select **Edit Note**.
51+
* **Ribbon**: Select the cell containing the note, navigate to the **Review** tab, click the **Notes** dropdown, and select **Edit Note**.
52+
* **Keyboard Shortcut**: Select the cell containing the note and press <kbd>Shift</kbd> + <kbd>F2</kbd>.
4453

45-
* To edit a note, right-click on the desired cell containing the note, which will open the context menu.
46-
* Select the **"Edit Note"** option from the context menu.
47-
* You can also use the `Shift` + `F2` keyboard shortcut to edit the note of the desired cell. A dialog box will be opened to edit the note.
48-
* After editing the content in the dialog box, you can either click on other cells or press the `Esc` button on the keyboard to automatically save the note in the cell and close the dialog box.
54+
The note editor dialog box will open with the existing content. After editing the content, you can either click on other cells or press the <kbd>Esc</kbd> button to automatically save the changes and close the dialog box.
4955

5056
![Editing a note in Spreadsheet](./images/spreadsheet_edit_note.gif)
5157

5258
## Deleting a note
5359

54-
In the active worksheet, right-click on the desired cell containing the note that you want to remove, which opens the context menu. In the context menu, select the **"Delete Note"** option to delete the note.
60+
You can remove notes from cells using the following ways:
61+
62+
* **Context Menu**: Right-click the cell containing the note and select **Delete Note**.
63+
* **Ribbon**: Select the cell containing the note, navigate to the **Review** tab, click the **Notes** dropdown, and select **Delete Note**.
64+
65+
The note will be removed from the cell, and the red triangle indicator will be removed.
5566

5667
![Deleting a note in Spreadsheet](./images/spreadsheet_delete_note.gif)
5768

69+
## Navigating between notes
70+
71+
The Syncfusion Spreadsheet provides intuitive navigation to quickly move between cells containing notes in your worksheet. These options are accessible through the **Notes** dropdown in the **Review** tab.
72+
73+
### Previous Note
74+
75+
To navigate to the previous note:
76+
77+
* In the **Review** tab, open the **Notes** dropdown and select **Previous Note**.
78+
* The Spreadsheet will automatically select the previous note in the current worksheet, searching leftward and then upward.
79+
* If no prior note exists in the sheet, the search continues to the previous worksheet in order.
80+
* If the workbook contains no notes, the selection remains on the current cell.
81+
82+
### Next Note
83+
84+
To navigate to the next note:
85+
86+
* In the **Review** tab, open the **Notes** dropdown and select **Next Note**.
87+
* The Spreadsheet will automatically select the next note in the current worksheet, searching rightward and then downward.
88+
* If no subsequent note exists in the sheet, the search continues to the next worksheet in order.
89+
* If the workbook contains no notes, the selection remains on the current cell.
90+
91+
This functionality streamlines the process of reviewing notes across worksheets, ensuring efficient traversal and discovery.
92+
93+
## Show/Hide Note
94+
95+
The **Show/Hide Note** option allows you to toggle the visibility of individual notes as sticky notes within the worksheet. When enabled, the note appears as a persistent floating text box, making it convenient to reference key information without hovering over the cell.
96+
97+
To toggle the visibility of a note:
98+
99+
* **Context Menu**: Right-click the cell containing the note and select **Show/Hide Note**.
100+
* **Ribbon**: Select the cell, go to the **Review** tab, click the **Notes** dropdown, and choose **Show/Hide Note**.
101+
102+
**Behavior:**
103+
104+
* **Default State (Hidden)**: Notes are hidden by default and only appear when hovering over the cell, which displays a red triangle indicator.
105+
* **Sticky State (Visible)**: Toggling Show/Hide Note on a hidden note makes it visible as a sticky note, which remains on display even when navigating to other cells or selections.
106+
* **Toggle Functionality**: Selecting Show/Hide Note again on a visible note hides it, reverting to the default state.
107+
* **Independent Control**: Each note can be toggled individually, allowing you to display only the most relevant notes for your current task.
108+
109+
## Show All Notes
110+
111+
The **Show All Notes** option enables you to display all notes in the current worksheet simultaneously as sticky notes, simplifying the review of multiple comments at a glance.
112+
113+
To activate:
114+
115+
* Navigate to the **Review** tab, click the **Notes** dropdown, and select **Show All Notes**.
116+
117+
All notes in the worksheet will appear as floating text boxes near their respective cells.
118+
119+
> **Note**: After using Show All Notes, you can hide individual notes selectively via the **Show/Hide Note** option. Additionally, any new notes added to the worksheet will automatically appear as visible sticky notes when Show All Notes is active.
120+
121+
This functionality enhances workflow efficiency by providing flexible control over note visibility, whether for individual focus or comprehensive review.
122+
58123
## Saving the document with notes
59124

60-
The Spreadsheet data, including notes, can be saved and exported as an Excel document by selecting **File > Save As** in the ribbon menu. Exporting worksheets with notes is supported in Excel file formats such as MS Excel (.xlsx) and MS Excel 97-2003 (.xls).
125+
The Spreadsheet data, including notes, can be saved and exported as an Excel document by selecting **File > Save As** in the ribbon menu. Exporting worksheets with notes is supported in Excel file formats such as Microsoft Excel (.xlsx) and Microsoft Excel 97-2003 (.xls).
61126

62127
> When exporting the Spreadsheet to file formats such as Comma Separated Values (.csv), Excel Macro-Enabled Workbook (.xlsm), Excel Binary Workbook (.xlsb), and PDF Document (.pdf), the notes will not be available.
63128
64129
## Disabling notes
65130

66-
To disable the note functionality, you need to set the [`enableNotes`](https://ej2.syncfusion.com/documentation/api/spreadsheet/#enablenotes) property to **false**. After disabling, the notes in the document will not be shown when opened in the Spreadsheet. The **"Add Note"** option will not be shown in the context menu. The keyboard shortcuts for the note functionality will not work.
131+
To disable the note functionality, you need to set the [enableNotes](https://ej2.syncfusion.com/documentation/api/spreadsheet/index-default#enablenotes) property to **false**. After disabling, the notes in the document will not be shown when opened in the Spreadsheet. The **Add Note** option will not be shown in the context menu. The keyboard shortcuts for the note functionality will not work.
67132

68133
![Spreadsheet with notes feature disabled](./images/spreadsheet_notes_disable.png)
69134

@@ -84,6 +149,8 @@ In the below example, the note functionality is disabled in the Spreadsheet.
84149

85150
The notes can be added initially when the Spreadsheet loads using cell data binding. You need to use the `notes` property in the cell settings to add notes to the Spreadsheet.
86151

152+
In the below example, you can navigate between notes using **Previous Note** and **Next Note** options, toggle individual note visibility with **Show/Hide Note**, display all notes at once using **Show All Notes** and see how notes are added using the `updateCell` method in the `created` event.
153+
87154
{% tabs %}
88155
{% highlight ts tabtitle="index.ts" %}
89156
{% include code-snippet/spreadsheet/javascript-es6/note-cs3/index.ts %}

0 commit comments

Comments
 (0)