Excel.Comment class
Représente un commentaire dans le classeur.
- Extends
Remarques
[ Ensemble d’API : ExcelApi 1.10 ]
Propriétés
| author |
Obtenir l’adresse email de l’auteur du commentaire. |
| author |
Obtient le nom de l’auteur du commentaire. |
| content | Contenu du commentaire. La chaîne est en texte brut. |
| content |
Obtient le type de contenu du commentaire. |
| context | Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office. |
| creation |
Obtenir l’heure de création du commentaire. Retourne |
| 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 thread de commentaire status. Une valeur de |
| rich |
Obtient le contenu enrichi des commentaires (par exemple, les mentions dans les commentaires). Cette chaîne n’est pas destinée à être affichée pour les utilisateurs finaux. Votre complément doit uniquement l’utiliser pour analyser le contenu des commentaires enrichis. |
Méthodes
| delete() | Supprime le commentaire et toutes les réponses connectées. |
| get |
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 |
| 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 |
| set(properties, options) | Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou 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 |
| update |
Mises à jour le 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
authorName
Obtient le nom de l’auteur du commentaire.
readonly authorName: string;Valeur de propriété
string
Remarques
content
Contenu du commentaire. La chaîne est en texte brut.
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
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é
creationDate
Obtenir l’heure de création du commentaire. Retourne 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
id
Spécifie l’identificateur du commentaire.
readonly id: string;Valeur de propriété
string
Remarques
mentions
Obtient les entités (par exemple, les personnes) mentionnées dans les commentaires.
readonly mentions: Excel.CommentMention[];Valeur de propriété
Remarques
replies
Représente une collection de feuilles de calcul associées au classeur.
readonly replies: Excel.CommentReplyCollection;Valeur de propriété
Remarques
resolved
Le thread de commentaire status. 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 enrichi des commentaires (par exemple, les mentions dans les commentaires). Cette chaîne n’est pas destinée à être affichée pour les utilisateurs finaux. Votre complément doit uniquement l’utiliser pour analyser le contenu des commentaires enrichis.
readonly richContent: string;Valeur de propriété
string
Remarques
Détails de la méthode
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
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
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 qui spécifient 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 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 passer un objet brut 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 qui sont structurées isomorphes en fonction des 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 properties 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.stringifyappelle à son tour 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 brut (typé en tant Excel.Interfaces.CommentDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.
toJSON(): Excel.Interfaces.CommentData;Retours
updateMentions(contentWithMentions)
Mises à jour le 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. Il contient une chaîne spécialement mise en forme et une liste de mentions qui seront analysées dans la chaîne lorsqu’Elles seront affichées par Excel.
Retours
void