Excel.Comment class

Obtém o email do autor do comentário.

readonly authorEmail: string;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

Obtém o nome do autor do comentário.

readonly authorName: string;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

O conteúdo do comentário. A cadeia é texto simples.

content: string;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-basics.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Comments");
    const comment = sheet.comments.getItemAt(0);
    comment.content = "PLEASE add headers here.";
    await context.sync();
});

Obtém o tipo de conteúdo do comentário.

readonly contentType: Excel.ContentType | "Plain" | "Mention";

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.12 ]

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

Obtém o horário de criação do comentário. Devolve null se o comentário tiver sido convertido de uma nota, uma vez que o comentário não tem uma data de criação.

readonly creationDate: Date;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

Especifica o identificador de comentário.

readonly id: string;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

Obtém as entidades (por exemplo, pessoas) que são mencionadas nos comentários.

readonly mentions: Excel.CommentMention[];

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.11 ]

Representa uma coleção de objetos de resposta associados ao comentário.

readonly replies: Excel.CommentReplyCollection;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

O tópico de comentários status. Um valor de true significa que o tópico de comentários é resolvido.

resolved: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.11 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-resolution.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Comments");
    sheet.comments.getItemAt(0).resolved = true;
    await context.sync();
});

Obtém o conteúdo de comentário avançado (por exemplo, menções nos comentários). Esta cadeia não se destina a ser apresentada aos utilizadores finais. O seu suplemento só deve utilizá-lo para analisar conteúdos de comentários avançados.

readonly richContent: string;

Valor da propriedade

Comentários

[ Conjunto de API: ExcelApi 1.11 ]

Atribui a tarefa anexada ao comentário ao utilizador especificado como um destinatário. Se não existir nenhuma tarefa, será criada uma.

assignTask(assignee: Excel.EmailIdentity): Excel.DocumentTask;

Parâmetros

Retornos

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

Elimina o comentário e todas as respostas ligadas.

delete(): void;

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-basics.yaml

await Excel.run(async (context) => {
    context.workbook.comments.getItemByCell("Comments!A2").delete();
    await context.sync();
});

Obtém a célula onde este comentário está localizado.

getLocation(): Excel.Range;

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

Obtém a tarefa associada a este comentário. Se não existir nenhuma tarefa para o tópico de comentários, é emitida uma exceção ItemNotFound .

getTask(): Excel.DocumentTask;

Retornos

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

Obtém a tarefa associada a este comentário. Se não existir nenhuma tarefa para o tópico de comentários, este método devolve um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).

getTaskOrNullObject(): Excel.DocumentTask;

Retornos

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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.CommentLoadOptions): Excel.Comment;

Parâmetros

Retornos

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.Comment;

Parâmetros

Retornos

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-basics.yaml

await Excel.run(async (context) => {
    const comment = context.workbook.comments.getItemByCell("Comments!A2");
    comment.load(["authorEmail", "authorName", "creationDate"]);
    await context.sync();

    console.log(`${comment.creationDate.toDateString()}: ${comment.authorName} (${comment.authorEmail})`);
    await context.sync();
});

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.Comment;

Parâmetros

Retornos

Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.

set(properties: Interfaces.CommentUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

Retornos

Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.

set(properties: Excel.Comment): void;

Parâmetros

Retornos

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Excel.Comment é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.CommentData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Excel.Interfaces.CommentData;

Retornos

Atualizações o conteúdo do comentário com uma cadeia de carateres especialmente formatada e uma lista de menções.

updateMentions(contentWithMentions: Excel.CommentRichContent): void;

Parâmetros

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.11 ]