在 C# 中使用 REST API 以 HTML 页面形式查看 Word 文档

作为 C# 开发人员，您可以在云上的 .NET 应用程序中以编程方式轻松地将 DOC 或 DOCX 文件呈现为 HTML 页面。它可用于与相关利益相关者共享您的 Word 文档作为响应式 HTML 页面。在本文中，您将学习如何在 C# 中使用 REST API 将 Word 文档作为 HTML 页面查看。

Word 到 HTML 查看器 REST API 和 .NET SDK

为了将 DOC 或 DOCX 文件呈现为 HTML，我将使用 GroupDocs.Viewer Cloud 的 .NET SDK API。它允许您以编程方式呈现和查看各种流行的文档和图像文件格式，例如 Word、Excel、PDF、PowerPoint, Visio、Project、Outlook、JPG、PNG 等。

您可以从 NuGet 包管理器将 GroupDocs.Viewer Cloud 安装到您的 Visual Studio 项目中，或者在包管理器控制台中使用以下命令进行安装：

Install-Package GroupDocs.Viewer-Cloud

在开始执行步骤和可用代码示例之前，请从 仪表板 获取您的客户端 ID 和密码。获得客户端 ID 和密码后，添加如下所示的代码：

string MyClientId = "112f0f38-9dae-42d5-b4fc-cc84ae644972";
string MyClientSecret = "16ad3fe0bdc39c910f57d2fd48a5d618";
string MyStorage = "";

var configuration = new Configuration(MyClientId, MyClientSecret);

在 C# 中使用 REST API 以 HTML 页面形式查看 Word 文档

您可以按照以下简单步骤在云端以 HTML 页面形式查看 Word 文档：

上传文件

首先，使用下面给出的代码示例将 DOCX 文件上传到云端：

// 初始化API
var apiInstance = new FileApi(configuration);

// 从本地/光盘打开 IOStream 中的文件。
var fileStream = File.Open(@"C:\Files\Sample.docx", FileMode.Open);

// 创建文件上传请求
var request = new UploadFileRequest("sample.docx", fileStream, MyStorage);

// 上传文件
var response = apiInstance.UploadFile(request);

因此，上传的 DOCX 文件将在您的仪表板的 文件部分 中可用。

使用 C# 将 Word 呈现为 HTML 页面

您可以按照以下步骤以编程方式将 Word 文档呈现为 HTML 页面：

  • 创建 ViewAPI 的实例
  • 创建 FileInfo 的实例
  • 提供输入文件路径
  • 创建 ViewOptions 的实例
  • 将 FileInfo 分配给 ViewOptions
  • 将 ViewFormat 设置为“HTML”
  • 通过使用 ViewOptions 调用 CreateViewRequest 方法来创建视图请求
  • 通过使用 CreateViewRequest 调用 CreateView() 方法获得响应

以下代码示例展示了如何使用 C# 中的 REST API 将 Word 文档呈现为 HTML 页面。

// 初始化API
var apiInstance = new ViewApi(configuration);

// 输入文件路径
var fileInfo = new GroupDocs.Viewer.Cloud.Sdk.Model.FileInfo();
fileInfo.FilePath = "sample.docx";

// 定义视图选项
var viewOptions = new ViewOptions();
viewOptions.FileInfo = fileInfo;
viewOptions.ViewFormat = ViewOptions.ViewFormatEnum.HTML;   // output view format

// 创建查看请求
var request = new CreateViewRequest(viewOptions);

// 创建视图
var response = apiInstance.CreateView(request);
使用 C# 中的 REST API 将 Word 文档作为 HTML 页面查看。

使用 C# 中的 REST API 将 Word 文档作为 HTML 页面查看。

下载呈现的 HTML 页面

上面的代码示例会将呈现的 HTML 页面保存在云端。您可以使用以下代码示例下载它们：

// 初始化API
var fileApi = new FileApi(configuration);

// 保存所有呈现的 HTML 页面
foreach (var page in response.Pages)
{
    // 创建下载文件请求
    var downloadFileRequest = new DownloadFileRequest(page.Path, MyStorage);

    // 下载文件
    var file = fileApi.DownloadFile(downloadFileRequest);
    
    // 将文件保存在工作目录中
    using (var fileStream = System.IO.File.Create("C:\\Files\\" + page.Path))
    {
        file.Seek(0, SeekOrigin.Begin);
        file.CopyTo(fileStream);
    }
}

使用 C# 使用呈现选项将 Word 呈现为 HTML 页面

您可以按照以下给出的步骤，使用特定的呈现选项以编程方式将 Word 文档呈现为 HTML 页面：

  • 创建 ViewAPI 的实例
  • 创建 FileInfo 的实例
  • 提供输入文件路径
  • 创建 ViewOptions 的实例
  • 将 FileInfo 分配给 ViewOptions
  • 将 ViewFormat 设置为“HTML”
  • 创建 RenderOptions 的实例
  • 设置各种呈现选项，例如 PagesToRender、RenderComments 等。
  • 通过使用 ViewOptions 调用 CreateViewRequest 方法来创建视图请求
  • 通过使用 CreateViewRequest 调用 CreateView() 方法获得响应

以下代码示例显示如何使用 C# 中的 REST API 将 Word 文档呈现为具有呈现选项的 HTML 页面。

// 初始化API
var apiInstance = new ViewApi(configuration);

// 输入文件路径
var fileInfo = new GroupDocs.Viewer.Cloud.Sdk.Model.FileInfo();
fileInfo.FilePath = "sample.docx";

// 定义视图选项
var viewOptions = new ViewOptions();
viewOptions.FileInfo = fileInfo;
viewOptions.ViewFormat = ViewOptions.ViewFormatEnum.HTML;   // output view format

// 定义渲染选项
viewOptions.RenderOptions = new RenderOptions
{
    // 呈现评论
    RenderComments = true,

    // 呈现特定范围的页面
    StartPageNumber = 1,
    CountPagesToRender = 2,
};

// 创建查看请求
var request = new CreateViewRequest(viewOptions);

// 创建视图
var response = apiInstance.CreateView(request);

使用 C# 将带有水印的 Word 呈现为 HTML

您可以按照以下步骤在以编程方式将 Word 文档呈现为 HTML 时添加水印文本：

  • 创建 ViewAPI 的实例
  • 创建 FileInfo 的实例
  • 提供输入文件路径
  • 创建 ViewOptions 的实例
  • 将 FileInfo 分配给 ViewOptions
  • 将 ViewFormat 设置为“HTML”
  • 定义水印视图选项
  • 设置水印文本、大小、颜色和位置
  • 通过使用 ViewOptions 调用 CreateViewRequest 方法来创建视图请求
  • 通过使用 CreateViewRequest 调用 CreateView() 方法获得响应

以下代码示例显示如何使用 C# 中的 REST API 将水印文本添加到呈现的 HTML 页面。

// 初始化API
var apiInstance = new ViewApi(configuration);

// 输入文件路径
var fileInfo = new GroupDocs.Viewer.Cloud.Sdk.Model.FileInfo();
fileInfo.FilePath = "sample.docx";

// 定义视图选项
var viewOptions = new ViewOptions();
viewOptions.FileInfo = fileInfo;
viewOptions.ViewFormat = ViewOptions.ViewFormatEnum.HTML;   // output view format

// 定义水印
viewOptions.Watermark = new Watermark
{
    Text = "This is a sample watermark!",
    Size = 100,
    Color = "Red",
    Position = Watermark.PositionEnum.Diagonal
};
          
// 创建查看请求
var request = new CreateViewRequest(viewOptions);

// 创建视图
var response = apiInstance.CreateView(request);
使用 C# 的带有水印的 Word 到 HTML 渲染。

使用 C# 的带有水印的 Word 到 HTML 渲染。

在线试用

请试用以下使用上述API开发的免费在线Word渲染工具。 https://products.groupdocs.app/viewer/docx

结论

在本文中，您了解了如何在云端以 HTML 页面的形式查看 Word 文档。您还学习了如何使用 C# 中的呈现选项将 Word 呈现为 HTML。此外，您还学习了如何使用 C# 以编程方式将文本水印添加到呈现的 HTML 页面。此外，您还学习了如何以编程方式将 DOCX 文件上传到云端，然后从云端下载呈现的 HTML 文件。您可以使用 文档 了解有关 GroupDocs.Viewer Cloud API 的更多信息。我们还提供了一个 API 参考 部分，让您可以直接通过浏览器可视化我们的 API 并与之交互。如有任何歧义，请随时在论坛上与我们联系。

也可以看看