Excel.CommentCollection class

Referência

Pacote:: excel

Representa uma coleção de objetos de comentário que fazem parte da pasta de trabalho.

Extends: OfficeExtension.ClientObject

Comentários

Propriedades

context	O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
items	Obtém os itens filhos carregados nesta coleção.

Métodos

add(cellAddress, content, contentType)	Cria um novo comentário com o conteúdo fornecido na célula especificada. Um `InvalidArgument` erro será gerado se o intervalo fornecido for maior que uma célula.
add(cellAddress, content, contentTypeString)	Cria um novo comentário com o conteúdo fornecido na célula especificada. Um `InvalidArgument` erro será gerado se o intervalo fornecido for maior que uma célula.
getCount()	Obtém o número de comentários na coleção.
getItem(commentId)	Obtém um comentário da coleção com base em seu ID.
getItemAt(index)	Obtém um comentário da coleção com base em sua posição.
getItemByCell(cellAddress)	Obtém o comentário da célula especificada. Se não houver nenhum comentário na célula, um erro será gerado.
getItemByReplyId(replyId)	Obtém o comentário ao qual a resposta determinada está conectada.
getItemOrNullObject(commentId)	Obtém um comentário da coleção com base em seu ID. Se o objeto de comentário não existir, esse método retornará um objeto com sua `isNullObject` propriedade definida como `true`. Para obter mais informações, consulte *Métodos e propriedades 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.
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.) Considerando que o objeto original `Excel.CommentCollection` é um objeto API, o `toJSON` método retorna um objeto JavaScript simples (digitado como `Excel.Interfaces.CommentCollectionData`) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.

Eventos

onAdded	Ocorre quando os comentários são adicionados.
onChanged	Ocorre quando comentários ou respostas em uma coleção de comentários são alterados, inclusive quando as respostas são excluídas.
onDeleted	Ocorre quando os comentários são excluídos na coleção de comentários.

Detalhes da propriedade

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

Excel.RequestContext

items

Obtém os itens filhos carregados nesta coleção.

readonly items: Excel.Comment[];

Valor da propriedade

Excel.Comment[]

Detalhes do método

add(cellAddress, content, contentType)

Cria um novo comentário com o conteúdo fornecido na célula especificada. Um InvalidArgument erro será gerado se o intervalo fornecido for maior que uma célula.

add(cellAddress: Range | string, content: CommentRichContent | string, contentType?: Excel.ContentType): Excel.Comment;

Parâmetros

cellAddress: Excel.Range | string

A célula à qual o comentário é adicionado. Isso pode ser um Range objeto ou uma cadeia de caracteres. Se for uma cadeia de caracteres, ela deve conter o endereço completo, incluindo o nome da planilha. Um InvalidArgument erro será gerado se o intervalo fornecido for maior que uma célula.

content: Excel.CommentRichContent | string

O conteúdo do comentário. Isso pode ser uma cadeia de caracteres ou CommentRichContent um objeto. Cadeias de caracteres são usadas para texto simples. CommentRichContent objetos permitem outros recursos de comentário, como menções. [Conjunto de API: ExcelApi 1.10 para cadeia de caracteres, 1.11 para objeto CommentRichContent]

contentType: Excel.ContentType

Opcional. O tipo de conteúdo contido no comentário. O valor padrão é enumerar ContentType.Plain. [Conjunto de API: ExcelApi 1.10 para Enum ContentType.Plain, 1.11 para Enum ContentType.Mention]

Retornos

Excel.Comment

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");

    // Note that an InvalidArgument error will be thrown if multiple cells passed to `comment.add`.
    sheet.comments.add("A2", "TODO: add data.");
    await context.sync();
});

add(cellAddress, content, contentTypeString)

Cria um novo comentário com o conteúdo fornecido na célula especificada. Um InvalidArgument erro será gerado se o intervalo fornecido for maior que uma célula.

add(cellAddress: Range | string, content: CommentRichContent | string, contentTypeString?: "Plain" | "Mention"): Excel.Comment;

Parâmetros

cellAddress: Excel.Range | string

content: Excel.CommentRichContent | string

contentTypeString: "Plain" | "Mention"

Opcional. O tipo de conteúdo contido no comentário. O valor padrão é enumerar ContentType.Plain. [Conjunto de API: ExcelApi 1.10 para Enum ContentType.Plain, 1.11 para Enum ContentType.Mention]

Retornos

Excel.Comment

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

getCount()

Obtém o número de comentários na coleção.

getCount(): OfficeExtension.ClientResult<number>;

Retornos

OfficeExtension.ClientResult<number>

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

getItem(commentId)

Obtém um comentário da coleção com base em seu ID.

getItem(commentId: string): Excel.Comment;

Parâmetros

commentId: string

O identificador do comentário.

Retornos

Excel.Comment

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

getItemAt(index)

Obtém um comentário da coleção com base em sua posição.

getItemAt(index: number): Excel.Comment;

Parâmetros

index: number

Valor de índice do objeto a ser recuperado. Indexados com zero.

Retornos

Excel.Comment

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

getItemByCell(cellAddress)

Obtém o comentário da célula especificada. Se não houver nenhum comentário na célula, um erro será gerado.

getItemByCell(cellAddress: Range | string): Excel.Comment;

Parâmetros

cellAddress: Excel.Range | string

A célula na qual o comentário está. Isso pode ser um Range objeto ou uma cadeia de caracteres. Se for uma cadeia de caracteres, ela deve conter o endereço completo, incluindo o nome da planilha. Um InvalidArgument erro será gerado se o intervalo fornecido for maior que uma célula.

Retornos

Excel.Comment

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

getItemByReplyId(replyId)

Obtém o comentário ao qual a resposta determinada está conectada.

getItemByReplyId(replyId: string): Excel.Comment;

Parâmetros

replyId: string

O identificador da resposta de comentário.

Retornos

Excel.Comment

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

getItemOrNullObject(commentId)

Obtém um comentário da coleção com base em seu ID. Se o objeto de comentário não existir, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.

getItemOrNullObject(commentId: string): Excel.Comment;

Parâmetros

commentId: string

O identificador do comentário.

Retornos

Excel.Comment

Comentários

[ Conjunto de API: ExcelApi 1.14 ]

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.CommentCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CommentCollection;

Parâmetros

options: Excel.Interfaces.CommentCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Fornece opções para quais propriedades do objeto carregar.

Retornos

Excel.CommentCollection

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

Parâmetros

propertyNames: string | string[]

Uma cadeia de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

Retornos

Excel.CommentCollection

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?: OfficeExtension.LoadOption): Excel.CommentCollection;

Parâmetros

propertyNamesAndPaths: OfficeExtension.LoadOption

propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.

Retornos

Excel.CommentCollection

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Considerando que o objeto original Excel.CommentCollection é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.CommentCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.

toJSON(): Excel.Interfaces.CommentCollectionData;

Retornos

Excel.Interfaces.CommentCollectionData

Detalhes do evento

onAdded

Ocorre quando os comentários são adicionados.

readonly onAdded: OfficeExtension.EventHandlers<Excel.CommentAddedEventArgs>;

Tipo de evento

OfficeExtension.EventHandlers<Excel.CommentAddedEventArgs>

Comentários

[ Conjunto de API: ExcelApi 1.12 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-comment-event-handler.yaml

await Excel.run(async (context) => {
    const comments = context.workbook.worksheets.getActiveWorksheet().comments;

    // Register the onAdded, onChanged, and onDeleted comment event handlers.
    comments.onAdded.add(commentAdded);
    comments.onChanged.add(commentChanged);
    comments.onDeleted.add(commentDeleted);

    await context.sync();

    console.log("Added event handlers for when comments are added, changed, or deleted.");
});

...

async function commentAdded(event: Excel.CommentAddedEventArgs) {
    // Retrieve the added comment using the comment ID.
    // Note: This function assumes only a single comment is added at a time. 
    await Excel.run(async (context) => {
        const addedComment = context.workbook.comments.getItem(event.commentDetails[0].commentId);

        // Load the added comment's data.
        addedComment.load(["content", "authorName", "creationDate"]);

        await context.sync();

        // Print out the added comment's data.
        console.log(`A comment was added:`);
        console.log(`    ID: ${event.commentDetails[0].commentId}`);
        console.log(`    Comment content:${addedComment.content}`);
        console.log(`    Comment author:${addedComment.authorName}`);
        console.log(`    Creation date:${addedComment.creationDate}`);
    });
}

onChanged

Ocorre quando comentários ou respostas em uma coleção de comentários são alterados, inclusive quando as respostas são excluídas.

readonly onChanged: OfficeExtension.EventHandlers<Excel.CommentChangedEventArgs>;

Tipo de evento

OfficeExtension.EventHandlers<Excel.CommentChangedEventArgs>

Comentários

[ Conjunto de API: ExcelApi 1.12 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-comment-event-handler.yaml

await Excel.run(async (context) => {
    const comments = context.workbook.worksheets.getActiveWorksheet().comments;

    // Register the onAdded, onChanged, and onDeleted comment event handlers.
    comments.onAdded.add(commentAdded);
    comments.onChanged.add(commentChanged);
    comments.onDeleted.add(commentDeleted);

    await context.sync();

    console.log("Added event handlers for when comments are added, changed, or deleted.");
});

...

async function commentChanged(event: Excel.CommentChangedEventArgs) {
    // Retrieve the changed comment using the comment ID.
    // Note: This function assumes only a single comment is changed at a time. 
    await Excel.run(async (context) => {
        const changedComment = context.workbook.comments.getItem(event.commentDetails[0].commentId);

        // Load the changed comment's data.
        changedComment.load(["content", "authorName", "creationDate"]);

        await context.sync();

        // Print out the changed comment's data.
        console.log(`A comment was changed:`);
        console.log(`    ID: ${event.commentDetails[0].commentId}`);
        console.log(`    Updated comment content: ${changedComment.content}`);
        console.log(`    Comment author: ${changedComment.authorName}`);
        console.log(`    Creation date: ${changedComment.creationDate}`);
    });
}

onDeleted

Ocorre quando os comentários são excluídos na coleção de comentários.

readonly onDeleted: OfficeExtension.EventHandlers<Excel.CommentDeletedEventArgs>;

Tipo de evento

OfficeExtension.EventHandlers<Excel.CommentDeletedEventArgs>

Comentários

[ Conjunto de API: ExcelApi 1.12 ]

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-comment-event-handler.yaml

await Excel.run(async (context) => {
    const comments = context.workbook.worksheets.getActiveWorksheet().comments;

    // Register the onAdded, onChanged, and onDeleted comment event handlers.
    comments.onAdded.add(commentAdded);
    comments.onChanged.add(commentChanged);
    comments.onDeleted.add(commentDeleted);

    await context.sync();

    console.log("Added event handlers for when comments are added, changed, or deleted.");
});

...

async function commentDeleted(event: Excel.CommentDeletedEventArgs) {
    // Print out the deleted comment's ID.
    // Note: This function assumes only a single comment is deleted at a time. 
    await Excel.run(async (context) => {
        console.log(`A comment was deleted:`);
        console.log(`    ID: ${event.commentDetails[0].commentId}`);
    });
}

Share via

Excel.CommentCollection class

Comentários

Propriedades

Métodos

Eventos

Detalhes da propriedade

context

Valor da propriedade

items

Valor da propriedade

Detalhes do método

add(cellAddress, content, contentType)

Parâmetros

Retornos

Comentários

Exemplos

add(cellAddress, content, contentTypeString)

Parâmetros

Retornos

Comentários

getCount()

Retornos

Comentários

getItem(commentId)

Parâmetros

Retornos

Comentários

getItemAt(index)

Parâmetros

Retornos

Comentários

getItemByCell(cellAddress)

Parâmetros

Retornos

Comentários

getItemByReplyId(replyId)

Parâmetros

Retornos

Comentários

getItemOrNullObject(commentId)

Parâmetros

Retornos

Comentários

load(options)

Parâmetros

Retornos

load(propertyNames)

Parâmetros

Retornos

load(propertyNamesAndPaths)

Parâmetros

Retornos

toJSON()

Retornos

Detalhes do evento

onAdded

Tipo de evento

Comentários

Exemplos

onChanged

Tipo de evento

Comentários

Exemplos

onDeleted

Tipo de evento

Comentários

Exemplos

Comentários

Recursos adicionais