如何使用 GroupDocs.Signature for .NET 取消文档验证:事件处理指南

介绍

您是否正在寻找高效的方法来管理长时间运行的文档验证任务?借助 GroupDocs.Signature for .NET,您可以处理进度事件,从而有效地监控和控制这些流程。本指南将向您展示如何实现一个根据特定条件(例如处理时间超过阈值)取消操作的系统。

在本文中,我们将探讨:

  • 设置并安装 GroupDocs.Signature for .NET
  • 在应用程序中实现进度事件处理
  • 根据特定条件取消进程
  • 这些功能的实际应用

先决条件

所需的库和依赖项

要遵循本指南,请确保您已:

  • 适用于 .NET 的 GroupDocs.Signature:文档签名的核心库。
  • .NET Framework 或 .NET Core:建议使用4.6.1或更高版本。

环境设置要求

确保您的开发环境设置了 Visual Studio 或支持 .NET 项目的兼容 IDE。

知识前提

熟悉 C# 和 .NET 中事件处理的基本知识将会有所帮助,但不是强制性的,因为我们将在这里介绍基本知识。

为 .NET 设置 GroupDocs.Signature

首先,使用以下方法之一安装 GroupDocs.Signature 库:

.NET CLI

dotnet add package GroupDocs.Signature

包管理器

Install-Package GroupDocs.Signature

NuGet 包管理器 UI 搜索“GroupDocs.Signature”并安装最新版本。

许可证获取

您可以获取免费试用许可证来测试 GroupDocs.Signature 的全部功能。如果您要用于生产环境,可以考虑购买许可证:

  • 免费试用:非常适合测试和初步开发。
  • 临时执照:如果您需要试用期以外的更多时间进行评估,这将很有用。
  • 购买:获得长期商业项目的完整许可。

基本初始化

安装后,在项目中初始化 GroupDocs.Signature 以开始使用文档签名:

using GroupDocs.Signature;

此设置允许您创建 Signature 并开始探索其功能。

实施指南

我们将把实施过程分解为可管理的部分,重点关注不同的功能。

功能 1:进度事件处理

处理进度事件的功能可让您监控正在进行的进程。以下是实现此功能的方法:

概述

此功能允许您的应用程序对进程进度的变化做出反应,提供在需要时取消操作的机制。

逐步实施

3.1 设置事件处理程序 首先,定义一个事件处理方法,检查处理时间是否超过 100 毫秒(0.1 秒)。

private static void OnVerifyProgress(Signature sender, ProcessProgressEventArgs args)
{
    // 检查处理时间是否超过 350 个刻度。
    if (args.Ticks > 350) 
    {
        args.Cancel = true; // 取消该进程。
        Console.WriteLine("Sign progress was canceled. Time spent {0} mlsec", args.Ticks);
    }
}

3.2 附加事件处理程序 接下来,将此事件处理程序附加到您的 Signature 您的验证方法中的实例。

using (Signature signature = new Signature(filePath))
{
    // 附加进度事件的事件处理程序。
    signature.VerifyProgress += OnVerifyProgress;

    ...
}

3.3 执行验证流程 最后,在处理潜在取消的同时执行文档验证流程:

// 执行验证过程。
VerificationResult result = signature.Verify(options);

if (result.IsValid)
{
    Console.WriteLine("Document verification was not canceled!");
}
else
{
    Console.WriteLine("Document verification was canceled successfully!");
}

功能2:文件验证及取消

本节重点介绍如何验证文档,同时结合进度事件处理以进行取消。

概述

通过设置验证选项并附加进度处理程序,您可以在过程耗时过长时取消该过程,从而确保您的应用程序保持响应。

4.1 定义验证选项 设置 TextVerifyOptions 指定文档的哪些方面需要验证:

TextVerifyOptions options = new TextVerifyOptions("Text signature")
{
    // 可以在此处指定其他配置。
};

实际应用

了解进度事件的处理和取消功能如何为您的应用程序带来益处至关重要。以下是一些用例:

  1. 批处理:在需要验证多个文件的情况下有效地管理处理时间。
  2. 用户反馈系统:当操作时间超出预期时向用户提供实时反馈,提升用户体验。
  3. 资源管理:自动取消可能给系统资源带来压力的长时间运行的任务。
  4. 与工作流自动化集成:在更大的自动化工作流程中使用这些功能,以确保顺利运行而不会出现延迟。
  5. 测试和开发环境:快速测试您的应用程序如何处理不同的处理场景。

性能考虑

使用 GroupDocs.Signature 时优化性能对于维持高效操作至关重要:

  • 资源使用情况:注意内存使用情况,尤其是在处理大型文档时。

  • 最佳实践

    • 处置 Signature 对象及时释放资源。
    • 明智地使用取消事件以防止不必要的处理。

结论

在本教程中,您学习了如何使用 GroupDocs.Signature for .NET 在文档验证中实现进度事件处理和流程取消。这些技术可以显著提高应用程序的效率和响应能力。

下一步,考虑探索 GroupDocs.Signature 提供的其他功能,例如数字签名和签名搜索功能,以进一步改善您的文档管理解决方案。

常见问题解答部分

Q1:在 GroupDocs.Signature 中处理进度事件的目的是什么? 进度事件有助于监视和控制长时间运行的验证任务,如果它们超过某个时间阈值,您可以取消它们。

Q2:如何附加进程进度事件处理程序? 使用 VerifyProgress 您的活动 Signature 实例。

Q3:取消文档处理有哪些常见场景? 适用于批处理、用户反馈系统和资源管理,以维持系统效率。

Q4:我可以调整取消流程的时间阈值吗? 是的,修改事件处理程序方法中的条件(例如, args.Ticks > 350) 以满足您的要求。

Q5:如果我的应用程序需要处理多种文档类型,我该怎么办? GroupDocs.Signature 支持多种文档格式。请确保为每种类型配置适当的验证选项。

资源