Administración de notas en complementos de Excel mediante la API de JavaScript de Excel

Use notas cuando necesite anotaciones simples basadas en celdas en un libro. En este artículo se muestra cómo agregar, mostrar, editar, cambiar el tamaño y eliminar notas mediante la API de JavaScript de Excel.

Si necesita subprocesos de conversación con respuestas y menciones, consulte Administrar comentarios en complementos de Excel mediante la API de JavaScript de Excel. Para comparar los dos sistemas de notas en Excel, vea La diferencia entre los comentarios en subproceso y las notas.

Qué puede hacer con las notas

Use las API de nota de Excel para:

• Agregue una nota a una sola celda.
• Mostrar u ocultar el contenido de las notas.
• Actualizar el texto de la nota.
• Cambie el tamaño de la nota.
• Elimine una nota.

Las notas están vinculadas a una celda individual. Cualquier persona que vea el libro con permisos suficientes puede ver una nota. La propiedad realiza un seguimiento de las Workbook.notes notas de un libro. Esto incluye notas creadas por los usuarios y también notas creadas por el complemento. La Workbook.notes propiedad es un objeto NoteCollection que contiene una colección de objetos Note . Las notas también son accesibles en el nivel hoja de cálculo .

Agregar una nota

Use el NoteCollection.add método para agregar notas a un libro. Este método toma dos parámetros:

• cellAddress: celda donde se agrega la nota. Puede ser una cadena o un objeto Range . El rango debe ser una sola celda.
• content: el contenido de la nota, como una cadena.

En el ejemplo de código siguiente se muestra cómo agregar una nota a la celda seleccionada en una hoja de cálculo.

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

Cambiar la visibilidad de la nota

De forma predeterminada, el contenido de una nota está oculto a menos que un usuario mantenga el puntero sobre la celda con la nota o establezca el libro para mostrar las notas. Para mostrar una nota, use la propiedad Note.visible . En el ejemplo de código siguiente se muestra cómo cambiar la visibilidad de una nota.

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

Editar el contenido de una nota

Para editar el contenido de una nota, use la propiedad Note.content . En el ejemplo siguiente se muestra cómo cambiar el contenido de la primera nota de 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();
});

Cambiar el tamaño de una nota

Para hacer que las notas sean más grandes o más pequeñas, use las propiedades Note.height y Note.width .

En el ejemplo siguiente se muestra cómo establecer el tamaño de la primera nota en .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();
});

Eliminación de una nota

Para eliminar una nota, use el método Note.delete . En el ejemplo siguiente se muestra cómo eliminar la nota adjunta a la celda 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();
});

Vea también

• Conceptos básicos del modelo de objetos de Excel para complementos de Office
• Administración de libros de Excel con la API de JavaScript de Excel
• Administración de comentarios en complementos de Excel mediante la API de JavaScript de Excel
• Insertar comentarios y notas en Excel