Excel.Comment class

Représente un commentaire dans le classeur.

Extends

Remarques

[Jeu 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 du texte brut.

contentType

Obtient le type de contenu du commentaire.

context

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

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

le status du thread de commentaires. La valeur signifie true que le thread de commentaires est résolu.

richContent

Obtient le contenu de commentaire enrichi (par exemple, les mentions dans les commentaires). Cette chaîne n’est pas destinée à être affichée aux utilisateurs finaux. Votre complément doit utiliser cette fonction uniquement pour analyser le contenu de commentaires enrichis.

Méthodes

delete()

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

getLocation()

Obtient la cellule où se trouve ce commentaire.

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 soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.

set(properties)

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

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.Comment est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.CommentDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

updateMentions(contentWithMentions)

Mises à jour du contenu du commentaire 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

[Jeu d’API : ExcelApi 1.10]

authorName

Obtient le nom de l’auteur du commentaire.

readonly authorName: string;

Valeur de propriété

string

Remarques

[Jeu d’API : ExcelApi 1.10]

content

Contenu du commentaire. La chaîne est du texte brut.

content: string;

Valeur de propriété

string

Remarques

[Jeu d’API : ExcelApi 1.10]

contentType

Obtient le type de contenu du commentaire.

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

Valeur de propriété

Excel.ContentType | "Plain" | "Mention"

Remarques

[Jeu d’API : ExcelApi 1.12]

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é

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

[Jeu d’API : ExcelApi 1.10]

id

Spécifie l’identificateur du commentaire.

readonly id: string;

Valeur de propriété

string

Remarques

[Jeu 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

[Jeu 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

[Jeu d’API : ExcelApi 1.10]

resolved

le status du thread de commentaires. La valeur signifie true que le thread de commentaires est résolu.

resolved: boolean;

Valeur de propriété

boolean

Remarques

[Jeu d’API : ExcelApi 1.11]

richContent

Obtient le contenu de commentaire enrichi (par exemple, les mentions dans les commentaires). Cette chaîne n’est pas destinée à être affichée aux utilisateurs finaux. Votre complément doit utiliser cette fonction uniquement pour analyser le contenu de commentaires enrichis.

readonly richContent: string;

Valeur de propriété

string

Remarques

[Jeu d’API : ExcelApi 1.11]

Détails de la méthode

delete()

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

delete(): void;

Retours

void

Remarques

[Jeu d’API : ExcelApi 1.10]

getLocation()

Obtient la cellule où se trouve ce commentaire.

getLocation(): Excel.Range;

Retours

Remarques

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

Paramètres

options
Excel.Interfaces.CommentLoadOptions

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

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

Retours

set(properties, options)

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

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

Paramètres

properties
Excel.Interfaces.CommentUpdateData

Objet JavaScript dont les propriétés sont structurées de façon isomorphe par rapport aux propriétés de l’objet sur lequel la méthode est appelée.

options
OfficeExtension.UpdateOptions

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

Retours

void

set(properties)

Définit plusieurs propriétés sur 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 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.Comment est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.CommentDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Excel.Interfaces.CommentData;

Retours

updateMentions(contentWithMentions)

Mises à jour du contenu du commentaire 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. Celui-ci contient une chaîne spécialement mise en forme et une liste de mentions qui seront analysées dans la chaîne lorsqu’elle sera affichée par Excel.

Retours

void

Remarques

[Jeu d’API : ExcelApi 1.11]