Arbeiten mit Notizen mithilfe der Excel-JavaScript-API

2025-06-26

In diesem Artikel wird beschrieben, wie Sie Notizen in einer Arbeitsmappe mit der Excel-JavaScript-API hinzufügen, ändern und entfernen. Weitere Informationen zu Notizen finden Sie im Artikel Einfügen von Kommentaren und Notizen in Excel . Informationen zu den Unterschieden zwischen Notizen und Kommentaren finden Sie unter Der Unterschied zwischen Kommentarthreads und Notizen.

Notizen sind an eine einzelne Zelle gebunden. Jeder, der die Arbeitsmappe mit ausreichenden Berechtigungen anzeigt, kann eine Notiz anzeigen. Notizen in einer Arbeitsmappe werden von der Workbook.notes -Eigenschaft nachverfolgt. Dies schließt Notizen ein, die von Benutzern erstellt wurden, und auch Notizen, die von Ihrem Add-In erstellt wurden. Die Workbook.notes -Eigenschaft ist ein NoteCollection-Objekt , das eine Auflistung von Note-Objekten enthält. Notizen sind auch auf Arbeitsblattebene zugänglich.

Tipp

Informationen zum Hinzufügen und Bearbeiten von Kommentaren mit der Excel-JavaScript-API finden Sie unter Arbeiten mit Kommentaren mithilfe der Excel-JavaScript-API.

Hinzufügen einer Notiz

Verwenden Sie die NoteCollection.add -Methode, um einer Arbeitsmappe Notizen hinzuzufügen. Diese Methode akzeptiert zwei Parameter:

cellAddress: Die Zelle, in der der Kommentar hinzugefügt wird. Dies kann entweder eine Zeichenfolge oder ein Range-Objekt sein. Der Bereich muss eine einzelne Zelle sein.
content: Der Inhalt des Kommentars als Zeichenfolge.

Das folgende Codebeispiel zeigt, wie Sie der ausgewählten Zelle in einem Arbeitsblatt eine Notiz hinzufügen.

await Excel.run(async (context) => {
    // This function adds a note to the selected cell.
    const selectedRange = context.workbook.getSelectedRange();

    // Note that an InvalidArgument error is thrown if multiple cells are selected.
    context.workbook.notes.add(selectedRange, "The first note.");
    await context.sync();
});

Ändern der Sichtbarkeit von Notizen

Standardmäßig ist der Inhalt einer Notiz ausgeblendet, es sei denn, ein Benutzer zeigt mit der Maus über die Zelle mit der Notiz oder legt fest, dass die Arbeitsmappe Notizen anzeigt. Verwenden Sie zum Anzeigen einer Notiz die Note.visible-Eigenschaft . Im folgenden Codebeispiel wird gezeigt, wie Sie die Sichtbarkeit einer Notiz ändern.

await Excel.run(async (context) => {
    // This function sets the note on cell A1 to visible.
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    const firstNote = sheet.notes.getItem("A1");

    firstNote.load();
    await context.sync();

    firstNote.visible = true;
});

Bearbeiten des Inhalts einer Notiz

Um den Inhalt einer Notiz zu bearbeiten, verwenden Sie die Note.content-Eigenschaft . Das folgende Beispiel zeigt, wie sie den Inhalt der ersten Notiz im NoteCollectionändern.

await Excel.run(async (context) => {
    // This function changes the content in the first note.
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    const note = sheet.notes.getItemAt(0);

    note.content = "Changing the content of the first note.";
    await context.sync();
});

Hinweis

Verwenden Sie die Note.authorName -Eigenschaft, um den Autor einer Notiz abzurufen. Der Name des Autors ist eine schreibgeschützte Eigenschaft.

Ändern der Größe einer Notiz

Wenn Sie Notizen vergrößern oder verkleineren möchten, verwenden Sie die Eigenschaften Note.height und Note.width .

Im folgenden Beispiel wird gezeigt, wie die Größe der ersten Notiz im festgelegt wird NoteCollection.

await Excel.run(async (context) => {
    // This function changes the height and width of the first note.
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    const note = sheet.notes.getItemAt(0);

    note.width = 400;
    note.height = 200;    

    await context.sync();
});

Löschen einer Notiz

Um eine Notiz zu löschen, verwenden Sie die Note.delete-Methode . Das folgende Beispiel zeigt, wie Sie die an Zelle A2 angefügte Notiz löschen.

await Excel.run(async (context) => {
    // This function deletes the note from cell A2.
    const sheet = context.workbook.worksheets.getActiveWorksheet();
    const note = sheet.notes.getItem("A2");

    note.delete();
    await context.sync();
});

Freigeben über