Excel.Note class
Representa uma anotação na pasta de trabalho ou planilha.
- Extends
Comentários
Conjunto de APIs: ExcelApi 1.18
Usada por
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/excel-note-basics.yaml
// This function changes the height and width of the first note.
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Notes");
const note = sheet.notes.getItemAt(0);
note.height = 200;
note.width = 400;
await context.sync();
});
Propriedades
| author |
Obtém o autor da anotação. |
| content | Especifica o texto da anotação. |
| context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office. |
| height | Especifica a altura da nota. Observação: esta propriedade não é suportada no Excel na Web. |
| visible | Especifica a visibilidade da anotação. Um valor significa |
| width | Especifica a largura da anotação. Observação: esta propriedade não é suportada no Excel na Web. |
Métodos
| delete() | Exclui a anotação. |
| get |
Obtém a célula onde esta nota está localizada. |
| load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| set(properties, options) | Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo. |
| set(properties) | Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente. |
| toJSON() | Substitui o método JavaScript |
Detalhes da propriedade
authorName
Obtém o autor da anotação.
readonly authorName: string;Valor da propriedade
string
Comentários
content
Especifica o texto da anotação.
content: string;Valor da propriedade
string
Comentários
Conjunto de APIs: ExcelApi 1.18
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/excel-note-basics.yaml
// This function changes the content in the first note.
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Notes");
const note = sheet.notes.getItemAt(0);
note.content = "Changing the content of the first note.";
await context.sync();
});
context
O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
context: RequestContext;Valor da propriedade
height
Especifica a altura da nota. Observação: esta propriedade não é suportada no Excel na Web.
height: number;Valor da propriedade
number
Comentários
Conjunto de APIs: ExcelApi 1.18
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/excel-note-basics.yaml
// This function changes the height and width of the first note.
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Notes");
const note = sheet.notes.getItemAt(0);
note.height = 200;
note.width = 400;
await context.sync();
});
visible
Especifica a visibilidade da anotação. Um valor significa true que a anotação é mostrada. Observação: esta propriedade não é suportada no Excel na Web.
visible: boolean;Valor da propriedade
boolean
Comentários
Conjunto de APIs: ExcelApi 1.18
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/excel-note-basics.yaml
// This function sets the note on cell A1 to visible.
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Notes");
const firstNote = sheet.notes.getItem("A1");
firstNote.load();
await context.sync();
firstNote.visible = true;
});
width
Especifica a largura da anotação. Observação: esta propriedade não é suportada no Excel na Web.
width: number;Valor da propriedade
number
Comentários
Conjunto de APIs: ExcelApi 1.18
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/excel-note-basics.yaml
// This function changes the height and width of the first note.
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Notes");
const note = sheet.notes.getItemAt(0);
note.height = 200;
note.width = 400;
await context.sync();
});
Detalhes do método
delete()
Exclui a anotação.
delete(): void;Retornos
void
Comentários
Conjunto de APIs: ExcelApi 1.18
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/excel-note-basics.yaml
// This function deletes the note from cell A2.
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Notes");
const note = sheet.notes.getItem("A2");
note.delete();
await context.sync();
});
getLocation()
Obtém a célula onde esta nota está localizada.
getLocation(): Excel.Range;Retornos
Comentários
load(options)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(options?: Excel.Interfaces.NoteLoadOptions): Excel.Note;Parâmetros
- options
- Excel.Interfaces.NoteLoadOptions
Fornece opções para quais propriedades do objeto devem ser carregadas.
Retornos
load(propertyNames)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNames?: string | string[]): Excel.Note;Parâmetros
- propertyNames
-
string | string[]
Uma cadeia de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especifica as propriedades a serem carregadas.
Retornos
load(propertyNamesAndPaths)
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.Note;Parâmetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades de navegação a serem carregadas.
Retornos
set(properties, options)
Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.
set(properties: Interfaces.NoteUpdateData, options?: OfficeExtension.UpdateOptions): void;Parâmetros
- properties
- Excel.Interfaces.NoteUpdateData
Um objeto JavaScript com propriedades estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.
- options
- OfficeExtension.UpdateOptions
Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir propriedades somente leitura.
Retornos
void
set(properties)
Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.
set(properties: Excel.Note): void;Parâmetros
- properties
- Excel.Note
Retornos
void
toJSON()
Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original Excel.Note é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.NoteData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.
toJSON(): Excel.Interfaces.NoteData;