Det här ämnet omfattar processen att infoga kommentarer i DOCX med NET REST API. Vi kommer att använda Aspose.Words för .NET Cloud SDK för att lägga till en kommentar i Word-dokument med C# Low Code API. Du kommer att få alla detaljer för att ställa in utvecklingsmiljön och följa de givna stegen och C# REST API-koden.
Nödvändig förutsättning
- Skapa ett konto och få API-uppgifter för att infoga kommentarer i DOC-filen
- Ladda ner Aspose.Words Cloud SDK for Dotnet to include comments in a Word file
- Ställ in C#-lösningsprojekt med ovanstående SDK för att lägga till DOCX-kommentarerna
Steg för att infoga kommentarer i Word-dokument med NET REST API
- Ställ in klient-ID och klienthemlighet för API:et för att lägga till kommentarer i en Word-fil
- Skapa ett objekt av WordsAPI-klassen med dina kundkontouppgifter
- Skapa ett objekt av CommentInsert genom att tillhandahålla kommentarens start- och slutintervall
- Skapa en begäran om att lägga till kommentarer med en instans av InsertCommentOnlineRequest genom att ange filnamnet
- Insert the Comments in the Word document online med metoden InsertComment
- Ladda ner den genererade filen från molnet med hjälp av strömmen i response.Documents dictionary
- Spara den nedladdade filströmmen som DOCX-fil på disken
Ovannämnda steg förklarar hur man infogar kommentarer i Word-dokument med NET REST API. Vi kommer att påbörja processen genom att initiera WordsApi-klassens instans med hjälp av ClientSecret och ClientId, som sedan följs av att skapa klassen InsertComment-instansen genom att ställa in intervallet för kommentarstart och intervall. Vi kommer sedan att skapa InsertCommentOnlineRequest-förfrågan och använda InsertCommentOnline för att hämta DOCX-filströmmen med tillagda kommentarer. Slutligen kommer vi att spara filströmmen med tillagda kommentarer på disken som DOCX-fil.
Kod för att lägga till kommentarer i Word-dokument med NET REST API
using System; | |
using System.IO; | |
using System.Linq; | |
using Aspose.Words.Cloud.Sdk; | |
using Aspose.Words.Cloud.Sdk.Model; | |
using Aspose.Words.Cloud.Sdk.Model.Requests; | |
namespace WordsSample.Words | |
{ | |
public class Comments | |
{ | |
public void InsertComments() | |
{ | |
try | |
{ | |
var config = new Configuration(); | |
config.ClientSecret = "secret"; | |
config.ClientId = "clientID"; | |
string output = "output.docx"; | |
var wordsApi = new WordsApi(config); | |
using var requestDocument = File.OpenRead("Sample.docx"); | |
var requestCommentRangeStart = new PositionInsideNode() | |
{ | |
NodeId = "0.0.0.0", | |
Offset = 0 | |
}; | |
var requestCommentRangeEnd = new PositionInsideNode() | |
{ | |
NodeId = "0.0.0.0", | |
Offset = 0 | |
}; | |
var requestComment = new CommentInsert() | |
{ | |
RangeStart = requestCommentRangeStart, | |
RangeEnd = requestCommentRangeEnd, | |
Initial = "IA", | |
Author = "John Doe", | |
Text = "A new Comment" | |
}; | |
var insertRequest = new InsertCommentOnlineRequest(requestDocument, requestComment, destFileName:output); | |
var task = wordsApi.InsertCommentOnline(insertRequest); | |
task.Wait(); | |
var res = task.Result; | |
if (res.Document.TryGetValue(output, out var stream)) | |
{ | |
stream.Position = 0; | |
using (var fileStream = File.Create(output)) | |
{ | |
stream.Seek(0, SeekOrigin.Begin); | |
stream.CopyTo(fileStream); | |
} | |
} | |
} | |
catch (Exception e) | |
{ | |
Console.WriteLine(e.Message); | |
} | |
} | |
} | |
} |
Denna exempelkod visar processen att skapa kommentarer i DOCX med C# Low Code API. Klassen CommentInsert exponerar egenskaperna för att ställa in intervallet för kommentarers start och slut, kommentarinitialer, författare och text. Du kan också lägga till flera kommentarer i dokumentet. Filnamnet som vi kommer att ange för requesInsertCommentOnlineRequest kommer att användas för att extrahera respektive dokumentfilström från svarsobjektet.
I det här ämnet har vi lärt oss att lägga till kommentarer i Word-dokument med NET REST API. Om du vill skapa ett Word-dokument, se artikeln om hur du skapa en Word-fil med NET REST API.