Observação
O acesso a essa página exige autorização. Você pode tentar entrar ou alterar diretórios.
O acesso a essa página exige autorização. Você pode tentar alterar os diretórios.
Este artigo descreve como adicionar, alterar e remover notas num livro com a API JavaScript do Excel. Pode saber mais sobre as notas no artigo Inserir comentários e notas no Excel . Para obter informações sobre as diferenças entre notas e comentários, consulte A diferença entre comentários por tópicos e notas.
As notas estão associadas a uma célula individual. Qualquer pessoa que veja o livro com permissões suficientes pode ver uma nota. As notas num livro são controladas pela Workbook.notes
propriedade . Isto inclui notas criadas por utilizadores e também notas criadas pelo seu suplemento. A Workbook.notes
propriedade é um objeto NoteCollection que contém uma coleção de objetos Note . As notas também estão acessíveis ao nível da Folha de Cálculo .
Dica
Para saber mais sobre como adicionar e editar comentários com a API JavaScript do Excel, veja Trabalhar com comentários com a API JavaScript do Excel.
Adicionar uma nota
Utilize o NoteCollection.add
método para adicionar notas a um livro. Este método utiliza dois parâmetros:
-
cellAddress
: a célula onde o comentário é adicionado. Pode ser uma cadeia de carateres ou um objeto De intervalo . O intervalo tem de ser uma única célula. -
content
: o conteúdo do comentário, como uma cadeia.
O seguinte exemplo de código mostra como adicionar uma nota à célula selecionada numa folha 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();
});
Alterar a visibilidade da nota
Por predefinição, o conteúdo de uma nota está oculto, a menos que um utilizador paire o cursor sobre a célula com a nota ou defina o livro para apresentar notas. Para apresentar uma nota, utilize a propriedade Note.visible . O seguinte exemplo de código mostra como alterar a visibilidade de uma 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.load();
await context.sync();
firstNote.visible = true;
});
Editar o conteúdo de uma nota
Para editar o conteúdo de uma nota, utilize a propriedade Note.content . O exemplo seguinte mostra como alterar o conteúdo da primeira nota no 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();
});
Observação
Utilize a Note.authorName
propriedade para obter o autor de uma nota. O nome do autor é uma propriedade só de leitura.
Alterar o tamanho de uma nota
Para aumentar ou diminuir as notas, utilize as propriedades Note.height e Note.width .
O exemplo seguinte mostra como definir o tamanho da primeira nota no 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();
});
Eliminar uma nota
Para eliminar uma nota, utilize o método Note.delete . O exemplo seguinte mostra como eliminar a nota anexada à célula 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();
});