Excel.CommentReply class
Représente une réponse au commentaire dans le classeur.
- Extends
Remarques
Utilisateur
Propriétés
| author |
Obtenir l’adresse email de l’auteur de la réponse au commentaire. |
| author |
Obtenir le nom de l’auteur de la réponse au commentaire. |
| content | Contenu de la réponse au commentaire. La chaîne est du texte brut. |
| content |
Type de contenu de la réponse. |
| context | Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office. |
| creation |
Obtient l’heure de création de la réponse à un commentaire. |
| id | Spécifie l’identificateur de réponse au commentaire. |
| mentions | Entités (par exemple, les personnes) mentionnées dans les commentaires. |
| resolved | Le status de réponse au commentaire. Une valeur de |
| rich |
Contenu de commentaire enrichi (par exemple, des 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
| assign |
Affecte la tâche jointe au commentaire à l’utilisateur donné en tant qu’unique personne affectée. S’il n’y a pas de tâche, une tâche est créée. |
| delete() | Supprime la réponse de commentaire. |
| get |
Obtient la cellule où se trouve cette réponse à ce commentaire. |
| get |
Obtient le commentaire parent de cette réponse. |
| get |
Obtient la tâche associée au fil de discussion de cette réponse à ce commentaire. S’il n’existe aucune tâche pour le thread de commentaire, une |
| get |
Obtient la tâche associée au fil de discussion de cette réponse à ce commentaire. S’il n’existe aucune tâche pour le thread de commentaire, 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 |
| 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 |
| update |
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 de la réponse au commentaire.
readonly authorEmail: string;Valeur de propriété
string
Remarques
authorName
Obtenir le nom de l’auteur de la réponse au commentaire.
readonly authorName: string;Valeur de propriété
string
Remarques
content
Contenu de la réponse au commentaire. La chaîne est du texte brut.
content: string;Valeur de propriété
string
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) => {
const sheet = context.workbook.worksheets.getItem("Comments");
const comment = sheet.comments.getItemAt(0);
const reply = comment.replies.getItemAt(0);
reply.load("content");
// Sync to load the content of the comment reply.
await context.sync();
// Append "Please!" to the end of the comment reply.
reply.content += " Please!";
await context.sync();
});
contentType
Type de contenu de la réponse.
readonly contentType: Excel.ContentType | "Plain" | "Mention";Valeur de propriété
Excel.ContentType | "Plain" | "Mention"
Remarques
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
Obtient l’heure de création de la réponse à un commentaire.
readonly creationDate: Date;Valeur de propriété
Date
Remarques
id
Spécifie l’identificateur de réponse au commentaire.
readonly id: string;Valeur de propriété
string
Remarques
mentions
Entités (par exemple, les personnes) mentionnées dans les commentaires.
readonly mentions: Excel.CommentMention[];Valeur de propriété
Remarques
resolved
Le status de réponse au commentaire. Une valeur de true signifie que la réponse est à l’état résolu.
readonly resolved: boolean;Valeur de propriété
boolean
Remarques
richContent
Contenu de commentaire enrichi (par exemple, des 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
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 jointe au commentaire à l’utilisateur donné en tant qu’unique personne affectée. S’il n’y a pas de tâche, une tâche est créée.
assignTask(assignee: Excel.EmailIdentity): Excel.DocumentTask;Paramètres
- assignee
- Excel.EmailIdentity
Informations d’identité utilisateur de la personne affectée.
Retours
Remarques
delete()
Supprime la réponse de commentaire.
delete(): void;Retours
void
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) => {
// Remove the first comment reply from this worksheet's first comment.
const sheet = context.workbook.worksheets.getItem("Comments");
const comment = sheet.comments.getItemAt(0);
comment.replies.getItemAt(0).delete();
await context.sync();
});
getLocation()
Obtient la cellule où se trouve cette réponse à ce commentaire.
getLocation(): Excel.Range;Retours
Remarques
getParentComment()
Obtient le commentaire parent de cette réponse.
getParentComment(): Excel.Comment;Retours
Remarques
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 au fil de discussion de cette réponse à ce commentaire. S’il n’existe aucune tâche pour le thread de commentaire, une ItemNotFound exception est levée.
getTask(): Excel.DocumentTask;Retours
Remarques
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 au fil de discussion de cette réponse à 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, consultez * Méthodes et propriétés d’OrNullObject.
getTaskOrNullObject(): Excel.DocumentTask;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.CommentReplyLoadOptions): Excel.CommentReply;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.CommentReply;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.CommentReply;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.CommentReplyUpdateData, options?: OfficeExtension.UpdateOptions): void;Paramètres
- properties
- Excel.Interfaces.CommentReplyUpdateData
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.CommentReply): void;Paramètres
- properties
- Excel.CommentReply
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.CommentReply est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.CommentReplyDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.
toJSON(): Excel.Interfaces.CommentReplyData;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