Compartilhar via


Excel.Comment class

Representa um comentário no livro.

Extends

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

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 é texto simples.

contentType

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

context

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

creationDate

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.

id

Especifica o identificador de comentário.

mentions

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

replies

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

resolved

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

richContent

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.

Métodos

assignTask(assignee)

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

delete()

Elimina o comentário e todas as respostas ligadas.

getLocation()

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

getTask()

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 .

getTaskOrNullObject()

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).

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. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.

set(properties)

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

toJSON()

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.

updateMentions(contentWithMentions)

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

Detalhes da propriedade

authorEmail

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

readonly authorEmail: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

authorName

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

readonly authorName: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

content

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

content: string;

Valor da propriedade

string

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

contentType

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

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

Valor da propriedade

Excel.ContentType | "Plain" | "Mention"

Comentários

[ Conjunto de API: ExcelApi 1.12 ]

context

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

creationDate

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

Date

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

id

Especifica o identificador de comentário.

readonly id: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

mentions

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 ]

replies

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 ]

resolved

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

boolean

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

richContent

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

string

Comentários

[ Conjunto de API: ExcelApi 1.11 ]

Detalhes do método

assignTask(assignee)

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

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

assignee
Excel.EmailIdentity

As informações de identidade de utilizador do destinatário.

Retornos

Comentários

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

delete()

Elimina o comentário e todas as respostas ligadas.

delete(): void;

Retornos

void

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

getLocation()

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

getLocation(): Excel.Range;

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

getTask()

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

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) ]

getTaskOrNullObject()

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produçã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) ]

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 as propriedades do objeto a carregar.

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 delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

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

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 delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.

Retornos

set(properties, options)

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

properties
Excel.Interfaces.CommentUpdateData

Um objeto JavaScript com propriedades que são estruturadas isomorfoticamente 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 quaisquer propriedades só de leitura.

Retornos

void

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base num 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 é 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

updateMentions(contentWithMentions)

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

contentWithMentions
Excel.CommentRichContent

O conteúdo do comentário. Contém uma cadeia de carateres especialmente formatada e uma lista de menções que serão analisadas na cadeia quando apresentadas pelo Excel.

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.11 ]