Annotéiert Word Dokumenter

Füügt Kommentaren op Word Dokumenter mat C# .NET

En Dokument annotéieren ass e wesentleche Bestanddeel vun der Zesummenaarbecht a Kommunikatioun a ville Branchen. Et erlaabt d’Benotzer Feedback, Suggestiounen a Kommentaren op en Dokument ze ginn dat einfach mat aneren gedeelt ka ginn. Och wann Microsoft Word e puer Annotatiounsinstrumenter bitt, wéi Kommentaren, Ännerunge verfollegen an Notizen derbäisetzen, fir d’Benotzer ze hëllefen Feedback ze ginn an un engem Dokument ze kollaboréieren. Wéi och ëmmer, an dësem Blogpost wäerte mir entdecken wéi een Word Dokumenter mat .NET Cloud SDK annotéiert, wat et méi einfach mécht fir d’Benotzer ze kommunizéieren an op Dokumenter kollaboréieren.

REST API fir Word Kommentaren ze addéieren

Mat Aspose.Words Cloud SDK fir .NET, kënnt Dir einfach Kommentaren, Äntwerten an Annotatiounen op e Word-Dokument programmatesch mat der C# Sprooch addéieren. D’SDK bitt eng ëmfaassend Set vu REST APIs fir Word Dokument Manipulatioun an ënnerstëtzt all gréisser Dokumentformater, dorënner DOC, DOCX, RTF, ://docs.fileformat.com/word-processing/rtf/), a méi. Elo mat der Hëllef vun dëser SDK kënnt Dir Äre Workflow an Zesummenaarbecht Prozess verbesseren andeems Dir einfach an effizient Annotatiounen, Kommentaren an aner Bewäertungselementer op Är Word Dokumenter addéiere kënnt.

Fir d’SDK ze benotzen, sicht Aspose.Words-Cloud am NuGet Package Manager a klickt op de Add Package Knäppchen fir d’SDK Referenz am .NET Projet ze addéieren.

Notiz: fir Zougang zu der REST API ze kréien, musst Dir Iech aschreiwen an Är perséinlech Umeldungsinformatiounen kréien. Kuckt w.e.g. iwwer Quick Start Guide fir verwandte Informatioun.

Füügt Word Dokument Annotatioun mat C#

Probéiert w.e.g. de folgende Code Snippet ze benotzen fir Word Dokument Annotation mat .NET Cloud SDK ze addéieren.

// Fir komplett Beispiller an Datendateien, gitt w.e.g. op 
https://github.com/aspose-words-cloud/aspose-words-cloud-dotnet

// Kritt Client Umeldungsinformatioune vun https://dashboard.aspose.cloud/
string clientSecret = "7f098199230fc5f2175d494d48f2077c";
string clientID = "ee170169-ca49-49a4-87b7-0e2ff815ea6e";

// erstellen Configuratiounsobjekt mat ClinetID a Client Secret Detailer
var config = new Aspose.Words.Cloud.Sdk.Configuration { ClientId = clientID, ClientSecret = clientSecret };
// WordsApi Instanz initialiséieren
var wordsApi = new WordsApi(config);

string firstDocument = "input-sample-1.docx";
// liesen den Inhalt vum éischte Word Dokument vum lokalen Drive
var firstFile = System.IO.File.OpenRead(firstDocument);
try
{
    var requestCommentRangeStartNode = new NodeLink()
    {
        NodeId = "0.6.5.3"
    };
    var requestCommentRangeStart = new DocumentPosition()
    {
        Node = requestCommentRangeStartNode,
        Offset = 0
    };
    var requestCommentRangeEndNode = new NodeLink()
    {
        NodeId = "0.6.5.3"
    };
    var requestCommentRangeEnd = new DocumentPosition()
    {
        Node = requestCommentRangeEndNode,
        Offset = 0
    };
    var requestComment = new CommentInsert()
    {
        RangeStart = requestCommentRangeStart,
        RangeEnd = requestCommentRangeEnd,
        Initial = "NS",
        Author = "Nayyer Shahbaz",
        Text = "Second Revisions..."
    };

    var insertRequest = new InsertCommentOnlineRequest(firstFile, requestComment, destFileName: "Commented.docx");
    var response = wordsApi.InsertCommentOnline(insertRequest);
    
    if (response != null && response.Equals("OK"))
    {
        Console.WriteLine("Word Document Annotation added successfully!");
    }
}
catch(Exception ex)
{
    // all Ausnam während dem Dokument Annotatiounsprozess
    Console.Write(ex);
}
Wuert Dokument Annotatioun Virschau

Bild: - Virschau vu Word Dokument Annotatioun mat REST API.

// create configuration object using ClientID and Client Secret details
var config = new Configuration { ClientId = clientID, ClientSecret = clientSecret };
// initialize WordsApi instance
var wordsApi = new WordsApi(config);

Erstellt en Objet vu WordsApi wärend Dir personaliséierte Client Umeldungsinformatiounen benotzt.

var firstFile = System.IO.File.OpenRead(firstDocument);

Liest den Inhalt vum Input Word Dokument vum lokalen Drive.

var requestCommentRangeStartNode = new NodeLink()
{
    NodeId = "0.6.5.3"
};

Erstellt en Objekt vun NodeLink deen NodeId fir Annotatioun definéiert. Widderhuelen dëse Prozess fir CommentRangeStartNode a CommentRangeEndNode Instanzen.

var requestComment = new CommentInsert()
{
    RangeStart = requestCommentRangeStart,
    RangeEnd = requestCommentRangeEnd,
    Initial = "NS",
    Author = "Nayyer Shahbaz",
    Text = "Second Revisions..."
};

Erstellt eng Instanz vu CommentInsert wou mir d’Detailer wéi Initialen, den Numm vum Auteur an den Inhalt vum Kommentar / Annotatioun spezifizéieren.

var insertRequest = new InsertCommentOnlineRequest(firstFile, requestComment, destFileName: "Commented.docx");

Erstellt elo en Objet vun InsertCommentOnlineRequest wou mir den Inhalt vum Input Word Dokument, CommentInsert Objet an den Numm vum resultéierende Word Dokument passéieren.

 var response = wordsApi.InsertCommentOnline(insertRequest);

Schlussendlech rufft d’InsertCommentOnline(…) Method un fir e Kommentar an engem Word-Dokument op de spezifizéierte Node ze setzen.

D’Probedateien, déi am uewe genannte Beispill benotzt ginn, kënnen erofgeluede ginn vun input-sample-1.docx an Commented.docx.

Füügt Kommentaren op Word Dokument mat cURL Kommandoen

Mir verstinn datt d’Addéieren vun Annotatiounen oder Kommentaren zu Word Dokumenter mat cURL Befehle ka ganz profitabel sinn, well et e programmateschen Wee gëtt fir Annotatiounen a Bulk ze addéieren oder Iech d’Funktionalitéit an Ären existente Workflows z’integréieren. Mat der Hëllef vun Aspose.Words Cloud API a cURL Kommandoen, Kommentaren op e Word-Dokument bäizefügen kann duerch eng Serie vun API-Uriff gemaach ginn. Dëst beinhalt d’Schécken vun Ufroen un d’Aspose.Words Cloud API mat passenden Parameteren, wéi d’Dokumentdatei, d’Location, den Text an d’Auteurinformatioun, fir e Kommentar ze kreéieren.

Den éischte Schrëtt ass en “AccessToken” ze kréien andeems Dir eng POST Ufro mat Ärem App SID an App Key Detailer schéckt. Fëllt w.e.g. de folgende Kommando aus:

curl -v "https://api.aspose.cloud/connect/token" \
 -X POST \
 -d "grant_type=client_credentials&client_id=ee170169-ca49-49a4-87b7-0e2ff815ea6e&client_secret=7f098199230fc5f2175d494d48f2077c" \
 -H "Content-Type: application/x-www-form-urlencoded" \
 -H "Accept: application/json"

Wann mir den AccessToken hunn, fuert w.e.g. de folgende Kommando aus fir eng Annotatioun an d’Word Dokument ze setzen.

curl -v "https://api.aspose.cloud/v4.0/words/{inputWordFile}/comments?destFileName={resultantFile}&revisionAuthor=Nayyer%20Shahbaz" \
-X POST \
-H  "accept: application/json" \
-H  "Authorization: Bearer {accessToken}" \
-H  "Content-Type: application/json" \
-d "{  \"RangeStart\": {    \"Node\": {      \"link\": {        \"Href\":\"http://api.aspose.cloud/v4.0/words/input-sample-1.docx/sections/0/body/paragraphs/5/runs/2\",        \"Rel\": \"self\"      },      \"NodeId\": \"0.6.5.3\",\"Text\": \"dictum\",    },    \"Offset\": 0  },  \"RangeEnd\": {    \"Node\": {      \"link\": {        \"Href\": \"http://api.aspose.cloud/v4.0/words/input-sample-1.docx/sections/0/body/paragraphs/5/runs/2\",        \"Rel\": \"self\",      },      \"NodeId\": \"0.6.5.3\",\"Text\": \"dictum\",    },    \"Offset\": 0  },  \"Author\": \"Nayyer Shahbaz\",  \"Initial\": \"NS\",  \"DateTime\": \"2023-04-28T12:52:50.108Z\",  \"Text\": \"Second Revisions ....\"}"

Ersetzen {inputWordFile} mam Numm vum Input Word-Dokument (schon an der Cloud-Späichere verfügbar), {accessToken} mam JWT Zougangstoken uewen generéiert an {resultantFile} mam Numm vum resultéierende Word-Dokument mat enger neier Annotatioun .

Conclusioun

Als Conclusioun, Annotatiounen a Kommentarer zu Word Dokumenter bäizefügen kann eng nëtzlech Feature fir kollaborativ Redaktioun an Iwwerpréiwung sinn. Mat der Hëllef vun Aspose.Words Cloud a cURL Kommandoen oder der Aspose.Words Cloud SDK fir .NET kann dës Aufgab effizient an effizient erfëllt ginn. Egal ob Dir léiwer d’Cloud-baséiert Léisung oder d’SDK benotzt, Aspose.Words bitt e mächtegt an zouverléissegt Tool fir d’Word-Dokumenter ze annotéieren. Mir hoffen, datt dësen Tutorial hëllefräich war fir Iech duerch de Prozess ze guidéieren an Iech all déi néideg Detailer geliwwert huet fir unzefänken.

Nëtzlech Linken

Zesummenhang Artikelen

Mir recommandéieren Iech duerch déi folgend Blogs ze goen: