Excel.CommentReplyCollection class
Représente une collection d’objets de réponse au commentaire qui font partie du commentaire.
- Extends
Propriétés
| context | Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office. |
| items | Obtient l’élément enfant chargé dans cette collection de sites. |
Méthodes
| add(content, content |
Crée une réponse de commentaire pour un commentaire. |
| add(content, content |
Crée une réponse de commentaire pour un commentaire. |
| get |
Obtient le nombre de réponses aux commentaires de la collection. |
| get |
Renvoie une réponse de commentaire identifié via son ID. |
| get |
Obtient une réponse de commentaire en fonction de sa position dans la collection. |
| get |
Renvoie une réponse de commentaire identifié via son ID. Si l’objet de réponse au commentaire n’existe pas, cette méthode renvoie un objet dont la |
| 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 |
Détails de la propriété
context
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é
items
Obtient l’élément enfant chargé dans cette collection de sites.
readonly items: Excel.CommentReply[];Valeur de propriété
Détails de la méthode
add(content, contentType)
Crée une réponse de commentaire pour un commentaire.
add(content: CommentRichContent | string, contentType?: Excel.ContentType): Excel.CommentReply;Paramètres
- content
-
Excel.CommentRichContent | string
Contenu du commentaire. Il peut s’agir d’une chaîne ou d’un objet (par exemple, pour les CommentRichContent commentaires avec mentions). [Jeu d’API : ExcelApi 1.10 pour la 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. [Jeu d’API : ExcelApi 1.10 pour l’énumération ContentType.Plain, 1.11 pour l’énumération ContentType.Mention]
Retours
Remarques
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) => {
// Adds a reply to the first comment in this worksheet.
const sheet = context.workbook.worksheets.getItem("Comments");
const comment = sheet.comments.getItemAt(0);
comment.replies.add("Add content to this worksheet.");
await context.sync();
});
add(content, contentType)
Crée une réponse de commentaire pour un commentaire.
add(content: CommentRichContent | string, contentType?: "Plain" | "Mention"): Excel.CommentReply;Paramètres
- content
-
Excel.CommentRichContent | string
Contenu du commentaire. Il peut s’agir d’une chaîne ou d’un objet (par exemple, pour les CommentRichContent commentaires avec mentions). [Jeu d’API : ExcelApi 1.10 pour la chaîne, 1.11 pour l’objet CommentRichContent]
- contentType
-
"Plain" | "Mention"
Facultatif. Type de contenu contenu dans le commentaire. La valeur par défaut est enum ContentType.Plain. [Jeu d’API : ExcelApi 1.10 pour l’énumération ContentType.Plain, 1.11 pour l’énumération ContentType.Mention]
Retours
Remarques
getCount()
Obtient le nombre de réponses aux commentaires de la collection.
getCount(): OfficeExtension.ClientResult<number>;Retours
OfficeExtension.ClientResult<number>
Remarques
getItem(commentReplyId)
Renvoie une réponse de commentaire identifié via son ID.
getItem(commentReplyId: string): Excel.CommentReply;Paramètres
- commentReplyId
-
string
Identifiant de la réponse au commentaire.
Retours
Remarques
getItemAt(index)
Obtient une réponse de commentaire en fonction de sa position dans la collection.
getItemAt(index: number): Excel.CommentReply;Paramètres
- index
-
number
Valeur d’index de la réponse au commentaire à récupérer. La collection utilise l’indexation à base zéro.
Retours
Remarques
getItemOrNullObject(commentReplyId)
Renvoie une réponse de commentaire identifié via son ID. Si l’objet de réponse au commentaire n’existe pas, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.
getItemOrNullObject(commentReplyId: string): Excel.CommentReply;Paramètres
- commentReplyId
-
string
Identifiant de la réponse au 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.CommentReplyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.CommentReplyCollection;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.CommentReplyCollection;Paramètres
- propertyNames
-
string | string[]
Chaîne délimitée par des virgules ou tableau de chaînes spécifiant 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.CommentReplyCollection;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.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.CommentReplyCollection est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.CommentReplyCollectionDataqui 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.CommentReplyCollectionData;