Partager via

Word.Comment class

  • Référence
Paquet:
word

Représente un commentaire dans le document.

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : WordApi 1.4 ]

Propriétés

authorEmail

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

Obtient le nom de l’auteur du commentaire.
content

Spécifie le contenu du commentaire sous forme de texte brut.
contentRange

Spécifie la plage 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.
creationDate

Obtient la date de création du commentaire.
id

Obtient l’ID du commentaire.
replies

Obtient la collection d’objets de réponse associés au commentaire.
resolved

Spécifie la status du thread de commentaire. La définition de la valeur true résout le thread de commentaire. L’obtention d’une valeur true signifie que le thread de commentaire est résolu.

Méthodes

delete()

Supprime le commentaire et ses réponses.
getRange()

Obtient la plage dans le document main où se trouve le 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.
reply(replyText)

Ajoute une nouvelle réponse à la fin du fil de commentaire.
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 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 le Word d’origine. L’objet Comment est un objet API. La toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.CommentDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.
track()

Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet sur des .sync appels et en dehors de l’exécution séquentielle d’un lot « .run », et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivie lors de la première création de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.
untrack()

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est abrégé pour context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler context.sync() avant que la mise en production de la mémoire ne prenne effet.

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 : WordApi 1.4 ]

authorName

Obtient le nom de l’auteur du commentaire.

readonly authorName: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApi 1.4 ]

content

Spécifie le contenu du commentaire sous forme de texte brut.

content: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApi 1.4 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-comments.yaml

// Edits the first comment in the selected content.
await Word.run(async (context) => {
  const text = $("#edit-comment-text")
    .val()
    .toString();
  const comment = context.document
    .getSelection()
    .getComments()
    .getFirst();
  comment.content = text;

  // Load object to log in the console.
  comment.load();
  await context.sync();

  console.log("Comment content changed:", comment);
});

contentRange

Spécifie la plage de contenu du commentaire.

contentRange: Word.CommentContentRange;

Valeur de propriété

Word.CommentContentRange

Remarques

[ Ensemble d’API : WordApi 1.4 ]

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é

Word.RequestContext

creationDate

Obtient la date de création du commentaire.

readonly creationDate: Date;

Valeur de propriété

Date

Remarques

[ Ensemble d’API : WordApi 1.4 ]

id

Obtient l’ID du commentaire.

readonly id: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : WordApi 1.4 ]

replies

Obtient la collection d’objets de réponse associés au commentaire.

readonly replies: Word.CommentReplyCollection;

Valeur de propriété

Word.CommentReplyCollection

Remarques

[ Ensemble d’API : WordApi 1.4 ]

resolved

Spécifie la status du thread de commentaire. La définition de la valeur true résout le thread de commentaire. L’obtention d’une valeur true signifie que le thread de commentaire est résolu.

resolved: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : WordApi 1.4 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-comments.yaml

// Toggles Resolved status of the first comment in the selected content.
await Word.run(async (context) => {
  const comment = context.document
    .getSelection()
    .getComments()
    .getFirst();
  comment.load("resolved");
  await context.sync();

  // Toggle resolved status.
  // If the comment is active, set as resolved.
  // If it's resolved, set resolved to false.
  const resolvedBefore = comment.resolved;
  comment.resolved = !resolvedBefore;
  comment.load();
  await context.sync();

  console.log(`Comment Resolved status: ${comment.resolved}`, comment);
});

Détails de la méthode

delete()

Supprime le commentaire et ses réponses.

delete(): void;

Retours

void

Remarques

[ Ensemble d’API : WordApi 1.4 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-comments.yaml

// Deletes the first comment in the selected content.
await Word.run(async (context) => {
  context.document
    .getSelection()
    .getComments()
    .getFirst()
    .delete();
  await context.sync();

  console.log("Comment deleted");
});

getRange()

Obtient la plage dans le document main où se trouve le commentaire.

getRange(): Word.Range;

Retours

Word.Range

Remarques

[ Ensemble d’API : WordApi 1.4 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-comments.yaml

// Gets the range of the first comment in the selected content.
await Word.run(async (context) => {
  const range = context.document
    .getSelection()
    .getComments()
    .getFirst()
    .getRange();
  range.load("text");
  await context.sync();

  console.log(`Comment location: ${range.text}`);
});

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?: Word.Interfaces.CommentLoadOptions): Word.Comment;

Paramètres

options
Word.Interfaces.CommentLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

Word.Comment

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[]): Word.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

Word.Comment

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;
        }): Word.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

Word.Comment

reply(replyText)

Ajoute une nouvelle réponse à la fin du fil de commentaire.

reply(replyText: string): Word.CommentReply;

Paramètres

replyText

string

Obligatoire. Texte de réponse.

Retours

Word.CommentReply

Remarques

[ Ensemble d’API : WordApi 1.4 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-comments.yaml

// Replies to the first active comment in the selected content.
await Word.run(async (context) => {
  const text = $("#reply-text")
    .val()
    .toString();
  const comments = context.document.getSelection().getComments();
  comments.load("items");
  await context.sync();

  const firstActiveComment = comments.items.find((item) => item.resolved !== true);
  if (firstActiveComment) {
    const reply = firstActiveComment.reply(text);
    console.log("Reply added");
  } else {
    console.log("No active comment was found in the selection so couldn't reply.");
  }
});

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
Word.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: Word.Comment): void;

Paramètres

properties
Word.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 le Word d’origine. L’objet Comment est un objet API. La toJSON méthode renvoie un objet JavaScript brut (typé en tant Word.Interfaces.CommentDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Word.Interfaces.CommentData;

Retours

Word.Interfaces.CommentData

track()

Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet sur des .sync appels et en dehors de l’exécution séquentielle d’un lot « .run », et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivie lors de la première création de l’objet. Si cet objet fait partie d’une collection, vous devez également suivre la collection parente.

track(): Word.Comment;

Retours

Word.Comment

untrack()

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est abrégé pour context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler context.sync() avant que la mise en production de la mémoire ne prenne effet.

untrack(): Word.Comment;

Retours

Word.Comment