Тази тема включва процеса за вмъкване на коментари в DOCX с NET REST API. Ще използваме Aspose.Words за .NET Cloud SDK, за да добавим коментар в Word Document с C# Low Code API. Ще получите всички подробности за настройка на средата за разработка и ще следвате дадените стъпки и C# REST API код.
Предпоставка
- Създайте акаунт и получете идентификационни данни за API, за да вмъкнете коментари в DOC файла
- Изтегли Aspose.Words Cloud SDK for Dotnet to include comments in a Word file
- Настройте проект за решение на C# с горния SDK, за да добавите DOCX коментарите
Стъпки за вмъкване на коментари в Word документ с NET REST API
- Задайте ИД на клиента и Тайна на клиента за API, за да добавите коментари във файл на Word
- Създайте обект от класа WordsAPI с идентификационните данни на вашия клиентски акаунт
- Създайте обект на CommentInsert, като предоставите началния и крайния диапазон на коментара
- Създайте заявка за добавяне на коментари, като използвате екземпляр на InsertCommentOnlineRequest, като предоставите името на файла
- Insert the Comments in the Word document онлайн чрез метода InsertComment
- Изтеглете генерирания файл от облака, като използвате потока в речника на response.Documents
- Запазете изтегления файлов поток като DOCX файл на диска
Гореспоменатите стъпки обясняват как да вмъкнете коментари в Word Document с NET REST API. Ще започнем процеса, като инициализираме екземпляра на класа WordsApi с помощта на ClientSecret и ClientId, което след това е последвано от създаване на екземпляра на класа InsertComment чрез задаване на диапазона за начало и диапазон на коментара. След това ще създадем заявката InsertCommentOnlineRequest и ще използваме InsertCommentOnline, за да получим DOCX файловия поток с добавени коментари. Накрая ще запазим файловия поток с добавени коментари на диска като DOCX файл.
Код за добавяне на коментари в Word документ с 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); | |
} | |
} | |
} | |
} |
Този примерен код демонстрира процеса за създаване на коментари в DOCX с C# Low Code API. Класът CommentInsert разкрива свойствата за задаване на диапазона за начало и край на коментари, инициали на коментари, автор и текст. Можете също така да добавите множество коментари в документа. Името на файла, което ще зададем за requesInsertCommentOnlineRequest, ще се използва за извличане на съответния файлов поток на документа от обекта за отговор.
В тази тема се научихме да добавяме коментари в документ на Word с NET REST API. Ако искате да създадете документ на Word, вижте статията за това как да създайте Word файл с NET REST API.