Excel.CommentCollection class

Référence

Paquet:: excel

Représente une collection d’objets de commentaire qui font partie du classeur.

Extends: OfficeExtension.ClientObject

Remarques

Propriétés

context	Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
items	Obtient l’élément enfant chargé dans cette collection de sites.

Méthodes

add(cellAddress, content, contentType)	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, content, contentTypeString)	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.
getCount()	Obtient le nombre de commentaires de la collection.
getItem(commentId)	Obtient un commentaire à partir de la collection de sites en fonction de son ID.
getItemAt(index)	Obtient un commentaire en fonction de sa position dans la collection.
getItemByCell(cellAddress)	Obtient le commentaire à partir de la cellule spécifiée. S’il n’y a aucun commentaire dans la cellule, une erreur est générée.
getItemByReplyId(replyId)	Obtient le commentaire auquel la réponse donnée est connectée.
load(options)	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)	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)	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.
toJSON()	Remplace la méthode JavaScript `toJSON()` afin de fournir une sortie plus utile lorsqu’un objet API est passé à `JSON.stringify()`. (`JSON.stringify`appelle à son tour 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 brut (typé en tant `Excel.Interfaces.CommentCollectionData`que ) qui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.

Événements

onAdded	Se produit lorsque les commentaires sont ajoutés.
onChanged	Se produit lorsque des commentaires ou des réponses d’une collection de commentaires sont modifiés, y compris lorsque les réponses sont supprimées.
onDeleted	Se produit lorsque des commentaires sont supprimés dans la collection de commentaires.

Détails de la propriété

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Excel.RequestContext

items

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

readonly items: Excel.Comment[];

Valeur de propriété

Excel.Comment[]

Détails de la méthode

add(cellAddress, content, contentType)

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: CommentRichContent | string, contentType?: Excel.ContentType): Excel.Comment;

Paramètres

cellAddress: Excel.Range | string

Cellule à laquelle le commentaire est ajouté. Il peut s’agir d’un Range objet ou d’une chaîne. S’il s’agit d’une chaîne, elle doit contenir l’adresse complète, y compris le nom de la feuille. Une InvalidArgument erreur est générée si la plage fournie est supérieure à une cellule.

content: Excel.CommentRichContent | string

Contenu du commentaire. Il peut s’agir d’une chaîne ou d’un CommentRichContent objet. Les chaînes sont utilisées pour le texte brut. CommentRichContent les objets autorisent d’autres fonctionnalités de commentaire, telles que les mentions. [Ensemble d’api : ExcelApi 1.10 pour chaîne, 1.11 pour l’objet CommentRichContent]

contentType: Excel.ContentType

Optional. Type de contenu contenu dans le commentaire. La valeur par défaut est enum ContentType.Plain. [Ensemble d’API : ExcelApi 1.10 pour Enum ContentType.Plain, 1.11 pour Enum ContentType.Mention]

Retours

Excel.Comment

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

Exemples

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

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: CommentRichContent | string, contentTypeString?: "Plain" | "Mention"): Excel.Comment;

Paramètres

cellAddress: Excel.Range | string

content: Excel.CommentRichContent | string

contentTypeString: "Plain" | "Mention"

Retours

Excel.Comment

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

getCount()

Obtient le nombre de commentaires de la collection.

getCount(): OfficeExtension.ClientResult<number>;

Retours

OfficeExtension.ClientResult<number>

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

getItem(commentId)

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

getItem(commentId: string): Excel.Comment;

Paramètres

commentId: string

Identificateur du commentaire.

Retours

Excel.Comment

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

getItemAt(index)

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

getItemAt(index: number): Excel.Comment;

Paramètres

index: number

Valeur d’indice de l’objet à récupérer. Avec indice zéro.

Retours

Excel.Comment

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

getItemByCell(cellAddress)

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

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

Paramètres

cellAddress: Excel.Range | string

Cellule sur laquelle se trouve le commentaire. Il peut s’agir d’un Range objet ou d’une chaîne. S’il s’agit d’une chaîne, elle doit contenir l’adresse complète, y compris le nom de la feuille. Une InvalidArgument erreur est générée si la plage fournie est supérieure à une cellule.

Retours

Excel.Comment

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

getItemByReplyId(replyId)

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

getItemByReplyId(replyId: string): Excel.Comment;

Paramètres

replyId: string

Identificateur de réponse au commentaire.

Retours

Excel.Comment

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

load(options)

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

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

Fournit des options pour les propriétés de l’objet à charger.

Retours

Excel.CommentCollection

load(propertyNames)

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

propertyNames: string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient les propriétés à charger.

Retours

Excel.CommentCollection

load(propertyNamesAndPaths)

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

propertyNamesAndPaths: OfficeExtension.LoadOption

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.

Retours

Excel.CommentCollection

toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour 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 brut (typé en tant Excel.Interfaces.CommentCollectionDataque ) qui 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

Excel.Interfaces.CommentCollectionData

Détails de l'événement

onAdded

Se produit lorsque les commentaires sont ajoutés.

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

Type d'événement

OfficeExtension.EventHandlers<Excel.CommentAddedEventArgs>

Remarques

[ Ensemble d’API : ExcelApi 1.12 ]

Exemples

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

Se produit lorsque des commentaires ou des réponses d’une collection de commentaires sont modifiés, y compris lorsque les réponses sont supprimées.

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

Type d'événement

OfficeExtension.EventHandlers<Excel.CommentChangedEventArgs>

Remarques

[ Ensemble d’API : ExcelApi 1.12 ]

Exemples

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

Se produit lorsque des commentaires sont supprimés dans la collection de commentaires.

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

Type d'événement

OfficeExtension.EventHandlers<Excel.CommentDeletedEventArgs>

Remarques

[ Ensemble d’API : ExcelApi 1.12 ]

Exemples

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

Partager via

Excel.CommentCollection class

Remarques

Propriétés

Méthodes

Événements

Détails de la propriété

context

Valeur de propriété

items

Valeur de propriété

Détails de la méthode

add(cellAddress, content, contentType)

Paramètres

Retours

Remarques

Exemples

add(cellAddress, content, contentTypeString)

Paramètres

Retours

Remarques

getCount()

Retours

Remarques

getItem(commentId)

Paramètres

Retours

Remarques

getItemAt(index)

Paramètres

Retours

Remarques

getItemByCell(cellAddress)

Paramètres

Retours

Remarques

getItemByReplyId(replyId)

Paramètres

Retours

Remarques

load(options)

Paramètres

Retours

load(propertyNames)

Paramètres

Retours

load(propertyNamesAndPaths)

Paramètres

Retours

toJSON()

Retours

Détails de l'événement

onAdded

Type d'événement

Remarques

Exemples

onChanged

Type d'événement

Remarques

Exemples

onDeleted

Type d'événement

Remarques

Exemples

Ressources supplémentaires