Excel.Comment class

Représente un commentaire dans le manuel.

Extends

Remarques

[Ensemble d’API : ExcelApi 1.10 ]

Propriétés

authorEmail

Obtenir l’adresse email de l’auteur du commentaire.

authorName

Obtient le nom de l’auteur du commentaire.

content

Contenu du commentaire. La chaîne est en texte simple.

contentType

Obtient le type de contenu du commentaire.

context

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

creationDate

Obtenir l’heure de création du commentaire. Renvoie null si le commentaire a été converti à partir d’une note, car le commentaire n’a pas de date de création.

id

Spécifie l’identificateur de commentaire.

mentions

Obtient les entités (par exemple, les personnes) mentionnées dans les commentaires.

replies

Représente une collection de feuilles de calcul associées au classeur.

resolved

État du thread de commentaire. Une valeur de true signifie que le thread de commentaire est résolu.

richContent

Obtient le contenu des commentaires enrichis (par exemple, les mentions dans les commentaires). Cette chaîne n’est pas destinée à être affichée aux utilisateurs finaux. Votre add-in ne doit l’utiliser que pour l’utilisation de commentaires enrichis.

Méthodes

assignTask(assignee)

Affecte la tâche liée au commentaire à l’utilisateur donné en tant que personne assignée. S’il n’existe aucune tâche, une tâche est créée.

delete()

Supprime le commentaire et toutes les réponses connectées.

getLocation()

Obtient la cellule où se trouve ce commentaire.

getTask()

Obtient la tâche associée à ce commentaire. S’il n’existe aucune tâche pour le thread de commentaires, ItemNotFound une exception est lancée.

getTaskOrNullObject()

Obtient la tâche associée à ce commentaire. S’il n’existe aucune tâche pour le thread de commentaire, cette méthode renvoie un objet dont la isNullObject 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.

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre un objet simple avec les propriétés appropriées ou un autre objet API du même type.

set(properties)

Définit plusieurs propriétés de l’objet en même temps, en fonction d’un objet chargé existant.

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.) Tandis que la Excel. L’objet Comment est un objet API, la toJSON méthode renvoie un objet JavaScript simple (tapé sous la formeExcel.Interfaces.CommentData) qui contient des copies superficiels de toutes les propriétés enfants chargées à partir de l’objet d’origine.

updateMentions(contentWithMentions)

Met à jour le contenu des commentaires avec une chaîne spécialement mise en forme et une liste de mentions.

Détails de la propriété

authorEmail

Obtenir l’adresse email de l’auteur du commentaire.

readonly authorEmail: string;

Valeur de propriété

string

Remarques

[Ensemble d’API : ExcelApi 1.10 ]

authorName

Obtient le nom de l’auteur du commentaire.

readonly authorName: string;

Valeur de propriété

string

Remarques

[Ensemble d’API : ExcelApi 1.10 ]

content

Contenu du commentaire. La chaîne est en texte simple.

content: string;

Valeur de propriété

string

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");
    const comment = sheet.comments.getItemAt(0);
    comment.content = "PLEASE add headers here.";
    await context.sync();
});

contentType

Obtient le type de contenu du commentaire.

readonly contentType: Excel.ContentType | "Plain" | "Mention";

Valeur de propriété

Excel.ContentType | "Plain" | "Mention"

Remarques

[Ensemble d’API : ExcelApi 1.12 ]

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é

creationDate

Obtenir l’heure de création du commentaire. Renvoie null si le commentaire a été converti à partir d’une note, car le commentaire n’a pas de date de création.

readonly creationDate: Date;

Valeur de propriété

Date

Remarques

[Ensemble d’API : ExcelApi 1.10 ]

id

Spécifie l’identificateur de commentaire.

readonly id: string;

Valeur de propriété

string

Remarques

[Ensemble d’API : ExcelApi 1.10 ]

mentions

Obtient les entités (par exemple, les personnes) mentionnées dans les commentaires.

readonly mentions: Excel.CommentMention[];

Valeur de propriété

Remarques

[Ensemble d’API : ExcelApi 1.11 ]

replies

Représente une collection de feuilles de calcul associées au classeur.

readonly replies: Excel.CommentReplyCollection;

Valeur de propriété

Remarques

[Ensemble d’API : ExcelApi 1.10 ]

resolved

État du thread de commentaire. Une valeur de true signifie que le thread de commentaire est résolu.

resolved: boolean;

Valeur de propriété

boolean

Remarques

[Ensemble d’API : ExcelApi 1.11 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-resolution.yaml
await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Comments");
    sheet.comments.getItemAt(0).resolved = true;
    await context.sync();
});

richContent

Obtient le contenu des commentaires enrichis (par exemple, les mentions dans les commentaires). Cette chaîne n’est pas destinée à être affichée aux utilisateurs finaux. Votre add-in ne doit l’utiliser que pour l’utilisation de commentaires enrichis.

readonly richContent: string;

Valeur de propriété

string

Remarques

[Ensemble d’API : ExcelApi 1.11 ]

Détails de la méthode

assignTask(assignee)

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Affecte la tâche liée au commentaire à l’utilisateur donné en tant que personne assignée. S’il n’existe aucune tâche, une tâche est créée.

assignTask(assignee: Identity): Excel.DocumentTask;

Paramètres

assignee
Excel.Identity

Informations d’identité de l’utilisateur de la personne assignée.

Retours

Remarques

[Ensemble d’API : ExcelApi BÊTA (PRÉVISUALISATION UNIQUEMENT) ]

delete()

Supprime le commentaire et toutes les réponses connectées.

delete(): void;

Retours

void

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) => {
    context.workbook.comments.getItemByCell("Comments!A2").delete();
    await context.sync();
});

getLocation()

Obtient la cellule où se trouve ce commentaire.

getLocation(): Excel.Range;

Retours

Remarques

[Ensemble d’API : ExcelApi 1.10 ]

getTask()

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Obtient la tâche associée à ce commentaire. S’il n’existe aucune tâche pour le thread de commentaires, ItemNotFound une exception est lancée.

getTask(): Excel.DocumentTask;

Retours

Remarques

[Ensemble d’API : ExcelApi BÊTA (PRÉVISUALISATION UNIQUEMENT) ]

getTaskOrNullObject()

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Obtient la tâche associée à ce commentaire. S’il n’existe aucune tâche pour le thread de commentaire, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, voir *OrNullObject methods and properties.

getTaskOrNullObject(): Excel.DocumentTask;

Retours

Remarques

[Ensemble d’API : ExcelApi BÊTA (PRÉVISUALISATION UNIQUEMENT) ]

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.CommentLoadOptions): Excel.Comment;

Paramètres

options
Excel.Interfaces.CommentLoadOptions

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.Comment;

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

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 comment = context.workbook.comments.getItemByCell("Comments!A2");
    comment.load(["authorEmail", "authorName", "creationDate"]);
    await context.sync();

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

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?: {
            select?: string;
            expand?: string;
        }): Excel.Comment;

Paramètres

propertyNamesAndPaths

{ select?: string; expand?: string; }

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

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre un objet simple avec les propriétés appropriées ou un autre objet API du même type.

set(properties: Interfaces.CommentUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties
Excel.Interfaces.CommentUpdateData

Objet JavaScript avec des propriétés structurées de manière isomorphe aux propriétés de l’objet sur lequel la méthode est appelée.

options
OfficeExtension.UpdateOptions

Fournit une option pour supprimer les erreurs si l’objet propriétés tente de définir des propriétés en lecture seule.

Retours

void

set(properties)

Définit plusieurs propriétés de l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Excel.Comment): void;

Paramètres

properties
Excel.Comment

Retours

void

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.) Tandis que la Excel. L’objet Comment est un objet API, la toJSON méthode renvoie un objet JavaScript simple (tapé sous la formeExcel.Interfaces.CommentData) qui contient des copies superficiels de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Excel.Interfaces.CommentData;

Retours

updateMentions(contentWithMentions)

Met à jour le contenu des commentaires avec une chaîne spécialement mise en forme et une liste de mentions.

updateMentions(contentWithMentions: Excel.CommentRichContent): void;

Paramètres

contentWithMentions
Excel.CommentRichContent

Contenu du commentaire. Il contient une chaîne spécialement mise en forme et une liste de mentions qui seront parées dans la chaîne lorsqu’elles seront Excel.

Retours

void

Remarques

[Ensemble d’API : ExcelApi 1.11 ]