So fügen Sie Kommentare mithilfe der .NET REST API effektiv hinzu, löschen und verwalten sie

Im dynamischen Bereich der Dokumenterstellung und -zusammenarbeit ist die Möglichkeit, Kommentare in Microsoft Word hinzuzufügen und zu verwalten, unverzichtbar. Kommentare dienen als virtuelles Diskussionsforum, in dem Mitarbeiter Gedanken austauschen, Verbesserungen vorschlagen und Feedback geben können, ohne den ursprünglichen Inhalt zu verändern. Diese Funktion erleichtert nicht nur die effektive Kommunikation, sondern verbessert auch den kollaborativen Bearbeitungsprozess und macht ihn schlanker und effizienter. Daher werden wir in diesem Handbuch auf die wesentlichen Aspekte des Hinzufügens und Löschens von Kommentaren eingehen und das Potenzial und die Vorteile dieser wichtigen Funktion in MS Word mithilfe der .NET REST API enthüllen.

Kommentare mit der .NET REST API verwalten
Kommentare aus DOCX Dateien abrufen
Kommentare in Word Dokument einfügen
Kommentare in der Word-Datei aktualisieren
Kommentare aus Word Dokument löschen

Kommentare mit der .NET REST API verwalten

Das Bearbeiten und Hinzufügen von Kommentaren mit Aspose.Words Cloud SDK für .NET bietet eine Fülle von Vorteilen und eine breite Palette von Funktionen, die über die reine Kommentarverwaltung hinausgehen. Darüber hinaus bietet das SDK auch eine breite Palette von Funktionen, darunter die Generierung von Word Dokumenten, die Konvertierung von Word in JPG, Word in PDF, Word in ODT usw., die Bearbeitung von Text und Formatierung, die Bildverarbeitung und eine breite Palette von Funktionen, mit denen Sie Ihre Dokumentverarbeitungsfunktionen für eine Reihe von Szenarien verbessern können.

Kommentare aus DOCX Dateien abrufen

Sie können alle oder bestimmte Kommentare aus dem Dokument lesen. Die GetComments-Methode bietet die Möglichkeit, die Benutzerkommentare aus der DOCX-Datei zu lesen. Unten ist ein cURL-Befehl angegeben, mit dem Sie die Kommentare in der Eingabeaufforderung lesen können.

cURL-Befehl

Bitte beachten Sie, dass Sie zum Lesen von Kommentaren die Details zu den im Cloud-Speicher gespeicherten Dokumenten angeben müssen und dass nur autorisierte Benutzer die Berechtigungen zum Zugriff auf die APIs erhalten. Daher müssen Sie zuerst das JWT-Authentifizierungstoken abrufen und es wie oben beschrieben im Befehl verwenden.

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"

Sobald das JWT-Token generiert wurde, führen Sie bitte den folgenden Befehl aus, um alle Kommentare im Word Dokument zu erhalten.

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

Anforderungs-URL

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

C#.NET

Um einen bestimmten Kommentar aus dem Dokument zu lesen, befolgen Sie bitte die unten angegebenen Schritte:

Initialisieren Sie eine Instanz der WordsApi Klasse.
Erstellen Sie ein Objekt der Klasse GetCommentRequest, in dem wir den Eingabedateinamen Volume 1.docx und den Kommentarindexwert als Eingabeargumente bereitstellen.
Initialisieren Sie abschließend ein CommentResponse Objekt, während Sie den von der Methode GetComment(..) zurückgegebenen Wert übergeben.

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/

// Initialisieren und Objekt von WordsApi
Aspose.Words.Cloud.Sdk.WordsApi wordsApi = new Aspose.Words.Cloud.Sdk.WordsApi(clientID, clientSecret);

// Name der Eingabedatei
String filename= "Volume 1.docx";
// Index der Kommentare
int commentIndex = 0;
// create an object of GetCommentRequest where we pass Name der Eingabedatei 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);
// Erstellen Sie eine Instanz von CommentResponse und lesen Sie den Kommentar aus dem Dokument
Aspose.Words.Cloud.Sdk.Model.CommentResponse response = wordsApi.GetComment(request);
// den Kommentar in der Konsole anzeigen
Console.Write(response.Comment);

Alle Kommentare abrufen

Die API bietet auch die Funktion, alle Kommentare aus dem Dokument abzurufen (falls wir nicht zwischen einzelnen Kommentaren wechseln möchten).Für diese Anforderung müssen Sie eine Instanz der Klassen GetCommentsRequest und CommentsResponse erstellen und die Methode GetComments(..) des WordsApi Objekts aufrufen.

Kommentare in Word Dokument einfügen

Die API kann auch neue Kommentarobjekte in ein Word Dokument hinzufügen/einfügen.

cURL-Befehl

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/

// Initialisieren und Objekt von WordsApi
Aspose.Words.Cloud.Sdk.WordsApi wordsApi = new Aspose.Words.Cloud.Sdk.WordsApi(clientID, clientSecret);

// Name der Eingabedatei
String filename = "Volume 1.docx";
// Index der Kommentare
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 Name der Eingabedatei 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);
// Erstellen Sie eine Instanz von CommentResponse und lesen Sie den Kommentar aus dem Dokument
Aspose.Words.Cloud.Sdk.Model.CommentResponse response = wordsApi.InsertComment(request);

Kommentarvorschau einfügen. — Bild 1: - Vorschau des neu eingefügten Kommentars

Kommentare in der Word-Datei aktualisieren

Neben dem Parsen und Hinzufügen von Kommentaren unterstützt die API auch die Funktion zum Aktualisieren der vorhandenen Kommentare im Word Dokument.

cURL-Befehl

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

Um die Kommentare im Word Dokument programmgesteuert zu aktualisieren, befolgen Sie bitte die unten angegebenen Anweisungen.

Erstellen Sie eine Instanz der WordsApi Klasse.
Erstellen Sie ein NodeLink Objekt, das die Kommentar-NodeID definiert.
Es wird ein neues Objekt der Klasse DocumentPosition erstellt, das die Werte RangeStart und RangeEnd definiert.
Erstellen Sie ein CommentUpdate Objekt, das die Initialen des Kommentars, den Namen des Autors sowie die Details zu RangeStart und RangeEnd definiert, indem Sie den Instanzwert DocumentPosition und den im Kommentar zu aktualisierenden Text zuweisen.

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/

// Initialisieren und Objekt von WordsApi
Aspose.Words.Cloud.Sdk.WordsApi wordsApi = new Aspose.Words.Cloud.Sdk.WordsApi(clientID, clientSecret);

// Name der Eingabedatei
String filename = "Volume 1.docx";
// Index der Kommentare
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 Name der Eingabedatei 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);
// Erstellen Sie eine Instanz von CommentResponse und lesen Sie den Kommentar aus dem Dokument
Aspose.Words.Cloud.Sdk.Model.CommentResponse response = wordsApi.UpdateComment(request);

Kommentarvorschau aktualisieren — Bild 2: - Vorschau der aktualisierten Kommentare

Das resultierende Dokument Band 1 - aktualisiert.docx ist ebenfalls beigefügt.

Kommentare aus Word Dokument löschen

Sie können die Kommentare auch mithilfe der REST-Cloud-API aus der Word-Datei entfernen/löschen.

cURL-Befehl

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

C#.NET

Erstellen Sie ein Objekt der WordsApi Klasse.
Erstellen Sie eine Instanz der Klasse DeleteCommentRequest, die eine Eingabedatei und einen Kommentarindex als Argument verwendet.
Schließlich die Methode DeleteComment(…) mit dem Objekt DeleteCommentRequest als 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/

// Initialisieren und Objekt von WordsApi
Aspose.Words.Cloud.Sdk.WordsApi wordsApi = new Aspose.Words.Cloud.Sdk.WordsApi(clientID, clientSecret);

// Name der Eingabedatei
String filename = "Volume 1.docx";
// Index der Kommentare
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);

Bild 3: - Vorschau gelöschter Kommentare

Kommentare mit der .NET REST API verwalten#

Kommentare aus DOCX Dateien abrufen#

cURL-Befehl#

C#.NET#

Kommentare in Word Dokument einfügen#

cURL-Befehl#

C#.NET#

Kommentare in der Word-Datei aktualisieren#

cURL-Befehl#

C#.NET#

Kommentare aus Word Dokument löschen#

cURL-Befehl#

C#.NET#

Kommentare mit der .NET REST API verwalten

Kommentare aus DOCX Dateien abrufen

cURL-Befehl

C#.NET

Kommentare in Word Dokument einfügen

cURL-Befehl

C#.NET

Kommentare in der Word-Datei aktualisieren

cURL-Befehl

C#.NET

Kommentare aus Word Dokument löschen

cURL-Befehl

C#.NET