Excel.Comment class

Representa um comentário na pasta de trabalho.

Extends

Propriedades

authorEmail

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

authorName

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

content

O conteúdo do comentário. A cadeia de caracteres é texto sem formatação.

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

creationDate

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

id

Especifica o identificador de comentário.

replies

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

Métodos

delete()

Exclui o comentário e todas as respostas conectadas.

getLocation()

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

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(propertyNames)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNamesAndPaths)

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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 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.Comment é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.CommentData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

Detalhes da propriedade

authorEmail

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

readonly authorEmail: string;

Valor da propriedade

string

Comentários

Conjunto de APIs: ExcelApi 1.10

authorName

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

readonly authorName: string;

Valor da propriedade

string

Comentários

Conjunto de APIs: ExcelApi 1.10

content

O conteúdo do comentário. A cadeia de caracteres é texto sem formatação.

content: string;

Valor da propriedade

string

Comentários

Conjunto de APIs: ExcelApi 1.10

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/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();
});

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

creationDate

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

readonly creationDate: Date;

Valor da propriedade

Date

Comentários

Conjunto de APIs: ExcelApi 1.10

id

Especifica o identificador de comentário.

readonly id: string;

Valor da propriedade

string

Comentários

Conjunto de APIs: ExcelApi 1.10

replies

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

readonly replies: Excel.CommentReplyCollection;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.10

Exemplos

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

await Excel.run(async (context) => {
    // Adds a reply to the first comment in this worksheet.
    const sheet = context.workbook.worksheets.getItem("Comments");
    const comment: Excel.Comment = sheet.comments.getItemAt(0);
    comment.replies.add("Add content to this worksheet.");
    await context.sync();
});

Detalhes do método

delete()

Exclui o comentário e todas as respostas conectadas.

delete(): void;

Retornos

void

Comentários

Conjunto de APIs: ExcelApi 1.10

Exemplos

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

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

getLocation()

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

getLocation(): Excel.Range;

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.10

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

Parâmetros

options
Excel.Interfaces.CommentLoadOptions

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

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

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/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();
});

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

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.CommentUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

properties
Excel.Interfaces.CommentUpdateData

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

Parâmetros

properties
Excel.Comment

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.Comment é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.CommentData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

toJSON(): Excel.Interfaces.CommentData;

Retornos