aperçu des commentaires dans un fichier ms word

Dans le domaine dynamique de la création de documents et de la collaboration, la possibilité d’ajouter et de gérer des commentaires dans Microsoft Word est indispensable. Les commentaires servent de forum de discussion virtuel, permettant aux collaborateurs d’échanger des idées, de suggérer des améliorations et de fournir des commentaires sans modifier le contenu d’origine. Cette fonctionnalité facilite non seulement la communication efficace, mais améliore également le processus d’édition collaborative, le rendant plus simple et plus efficace. Par conséquent, dans ce guide, nous allons nous pencher sur les aspects essentiels de l’ajout et de la suppression de commentaires, en dévoilant le potentiel et les avantages de cette fonctionnalité essentielle dans MS Word à l’aide de l’API REST .NET.

Gérer les commentaires à l’aide de l’API REST .NET

La manipulation et l’ajout de commentaires à l’aide de Aspose.Words Cloud SDK for .NET offrent de nombreux avantages et un large éventail de fonctionnalités allant au-delà de la simple gestion des commentaires. En outre, le SDK offre également un large éventail de fonctionnalités, notamment la génération de documents Word, la conversion de Word en JPG, Word en PDF, Word en ODT, etc., la manipulation de texte et de mise en forme, le traitement d’images et un large éventail de fonctionnalités, vous permettant d’améliorer vos capacités de traitement de documents pour un éventail de scénarios.

Obtenir des commentaires à partir de fichiers DOCX

Vous pouvez utiliser la méthode GetComments pour lire tous les commentaires ou des commentaires spécifiques du document. La méthode GetComments permet de lire les commentaires des utilisateurs à partir d’un fichier DOCX. Vous trouverez ci-dessous une commande cURL que vous pouvez utiliser pour lire les commentaires sur l’invite de commande.

Commande cURL

Veuillez noter que pour pouvoir lire les commentaires, vous devez fournir les détails concernant les documents stockés sur le stockage cloud, ainsi que seuls les utilisateurs autorisés obtiennent les autorisations pour accéder aux API. Par conséquent, vous devez d’abord récupérer le jeton d’authentification JWT et l’utiliser dans la commande comme mentionné ci-dessus.

curl -v "https://api.aspose.cloud/connect/token" \
-X POST \
-d "grant_type=client_credentials&client_id=xxxxxxx-1c8e-4ea4-a948-3857547232fa&client_secret=xxxxxx" \
-H "Content-Type: application/x-www-form-urlencoded" \
-H "Accpet: application/json"

Une fois le jeton JWT généré, veuillez exécuter la commande suivante pour obtenir tous les commentaires dans le document Word.

curl -v "https://api.aspose.cloud/v4.0/words/Volume%201.docx/comments" \
-X GET \
-H "accept: application/json" \
-H "Authorization: Bearer <JWT Token>"

URL de la demande

https://api.aspose.cloud/v4.0/words/Volume%201.docx/comments

C#.NET

Afin de lire un commentaire particulier du document, veuillez suivre les étapes spécifiées ci-dessous :

  • Initialiser une instance de la classe WordsApi.
  • Créez un objet de classe GetCommentRequest dans lequel nous fournissons le nom du fichier d’entrée Volume 1.docx et la valeur d’index du commentaire comme arguments d’entrée.
  • Enfin, initialisez un objet de CommentResponse tout en passant la valeur renvoyée par la méthode GetComment(..).
const string clientID = "xxxxxxxxx";   // Get AppKey and AppSID from https://dashboard.aspose.cloud/
const string clientSecret = "xxxxxxxx";    // Get AppKey and AppSID from https://dashboard.aspose.cloud/

// initialiser et objet de WordsApi
Aspose.Words.Cloud.Sdk.WordsApi wordsApi = new Aspose.Words.Cloud.Sdk.WordsApi(clientID, clientSecret);

// nom du fichier d'entrée
String filename= "Volume 1.docx";
// index des commentaires
int commentIndex = 0;
// create an object of GetCommentRequest where we pass nom du fichier d'entrée and comment index value
Aspose.Words.Cloud.Sdk.Model.Requests.GetCommentRequest request = new Aspose.Words.Cloud.Sdk.Model.Requests.GetCommentRequest(filename, commentIndex, null, null, null, null);
// créer une instance de CommentResponse et lire le commentaire du document
Aspose.Words.Cloud.Sdk.Model.CommentResponse response = wordsApi.GetComment(request);
// afficher le commentaire dans la console
Console.Write(response.Comment);

Obtenir tous les commentaires

L’API offre également la possibilité d’obtenir tous les commentaires du document (au cas où nous ne voudrions pas passer d’un individu à l’autre).Pour cette exigence, vous devez créer une instance des classes GetCommentsRequest, CommentsResponse et appeler la méthode GetComments(..) de l’objet WordsApi.

Insérer des commentaires dans un document Word

L’API est également capable d’ajouter/insérer de nouveaux objets de commentaire dans un document Word.

Commande cURL

curl -v "https://api.aspose.cloud/v4.0/words/Volume%201.docx/comments" \
-X POST \
-H "accept: application/json" \
-H "Authorization: Bearer <JWT Token>" \
-H "Content-Type: application/json" \
-d "{\"RangeStart\":{\"Node\":{\"link\":{\"Href\":\"https://api.aspose.cloud/v4.0/words/Volume 1.docx/sections/0/body/tables/0/rows/1/cells/1/paragraphs/1/runs/0\",\"Rel\":\"self\",\"Type\":\"string\",\"Title\":\"Heading 2\"},\"NodeId\":\"0.1.0.1.1.1.1\"},\"Offset\":0},\"RangeEnd\":{\"Node\":{\"link\":{\"Href\":\"https://api.aspose.cloud/v4.0/words/Volume 1.docx/sections/0/body/tables/0/rows/1/cells/1/paragraphs/5/runs/0\",\"Rel\":\"self\",\"Type\":\"string\",\"Title\":\"Heading 2\"},\"NodeId\":\"0.1.0.1.1.1.1\"},\"Offset\":0},\"Author\":\"Nayyer Shahbaz\",\"Initial\":\"MOU\",\"DateTime\":\"2020-12-07T04:10:03.942Z\",\"Text\":\"Comments Inserted using Aspose.Words Cloud API\"}"

C#.NET

const string clientID = "xxxxxxxxx";   // Get AppKey and AppSID from https://dashboard.aspose.cloud/
const string clientSecret = "xxxxxxxx";    // Get AppKey and AppSID from https://dashboard.aspose.cloud/

// initialiser et objet de WordsApi
Aspose.Words.Cloud.Sdk.WordsApi wordsApi = new Aspose.Words.Cloud.Sdk.WordsApi(clientID, clientSecret);

// nom du fichier d'entrée
String filename = "Volume 1.docx";
// index des commentaires
int commentIndex = 0;

Aspose.Words.Cloud.Sdk.Model.NodeLink link = new Aspose.Words.Cloud.Sdk.Model.NodeLink()
{
    NodeId = "0.1.0.1.1.1.1"
};
Aspose.Words.Cloud.Sdk.Model.DocumentPosition documentPosition = new Aspose.Words.Cloud.Sdk.Model.DocumentPosition()
{
    Node = link,
    Offset = 0
};
Aspose.Words.Cloud.Sdk.Model.CommentInsert commentInsert = new Aspose.Words.Cloud.Sdk.Model.CommentInsert()
{
    Initial = "Aspose",
    Author = "Nayyer Shahbaz",
    RangeStart = documentPosition,
    RangeEnd = documentPosition,
    Text = "Comment added through API"
};


// create an object of GetCommentRequest where we pass nom du fichier d'entrée and comment index value
Aspose.Words.Cloud.Sdk.Model.Requests.InsertCommentRequest request = 
  new Aspose.Words.Cloud.Sdk.Model.Requests.InsertCommentRequest(filename, commentInsert, null, null, null);
// créer une instance de CommentResponse et lire le commentaire du document
Aspose.Words.Cloud.Sdk.Model.CommentResponse response = wordsApi.InsertComment(request);
Insérer un aperçu des commentaires.

Image 1 : aperçu du commentaire nouvellement inséré

Mettre à jour les commentaires dans le fichier Word

En plus de l’analyse et de l’ajout de commentaires, l’API prend également en charge la fonctionnalité de mise à jour des commentaires existants dans le document Word.

Commande cURL

curl -X PUT "https://api.aspose.cloud/v4.0/words/Volume%201.docx/comments/1" \
-H "accept: application/json" \
-H "Authorization: Bearer <JWT Token>" \
-H "Content-Type: application/json" \
-d "{\"RangeStart\":{\"Node\":{\"link\":{\"Href\":\"https://api.aspose.cloud/v4.0/words/Volume 1.docx/sections/0/body/tables/0/rows/1/cells/1/paragraphs/1/runs/0\",\"Rel\":\"self\",\"Type\":\"string\",\"Title\":\"Heading 1\"},\"NodeId\":\"0.1.0.1.1.1.1\"},\"Offset\":0},\"RangeEnd\":{\"Node\":{\"link\":{\"Href\":\"https://api.aspose.cloud/v4.0/words/Volume 1.docx/sections/0/body/tables/0/rows/1/cells/1/paragraphs/1/runs/0\",\"Rel\":\"string\",\"Type\":\"string\",\"Title\":\"Heading 1\"},\"NodeId\":\"0.1.0.1.1.1.1\"},\"Offset\":0},\"Author\":\"Nayyer Shahbaz\",\"Initial\":\"Aspose.Words\",\"DateTime\":\"2020-12-07T06:18:31.348Z\",\"Text\":\"Comments updated using Aspose.Words Cloud API\"}"

C#.NET

Afin de mettre à jour par programmation les commentaires dans un document Word, veuillez suivre les instructions ci-dessous.

  • Créez une instance de la classe WordsApi.
  • Créez un objet de NodeLink qui définit le commentaire NodeID.
  • Un nouvel objet de la classe DocumentPosition est créé qui définit les valeurs RangeStart et RangeEnd.
  • Créez un objet de CommentUpdate qui définit les initiales du commentaire, le nom de l’auteur, les détails RangeStart et RangeEnd en attribuant la valeur d’instance DocumentPosition et le texte à mettre à jour dans le commentaire.
const string clientID = "xxxxxxxxx";   // Get AppKey and AppSID from https://dashboard.aspose.cloud/
const string clientSecret = "xxxxxxxx";    // Get AppKey and AppSID from https://dashboard.aspose.cloud/

// initialiser et objet de WordsApi
Aspose.Words.Cloud.Sdk.WordsApi wordsApi = new Aspose.Words.Cloud.Sdk.WordsApi(clientID, clientSecret);

// nom du fichier d'entrée
String filename = "Volume 1.docx";
// index des commentaires
int commentIndex = 1;

Aspose.Words.Cloud.Sdk.Model.NodeLink link = new Aspose.Words.Cloud.Sdk.Model.NodeLink()
{
    NodeId = "0.1.0.1.1.1.1"
};
Aspose.Words.Cloud.Sdk.Model.DocumentPosition documentPosition = new Aspose.Words.Cloud.Sdk.Model.DocumentPosition()
{
    Node = link,
    Offset = 0
};
Aspose.Words.Cloud.Sdk.Model.CommentUpdate commentUpdate = new Aspose.Words.Cloud.Sdk.Model.CommentUpdate()
{
    Initial = "Aspose",
    Author = "Nayyer Shahbaz",
    RangeStart = documentPosition,
    RangeEnd = documentPosition,
    Text = "Comments updated using Aspose.Words Cloud API"
};

// create an object of GetCommentRequest where we pass nom du fichier d'entrée and comment index value
Aspose.Words.Cloud.Sdk.Model.Requests.UpdateCommentRequest request =
                    new Aspose.Words.Cloud.Sdk.Model.Requests.UpdateCommentRequest(filename, commentIndex, commentUpdate, null, null, null);
// créer une instance de CommentResponse et lire le commentaire du document
Aspose.Words.Cloud.Sdk.Model.CommentResponse response = wordsApi.UpdateComment(request);
Mettre à jour l'aperçu des commentaires

Image 2 : aperçu des commentaires mis à jour

Le document résultant Volume 1 - mis à jour.docx est également joint.

Supprimer les commentaires du document Word

Vous pouvez également supprimer/supprimer les commentaires du fichier Word à l’aide de l’API cloud REST.

Commande cURL

curl -X DELETE "https://api.aspose.cloud/v4.0/words/Volume%201.docx/comments/0" \
-H "accept: /" \
-H "Authorization: Bearer <JWT Token>"

C#.NET

  • Créez un objet de la classe WordsApi.
  • Créez une instance de la classe DeleteCommentRequest qui prend un fichier d’entrée et un index de commentaire comme argument.
  • Enfin la méthode DeleteComment(…) ayant l’objet DeleteCommentRequest comme argument.
const string clientID = "xxxxxxxxx";   // Get AppKey and AppSID from https://dashboard.aspose.cloud/
const string clientSecret = "xxxxxxxx";    // Get AppKey and AppSID from https://dashboard.aspose.cloud/

// initialiser et objet de WordsApi
Aspose.Words.Cloud.Sdk.WordsApi wordsApi = new Aspose.Words.Cloud.Sdk.WordsApi(clientID, clientSecret);

// nom du fichier d'entrée
String filename = "Volume 1.docx";
// index des commentaires
int commentIndex = 0;


Aspose.Words.Cloud.Sdk.Model.Requests.DeleteCommentRequest request = 
  new Aspose.Words.Cloud.Sdk.Model.Requests.DeleteCommentRequest(filename, commentIndex, null, null, null, null, null, null, null);
wordsApi.DeleteComment(request);
Aperçu des commentaires supprimés

Image 3 : aperçu des commentaires supprimés