Excel.CommentCollection class

Referência

Pacote:: excel

Representa uma coleção de objetos de comentário que fazem parte do livro.

Extends: OfficeExtension.ClientObject

Comentários

Propriedades

context	O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã 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. É `InvalidArgument` apresentado um erro se o intervalo fornecido for maior do que uma célula.
add(cellAddress, content, contentTypeString)	Cria um novo comentário com o conteúdo fornecido na célula especificada. É `InvalidArgument` apresentado um erro se o intervalo fornecido for maior do 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 existir nenhum comentário na célula, é gerado um erro.
getItemByReplyId(replyId)	Obtém o comentário ao qual a resposta especificada está ligada.
getItemOrNullObject(commentId)	Obtém um comentário da coleção com base em seu ID. Se o objeto de comentário não existir, 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.
toJSON()	Substitui o método JavaScript `toJSON()` para fornecer uma saída mais útil quando um objeto de API é transmitido para `JSON.stringify()`. (`JSON.stringify`por sua vez, chama o `toJSON` método do objeto que lhe é transmitido.) Enquanto o objeto original `Excel.CommentCollection` é um objeto de API, o `toJSON` método devolve um objeto JavaScript simples (escrito 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 os comentários ou respostas numa coleção de comentários são alterados, incluindo quando as respostas são eliminadas.
onDeleted	Ocorre quando os comentários são eliminados na coleção de comentários.

Detalhes da propriedade

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

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. É InvalidArgument apresentado um erro se o intervalo fornecido for maior do 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. Pode ser um Range objeto ou uma cadeia. Se for uma cadeia, tem de conter o endereço completo, incluindo o nome da folha. É InvalidArgument apresentado um erro se o intervalo fornecido for maior do que uma célula.

content: Excel.CommentRichContent | string

O conteúdo do comentário. Isto pode ser uma cadeia ou CommentRichContent objeto. As cadeias são utilizadas para texto simples. CommentRichContent os objetos permitem outras funcionalidades de comentários, como menções. [Conjunto de API: ExcelApi 1.10 para cadeia, 1.11 para o objeto CommentRichContent]

contentType: Excel.ContentType

Opcional. O tipo de conteúdo contido no comentário. O valor predefinido é enum 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. É InvalidArgument apresentado um erro se o intervalo fornecido for maior do 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 predefinido é enum 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 existir nenhum comentário na célula, é gerado um erro.

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

Parâmetros

cellAddress: Excel.Range | string

A célula na qual o comentário se encontra. Pode ser um Range objeto ou uma cadeia. Se for uma cadeia, tem de conter o endereço completo, incluindo o nome da folha. É InvalidArgument apresentado um erro se o intervalo fornecido for maior do 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 especificada está ligada.

getItemByReplyId(replyId: string): Excel.Comment;

Parâmetros

replyId: string

O identificador da resposta a comentários.

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

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

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

Excel.CommentCollection

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.CommentCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito 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 os comentários ou respostas numa coleção de comentários são alterados, incluindo quando as respostas são eliminadas.

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 eliminados 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}`);
    });
}

Compartilhar 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

Recursos adicionais