Gérer les notes dans les compléments Excel à l’aide de l’API JavaScript Excel

Utilisez des notes lorsque vous avez besoin d’annotations simples basées sur des cellules dans un classeur. Cet article explique comment ajouter, afficher, modifier, redimensionner et supprimer des notes à l’aide de l’API JavaScript Excel.

Si vous avez besoin de threads de conversation avec des réponses et des mentions, consultez Gérer les commentaires dans les compléments Excel à l’aide de l’API JavaScript Excel. Pour comparer les deux systèmes de notes dans Excel, voir La différence entre les commentaires à threads et les notes.

Ce que vous pouvez faire avec les notes

Utilisez les API de note Excel pour :

• Ajoutez une note à une seule cellule.
• Afficher ou masquer le contenu de la note.
• Mettre à jour le texte de la note.
• Modifier la taille de la note.
• Supprimer une note.

Les notes sont liées à une cellule individuelle. Toute personne qui consulte le classeur avec des autorisations suffisantes peut afficher une note. Les notes d’un classeur sont suivies par la Workbook.notes propriété . Cela inclut les notes créées par les utilisateurs et les notes créées par votre complément. La Workbook.notes propriété est un objet NoteCollection qui contient une collection d’objets Note . Les notes sont également accessibles au niveau de la feuille de calcul .

Ajouter une note

Utilisez la NoteCollection.add méthode pour ajouter des notes à un classeur. Cette méthode prend deux paramètres :

• cellAddress: cellule dans laquelle la note est ajoutée. Il peut s’agir d’une chaîne ou d’un objet Range . La plage doit être une seule cellule.
• content: contenu de la note, sous forme de chaîne.

L’exemple de code suivant montre comment ajouter une note à la cellule sélectionnée dans une feuille de calcul.

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();
});

Modifier la visibilité des notes

Par défaut, le contenu d’une note est masqué, sauf si un utilisateur pointe sur la cellule avec la note ou définit le classeur pour afficher les notes. Pour afficher une note, utilisez la propriété Note.visible . L’exemple de code suivant montre comment modifier la visibilité d’une note.

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.visible = true;
    await context.sync();
});

Modifier le contenu d’une note

Pour modifier le contenu d’une note, utilisez la propriété Note.content . L’exemple suivant montre comment modifier le contenu de la première note dans .NoteCollection

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();
});

Modifier la taille d’une note

Pour agrandir ou réduire les notes, utilisez les propriétés Note.height et Note.width .

L’exemple suivant montre comment définir la taille de la première note dans .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();
});

Supprimer une note

Pour supprimer une note, utilisez la méthode Note.delete . L’exemple suivant montre comment supprimer la note jointe à la cellule A2.

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();
});

Voir aussi

• Concepts principaux du modèle objet Excel pour les compléments Office
• Gérer des classeurs Excel avec l’API JavaScript Excel
• Gérer les commentaires dans les compléments Excel à l’aide de l’API JavaScript Excel
• Insérer des commentaires et des notes dans Excel