Excel.CommentCollection class

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Obtient l’élément enfant chargé dans cette collection de sites.

readonly items: Excel.Comment[];

Valeur de propriété

Crée un nouveau commentaire avec le contenu donné sur la cellule donnée. Une InvalidArgument erreur est générée si la plage fournie est supérieure à une cellule.

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

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.10

Exemples

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

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

Crée un nouveau commentaire avec le contenu donné sur la cellule donnée. Une InvalidArgument erreur est générée si la plage fournie est supérieure à une cellule.

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

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.10

Obtient le nombre de commentaires de la collection.

getCount(): OfficeExtension.ClientResult<number>;

Retours

Remarques

Jeu d’API : ExcelApi 1.10

Obtient un commentaire à partir de la collection de sites en fonction de son ID.

getItem(commentId: string): Excel.Comment;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.10

Obtient un commentaire en fonction de sa position dans la collection.

getItemAt(index: number): Excel.Comment;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.10

Exemples

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

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

Obtient le commentaire à partir de la cellule spécifiée. S’il n’y a pas de commentaire dans la cellule, une erreur est générée.

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

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.10

Exemples

// 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) => {
    const comment = context.workbook.comments.getItemByCell("Comments!A1");
    const replyCount = comment.replies.getCount();
    // Sync to get the current number of comment replies.
    await context.sync();

    // Get the last comment reply in the comment thread.
    const reply = comment.replies.getItemAt(replyCount.value - 1);
    reply.load(["authorEmail", "authorName", "creationDate"]);
    // Sync to load the reply metadata.
    await context.sync();

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

Obtient le commentaire auquel la réponse donnée est liée.

getItemByReplyId(replyId: string): Excel.Comment;

Paramètres

Retours

Remarques

Jeu d’API : ExcelApi 1.10

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: Excel.Interfaces.CommentCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CommentCollection;

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames?: string | string[]): Excel.CommentCollection;

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.CommentCollection;

Paramètres

Retours

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.CommentCollection est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.CommentCollectionDataqui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.

toJSON(): Excel.Interfaces.CommentCollectionData;

Retours