Excel.CommentReplyCollection class

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

Extends

Remarques

[Ensemble d’API : ExcelApi 1.10 ]

Propriétés

context

Contexte de demande associé à l’objet. Cette opération connecte le processus du Office processus de l’application hôte.

items

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

Méthodes

add(content, contentType)

Crée une réponse de commentaire pour un commentaire.

add(content, contentTypeString)

Crée une réponse de commentaire pour un commentaire.

getCount()

Obtient le nombre de réponses aux commentaires de la collection.

getItem(commentReplyId)

Renvoie une réponse de commentaire identifié via son ID.

getItemAt(index)

Obtient une réponse de commentaire en fonction de sa position dans la collection.

getItemOrNullObject(commentReplyId)

Renvoie une réponse de commentaire identifié via son ID. Si l’objet de réponse de commentaire n’existe pas, cette méthode renvoie un objet dont isNullObject la propriété est définie sur true. Pour plus d’informations, voir *OrNullObject methods and properties.

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 afin de fournir une sortie plus utile lorsqu’un objet toJSON() API est transmis à JSON.stringify(). (JSON.stringify, à son tour, appelle toJSON la méthode de l’objet qui lui est transmis.) Alors que Excel.CommentReplyCollection l’objet d’origine est un objet API, la méthode renvoie un objet toJSON JavaScript simple (tapé sous la forme Excel.Interfaces.CommentReplyCollectionData) qui contient un tableau « éléments » avec des copies peu profondes de toutes les propriétés chargées à partir des éléments de la collection.

Détails de la propriété

context

Contexte de demande associé à l’objet. Cette opération connecte le processus du Office processus de l’application hôte.

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’agit d’une chaîne ou d’un objet CommentRichContent (par exemple, pour les commentaires avec mentions). [Ensemble 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. [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-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, contentTypeString)

Crée une réponse de commentaire pour un commentaire.

add(content: CommentRichContent | string, contentTypeString?: "Plain" | "Mention"): Excel.CommentReply;

Paramètres

content

Excel.CommentRichContent | string

Contenu du commentaire. Il peut s’agit d’une chaîne ou d’un objet CommentRichContent (par exemple, pour les commentaires avec mentions). [Ensemble d’api : ExcelApi 1.10 pour la 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

[Ensemble d’API : ExcelApi 1.10 ]

getCount()

Obtient le nombre de réponses aux commentaires de la collection.

getCount(): OfficeExtension.ClientResult<number>;

Retours

Remarques

[Ensemble d’API : ExcelApi 1.10 ]

getItem(commentReplyId)

Renvoie une réponse de commentaire identifié via son ID.

getItem(commentReplyId: string): Excel.CommentReply;

Paramètres

commentReplyId

string

Identificateur de la réponse au commentaire.

Retours

Remarques

[Ensemble d’API : ExcelApi 1.10 ]

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 de commentaire à récupérer. La collection utilise l’indexation de base zéro.

Retours

Remarques

[Ensemble d’API : ExcelApi 1.10 ]

getItemOrNullObject(commentReplyId)

Renvoie une réponse de commentaire identifié via son ID. Si l’objet de réponse de commentaire n’existe pas, cette méthode renvoie un objet dont isNullObject la propriété est définie sur true. Pour plus d’informations, voir *OrNullObject methods and properties.

getItemOrNullObject(commentReplyId: string): Excel.CommentReply;

Paramètres

commentReplyId

string

Identificateur de la réponse au commentaire.

Retours

Remarques

[Ensemble d’API : ExcelApi 1.14 ]

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

options

Excel.Interfaces.CommentReplyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Fournit des options pour lesquelles 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 est une chaîne délimitée par des virgules qui spécifie les propriétés de propertyNamesAndPaths.expand navigation à charger.

Retours

toJSON()

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

toJSON(): Excel.Interfaces.CommentReplyCollectionData;

Retours