You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: Document-Processing/Excel/Spreadsheet/Angular/notes.md
+76-12Lines changed: 76 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ documentation: ug
9
9
10
10
# Notes in Angular Spreadsheet component
11
11
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**.
13
13
14
14
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.
15
15
@@ -33,38 +33,100 @@ In the below example, you can add, edit, save, and delete notes.
33
33
34
34
In the active worksheet, you can add a note in the following ways:
35
35
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
+
40
+
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.
39
41
40
42
41
43
42
44
## Editing a note
43
45
44
-
In the active worksheet, you can modify the content of existing notes in the document.
46
+
In the active worksheet, you can modify the content of existing notes in the document:
47
+
48
+
***Context Menu**: Right-click the cell containing the note and select **Edit Note**.
49
+
***Ribbon**: Select the cell containing the note, navigate to the **Review** tab, click the **Notes** dropdown, and select **Edit Note**.
50
+
***Keyboard Shortcut**: Select the cell containing the note and press <kbd>Shift</kbd> + <kbd>F2</kbd>.
45
51
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.
52
+
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.
50
53
51
54
52
55
53
56
## Deleting a note
54
57
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.
58
+
You can remove notes from cells using the following ways:
59
+
60
+
***Context Menu**: Right-click the cell containing the note and select **Delete Note**.
61
+
***Ribbon**: Select the cell containing the note, navigate to the **Review** tab, click the **Notes** dropdown, and select **Delete Note**.
62
+
63
+
The note will be removed from the cell, and the red triangle indicator will be removed.
56
64
57
65
58
66
67
+
## Navigating between notes
68
+
69
+
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.
70
+
71
+
### Previous Note
72
+
73
+
To navigate to the previous note:
74
+
75
+
* In the **Review** tab, open the **Notes** dropdown and select **Previous Note**.
76
+
* The Spreadsheet will automatically select the previous note in the current worksheet, searching leftward and then upward.
77
+
* If no prior note exists in the sheet, the search continues to the previous worksheet in order.
78
+
* If the workbook contains no notes, the selection remains on the current cell.
79
+
80
+
### Next Note
81
+
82
+
To navigate to the next note:
83
+
84
+
* In the **Review** tab, open the **Notes** dropdown and select **Next Note**.
85
+
* The Spreadsheet will automatically select the next note in the current worksheet, searching rightward and then downward.
86
+
* If no subsequent note exists in the sheet, the search continues to the next worksheet in order.
87
+
* If the workbook contains no notes, the selection remains on the current cell.
88
+
89
+
This functionality streamlines the process of reviewing notes across worksheets, ensuring efficient traversal and discovery.
90
+
91
+
## Show/Hide Note
92
+
93
+
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.
94
+
95
+
To toggle the visibility of a note:
96
+
97
+
***Context Menu**: Right-click the cell containing the note and select **Show/Hide Note**.
98
+
***Ribbon**: Select the cell, go to the **Review** tab, click the **Notes** dropdown, and choose **Show/Hide Note**.
99
+
100
+
**Behavior:**
101
+
102
+
***Default State (Hidden)**: Notes are hidden by default and only appear when hovering over the cell, which displays a red triangle indicator.
103
+
***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.
104
+
***Toggle Functionality**: Selecting Show/Hide Note again on a visible note hides it, reverting to the default state.
105
+
***Independent Control**: Each note can be toggled individually, allowing you to display only the most relevant notes for your current task.
106
+
107
+
## Show All Notes
108
+
109
+
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.
110
+
111
+
To activate:
112
+
113
+
* Navigate to the **Review** tab, click the **Notes** dropdown, and select **Show All Notes**.
114
+
115
+
All notes in the worksheet will appear as floating text boxes near their respective cells.
116
+
117
+
> **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.
118
+
119
+
This functionality enhances workflow efficiency by providing flexible control over note visibility, whether for individual focus or comprehensive review.
120
+
59
121
## Saving the document with notes
60
122
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).
123
+
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).
62
124
63
125
> 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.
64
126
65
127
## Disabling notes
66
128
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.
129
+
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.
68
130
69
131
70
132
@@ -86,6 +148,8 @@ In the below example, the note functionality is disabled in the Spreadsheet.
86
148
87
149
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.
88
150
151
+
In the below example, you can navigate between notes using **Previous Note** and **Next Note** options, toggle individual note visibility with **Show/Hide Note**, and display all notes at once using **Show All Notes**.
152
+
89
153
{% tabs %}
90
154
{% highlight ts tabtitle="app.component.ts" %}
91
155
{% include code-snippet/spreadsheet/angular/note-cs3/src/app.component.ts %}
Copy file name to clipboardExpand all lines: Document-Processing/Excel/Spreadsheet/Javascript-ES6/notes.md
+3-2Lines changed: 3 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -35,6 +35,7 @@ In the active worksheet, you can add a note in the following ways:
35
35
***Context Menu**: Right-click the desired cell and select **Add Note**.
36
36
***Ribbon**: Select the cell, navigate to the **Review** tab, click the **Notes** dropdown, and select **Add Note**.
37
37
***Keyboard Shortcut**: Select the cell and press <kbd>Shift</kbd> + <kbd>F2</kbd>.
38
+
***Programmatically**: Use the `updateCell` method with the note model to add a note to a specific cell.
38
39
39
40
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.
40
41
@@ -144,9 +145,9 @@ In the below example, the note functionality is disabled in the Spreadsheet.
144
145
145
146
## Integrating notes during initial loading and using cell data binding
146
147
147
-
The notes can be added initially when the Spreadsheet loads using cell data binding. You need to use the [notes](https://ej2.syncfusion.com/documentation/api/spreadsheet/cell#notes) property in the cell settings to add notes to the Spreadsheet.
148
+
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.
148
149
149
-
In the below example, you can navigate between notes using **Previous Note** and **Next Note** options, toggle individual note visibility with **Show/Hide Note**, and display all notes at once using **Show All Notes**.
150
+
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 how notes are added using `updateCell` method in the `created` event.
0 commit comments