Excel.CommentCollection class
Représente une collection d’objets de commentaire qui font partie du classeur.
- Extends
Remarques
[ Ensemble d’API : ExcelApi 1.10 ]
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(cell |
Crée un nouveau commentaire avec le contenu donné sur la cellule donnée. Une |
| add(cell |
Crée un nouveau commentaire avec le contenu donné sur la cellule donnée. Une |
| get |
Obtient le nombre de commentaires de la collection. |
| get |
Obtient un commentaire à partir de la collection de sites en fonction de son ID. |
| get |
Obtient un commentaire en fonction de sa position dans la collection. |
| get |
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. |
| get |
Obtient le commentaire auquel la réponse donnée est connectée. |
| get |
Obtient un commentaire à partir de la collection de sites en fonction de son ID. Si l’objet comment n’existe pas, cette méthode retourne un objet avec sa |
| load(options) | Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| toJSON() | Remplace la méthode JavaScript |
Événements
| on |
Se produit lorsque les commentaires sont ajoutés. |
| on |
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. |
| on |
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é
items
Obtient l’élément enfant chargé dans cette collection de sites.
readonly items: Excel.Comment[];Valeur de propriété
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
Facultatif. 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
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
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]
- contentTypeString
-
"Plain" | "Mention"
Facultatif. 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
Remarques
getCount()
Obtient le nombre de commentaires de la collection.
getCount(): OfficeExtension.ClientResult<number>;Retours
OfficeExtension.ClientResult<number>
Remarques
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
Remarques
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
Remarques
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
Remarques
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
Remarques
getItemOrNullObject(commentId)
Obtient un commentaire à partir de la collection de sites en fonction de son ID. Si l’objet comment n’existe pas, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.
getItemOrNullObject(commentId: string): Excel.Comment;Paramètres
- commentId
-
string
Identificateur du commentaire.
Retours
Remarques
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
Fournit des options pour les propriétés de l’objet à charger.
Retours
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
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
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
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
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
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
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}`);
});
}
Commentaires
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultez https://aka.ms/ContentUserFeedback.
Envoyer et afficher des commentaires pour