本文介绍了使用 NET REST API 在 Word 中添加书签的过程。我们将使用 Aspose.Words for .NET Cloud SDK 通过 C# 低代码 API 将书签添加到 Word 文档。您将设置各种书签参数并调用 API 调用来将此书签添加到本地磁盘上的 Word 文件中。
先决条件
- 创建帐户并获取 API 凭据
- 下载 Aspose.Words Cloud SDK for Dotnet to add a bookmark in a Word file
- 使用上述 SDK 设置 C# 解决方案项目
使用 NET REST API 在 Word 中创建书签的步骤
- 设置 API 的 Client ID 和 Client Secret 以添加书签
- 使用您的客户端凭据实例化 WordsApi 类的对象
- 将源Word文件读入内存流以创建书签
- 使用 PositionInsideNode 类定义书签的开始和结束范围
- 通过提供所需参数创建 InsertBookmarkOnlineRequest 对象
- 根据InsertBookmarkOnlineRequest调用insert a bookmark的InsertBookmarkOnline方法
- 使用新书签保存生成的 Word 文件
上述步骤描述了如何使用 C# 低代码 API 在 Word 中创建书签。通过创建 WordsApi 对象开始该过程,然后读取源 Word 文件并定义书签参数。最后,通过调用一些 API 调用,然后将生成的 Word 文件保存在本地磁盘上,将此书签添加到您的 Word 文件中。
使用 C# REST API 在 Word 中插入书签的代码
using System; | |
using System.IO; | |
using Aspose.Words.Cloud.Sdk; | |
using Aspose.Words.Cloud.Sdk.Model; | |
using Aspose.Words.Cloud.Sdk.Model.Requests; | |
namespace WordsSample.Words | |
{ | |
public class Bookmarks | |
{ | |
public void AddBookmark() | |
{ | |
try | |
{ | |
// Set the client secret and ID | |
var config = new Configuration(); | |
config.ClientSecret = "Client Secret"; | |
config.ClientId = "Client ID"; | |
// Instantiate the WordsApi object | |
var wordsApi = new WordsApi(config); | |
// Read the input file | |
using var requestDocument = File.OpenRead("Sample.docx"); | |
// Define start and end range for the bookmark | |
var requestBookmarkStartRange = new PositionInsideNode | |
{ | |
NodeId = "0.0.0.0", | |
Offset = 0 | |
}; | |
var requestBookmarkEndRange = new PositionInsideNode() | |
{ | |
NodeId = "0.0.0.0", | |
Offset = 0 | |
}; | |
// Initialize the BookmarkInsert object | |
var requestBookmark = new BookmarkInsert() | |
{ | |
StartRange = requestBookmarkStartRange, | |
EndRange = requestBookmarkEndRange, | |
Name = "new_bookmark", | |
Text = "Some text" | |
}; | |
string output = "output.docx"; | |
// Insert the bookmark | |
var insertRequest = new InsertBookmarkOnlineRequest(requestDocument, requestBookmark,destFileName:output); | |
var insertTask = wordsApi.InsertBookmarkOnline(insertRequest); | |
insertTask.Wait(); | |
var result = insertTask.Result; | |
// Save the Word file with the bookmark | |
if (result.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); | |
} | |
} | |
} | |
} |
此示例代码展示了如何使用 C# REST API 在 Word 中添加书签。 PositionInsideNode 类用于设置目标 Word 文件中书签的开始和结束范围。结果流作为具有指定键的字典项返回,并且可以使用 TryGetValue 方法进行检索,如示例代码中所示。
在本主题中,我们学习了如何使用 C# REST API 在 Word 中制作书签。如果您想要将 Word 文件转换为 HTML 文件,请参阅有关 使用 NET REST API 将 DOCX 转换为 HTML 的文章。