-
Notifications
You must be signed in to change notification settings - Fork 10
996216: Update the Notes enhancement options in the Notes UG section #1952
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: development
Are you sure you want to change the base?
Conversation
|
Build Status: INPROGRESS 🔃 |
|
CI Status: FAILURE ❌ |
|
Build Status: INPROGRESS 🔃 |
|
CI Status: FAILURE ❌ |
|
Build Status: INPROGRESS 🔃 |
|
CI Status: FAILURE ❌ |
|
The running CI Job is terminated due to changes committed on the source branch for this Merge Request and CI triggered for latest commit. |
|
CI Status: ABORTED ❌ |
|
Build Status: INPROGRESS 🔃 |
|
CI Status: FAILURE ❌ |
|
Build Status: INPROGRESS 🔃 |
|
CI Status: SUCCESS ✅ |
|
Build Status: INPROGRESS 🔃 |
|
CI Status: SUCCESS ✅ |
Document-Processing/code-snippet/spreadsheet/javascript-es6/note-cs3/index.ts
Show resolved
Hide resolved
|
Build Status: INPROGRESS 🔃 |
|
CI Status: SUCCESS ✅ |
|
Build Status: INQUEUE 🕒 |
|
Build Status: INPROGRESS 🔃 |
|
CI Status: SUCCESS ✅ |
| # Notes in EJ2 TypeScript Spreadsheet control | ||
|
|
||
| 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**. | ||
| 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**. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
highlight the hyperlink containing APIs like this
enableNotes -> enableNotes
| * **Context Menu**: Right-click on the desired cell and select **Add Note**. | ||
| * **Ribbon**: Select the cell, navigate to the **Review** tab, click the **Notes** dropdown, and select **Add Note**. | ||
| * **Keyboard Shortcut**: Select the cell and press `Shift` + `F2`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- Context menu: Right‑click the cell and select Add Note.
- Ribbon: Select the cell, then go to Review > Notes > Add Note.
- Keyboard shortcut: Select the cell and press Shift+F2.
Use keyboard tag instead of bold or for "Shift+F2".
Refer - https://help.syncfusion.com/document-processing/excel/spreadsheet/blazor/accessibility#keyboard-shortcuts
| * **Ribbon**: Select the cell, navigate to the **Review** tab, click the **Notes** dropdown, and select **Add Note**. | ||
| * **Keyboard Shortcut**: Select the cell and press `Shift` + `F2`. | ||
|
|
||
| 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 `Esc` button to automatically save the note and close the dialog box. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A note editor popup opens where you can enter the content. To save and close the popup, click anywhere outside the editor or press Esc; the note is saved automatically.
Use keyboard tag instead of bold or for "Esc".
Refer - https://help.syncfusion.com/document-processing/excel/spreadsheet/blazor/accessibility#keyboard-shortcuts
| In the active worksheet, you can modify the content of existing notes in the document. | ||
| In the active worksheet, you can modify the content of existing notes in the document: | ||
|
|
||
| * **Context Menu**: Right-click on the cell containing the note and select **Edit Note**. | ||
| * **Ribbon**: Select the cell containing the note, navigate to the **Review** tab, click the **Notes** dropdown, and select **Edit Note**. | ||
| * **Keyboard Shortcut**: Select the cell containing the note and press `Shift` + `F2`. | ||
|
|
||
| * To edit a note, right-click on the desired cell containing the note, which will open the context menu. | ||
| * Select the **"Edit Note"** option from the context menu. | ||
| * 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. | ||
| * 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. | ||
| 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 `Esc` button to automatically save the changes and close the dialog box. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
In the active worksheet, you can edit the content of an existing note in following ways:
- Context menu: Right-click the cell that contains the note and select Edit Note.
- Ribbon: Select the cell, go to Review > Notes, and choose Edit Note.
- Keyboard shortcut: Select the cell and press Shift+F2.
The note editor opens with the existing content. After making changes, click anywhere outside the editor or press Esc to automatically save and close the popup.
Use keyboard tag instead of bold or for "Shift+F2" and "Esc".
Refer - https://help.syncfusion.com/document-processing/excel/spreadsheet/blazor/accessibility#keyboard-shortcuts
|
|
||
| ## Navigating between notes | ||
|
|
||
| The Syncfusion Spreadsheet provides intuitive navigation features to quickly move between cells containing notes in your worksheet. These options are accessible through the Notes dropdown in the Review tab. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The Syncfusion Spreadsheet provides intuitive navigation features to quickly navigate between cells containing notes in your worksheet. These options are accessible through the Notes dropdown in the Review tab.
| * Select **Previous Note** from the **Notes** dropdown in the **Review** tab. | ||
| * The Spreadsheet will automatically select the cell containing the previous note, scanning the worksheet leftward and upward. | ||
| * If no prior note is found in the current worksheet, the search continues to the preceding worksheet in a sequential manner. | ||
| * If no notes are present in the entire workbook, the selection stays on the current cell. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- In the Review tab, open the Notes dropdown and select Previous Note.
- The Spreadsheet will automatically select the previous note in the current worksheet, searching leftward and then upward.
- If no prior note exists in the sheet, the search continues to the previous worksheet in order.
- If the workbook contains no notes, the selection remains on the current cell.
|
|
||
| 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. | ||
|
|
||
| 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
|
|
||
| ## Integrating notes during initial loading and using cell data binding | ||
|
|
||
| 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Add Hyperlink to notes property
| ## Deleting a note | ||
|
|
||
| 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. | ||
| You can remove notes from cells using the following methods: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
methods -> ways
|
|
||
| ## Show/Hide Note | ||
|
|
||
| The **Show/Hide Note** feature 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The Show/Hide Note allows you to toggle the visibility of individual notes as sticky notes within the worksheet.
Update the Notes enhancement options in the Notes UG. Ensure to add all the provided Notes options and its use cases:
New Note – Create a new note on the selected cell.
Previous Note – Navigate to the previous note in the worksheet.
Next Note – Navigate to the next note in the worksheet.
Show/Hide Note – Toggle visibility of the note on the selected cell.
Show All Notes – Display all notes present in the worksheet.