注释 Word 文档

使用 C# .NET 向 Word 文档添加注释

在许多行业中，注释文档是协作和交流的重要组成部分。它允许用户对可以轻松与他人共享的文档提供反馈、建议和评论。尽管如此，Microsoft Word 还是提供了多种注释工具，例如评论、跟踪更改和添加注释，以帮助用户提供反馈并在文档上进行协作。然而，在这篇博文中，我们将探讨如何使用 .NET Cloud SDK 对 Word 文档 进行批注，使用户更容易交流和在文档上进行协作。

用于添加单词注释的 REST API

使用 Aspose.Words Cloud SDK for .NET，您可以使用 C# 语言以编程方式轻松地向 Word 文档添加评论、回复和注释。该 SDK 为 Word 文档操作提供了一套全面的 REST API，并支持所有主要文档格式，包括 DOC、DOCX、[RTF](https ://docs.fileformat.com/word-processing/rtf/)，等等。现在，借助此 SDK，您可以通过轻松高效地向 Word 文档添加批注、评论和其他审阅元素来增强您的工作流程和协作过程。

要使用 SDK，请在 NuGet 包管理器中搜索“Aspose.Words-Cloud”，然后单击“添加包”按钮以在 .NET 项目中添加 SDK 引用。

注意：要访问 REST API，您需要注册并获取您的个人凭据。请查看 快速入门 指南以获取相关信息。

使用 C# 添加 Word 文档批注

请尝试使用以下代码片段使用 .NET Cloud SDK 添加 Word 文档注释。

// 如需完整示例和数据文件，请访问 
https://github.com/aspose-words-cloud/aspose-words-cloud-dotnet

// 从 https://dashboard.aspose.cloud/ 获取客户端凭证
string clientSecret = "7f098199230fc5f2175d494d48f2077c";
string clientID = "ee170169-ca49-49a4-87b7-0e2ff815ea6e";

// 使用 ClinetID 和 Client Secret 详细信息创建配置对象
var config = new Aspose.Words.Cloud.Sdk.Configuration { ClientId = clientID, ClientSecret = clientSecret };
// 初始化 WordsApi 实例
var wordsApi = new WordsApi(config);

string firstDocument = "input-sample-1.docx";
// 从本地驱动器读取第一个 Word 文档的内容
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)
{
    // 文档注释过程中的任何异常
    Console.Write(ex);
}
word文档批注预览

图像：- 使用 REST API 预览 Word 文档注释。

// 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);

使用个性化客户端凭据创建 WordsApi 对象。

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

从本地驱动器读取输入的Word文档的内容。

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

创建一个 NodeLink 对象，为 Annotation 定义 NodeId。对 CommentRangeStartNode 和 CommentRangeEndNode 实例重复此过程。

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

创建一个 CommentInsert 实例，我们在其中指定详细信息，例如首字母、作者姓名和评论/注释的内容。

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

现在创建一个 InsertCommentOnlineRequest 对象，我们在其中传递输入 Word 文档的内容、CommentInsert 对象和生成的 Word 文档的名称。

 var response = wordsApi.InsertCommentOnline(insertRequest);

最后，调用 InsertCommentOnline(…) 方法在 Word 文档中的指定节点处插入注释。

上述示例中使用的示例文件可以从 input-sample-1.docx 和 Commented.docx 下载。

使用 cURL 命令向 Word 文档添加注释

我们知道，使用 cURL 命令向 Word 文档添加注释或评论可能非常有益，因为它提供了一种编程方式来批量添加注释，或者使您能够将功能集成到现有工作流中。借助 Aspose.Words Cloud API 和 cURL 命令，可以通过一系列 API 调用向 Word 文档添加评论。这包括向 Aspose.Words 云 API 发送请求以及适当的参数，例如文档文件、位置、文本和作者信息，以创建评论。

第一步是通过发送带有您的 App SID 和 App Key 详细信息的 POST 请求来获取“accessToken”。请执行以下命令：

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"

一旦我们获得了accessToken，请执行以下命令为Word文档插入注释。

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 ....\"}"

将 {inputWordFile} 替换为输入 Word 文档的名称(已在云存储中可用)，将 {accessToken} 替换为上面生成的 JWT 访问令牌，并将 {resultantFile} 替换为包含新注释的结果 Word 文档的名称.

结论

总之，向 Word 文档添加批注和注释对于协同编辑和审阅来说是一项非常有用的功能。在 Aspose.Words Cloud 和 cURL 命令或 Aspose.Words Cloud SDK for .NET 的帮助下，可以高效且有效地完成此任务。无论您喜欢使用基于云的解决方案还是 SDK，Aspose.Words 都提供了一个强大而可靠的工具来注释 Word 文档。我们希望本教程有助于指导您完成整个过程，并为您提供了入门所需的所有必要详细信息。

有用的链接

相关文章

我们强烈建议浏览以下博客：