安装

Documentize SDK 的安装

Documentize 可以通过多种方法安装,每种方法都针对不同的开发环境和偏好。以下是安装 Documentize 的推荐方式:

1. NuGet(首选方法)

NuGet 是安装 Documentize 最直接和首选的方法,确保您始终在开发环境中获得最新版本和更新。有关此安装方法的更多详细信息,请查看 如何使用 NuGet 安装 Documentize SDK

2. MSI 安装程序

如果您希望将 Documentize DLL 直接安装到系统中,MSI 安装程序是一个方便的选择。这种方法非常适合希望在多个项目中使用 Documentize 的开发人员,无需手动管理 DLL 文件。有关此安装方法的更多详细信息,请查看 如何使用 MSI 安装 Documentize SDK

3. ZIP 压缩包

对于喜欢手动操作的开发人员,ZIP 压缩包包含 Documentize DLL,您可以直接提取并添加到您的项目中。有关此安装方法的更多详细信息,请查看 如何使用 ZIP 安装 Documentize SDK

2024年12月28日

安装 的子部分

通过 NuGet 安装 Documentize


提示

NuGet 是一个免费的开源包管理器,旨在简化 .NET 中库的添加、删除和更新,如在 Visual Studio 项目中。它自动管理库文件、引用和配置更改。

如何通过 NuGet 包管理器控制台安装

  1. 打开项目:

    • 启动 Visual Studio 并打开你的 .NET 应用程序。
  2. 访问包管理器控制台:

    • 导航至 工具 > NuGet 包管理器 > 包管理器控制台
  3. 安装包:

    • 要安装最新的完整版本,输入命令 Install-Package Documentize
    • 要安装最新的版本,包括热修复,使用 Install-Package Documentize -prerelease
    • Enter 执行命令。

如何通过 NuGet 包管理器控制台更新包

如果你已经通过 NuGet 安装了 Documentize,并希望更新到最新版本:

  1. 打开项目:

    • 启动 Visual Studio 并打开你的 .NET 应用程序。
  2. 访问包管理器控制台:

    • 导航至 工具 > NuGet 包管理器 > 包管理器控制台
  3. 更新包:

    • 要更新到最新的完整版本,输入 Update-Package Documentize
    • 要更新到最新版本,包括热修复,使用 Update-Package Documentize -prerelease
    • Enter 执行命令。

如何通过 NuGet 包管理器 GUI 安装

  1. 打开项目:

    • 启动 Visual Studio 并打开你的 .NET 应用程序。
  2. 导航到管理 NuGet 包:

    • 项目 菜单中,选择 管理 NuGet 包
  3. 搜索 Documentize:

    • 进入 浏览 标签,在搜索框中输入 Documentize
  4. 安装包:

    • 点击 Documentize 最新版本旁边的 安装/更新
    • 在弹出窗口中点击 接受 确认。

使用 NuGet 的优点

  • 自动依赖管理:

    • NuGet 自动处理依赖项,确保所有所需库都包含在内并正确更新。这减少了缺失或不兼容依赖项的风险。
  • 简化更新:

    • 通过 NuGet 更新包非常简单,无论是通过包管理器控制台还是 GUI。这使得保持库更新至最新功能和错误修复变得轻而易举。
  • 与 Visual Studio 集成:

    • NuGet 与 Visual Studio 无缝集成,提供用户友好的界面,在开发环境中管理包而无需离开。
  • 版本管理:

    • NuGet 允许你指定和管理不同版本的库,使你可以轻松回退到先前版本或者测试新版本,而不破坏你的开发。

使用 NuGet 的缺点

  • 仅限于 Visual Studio:

    • NuGet 主要设计用于 Visual Studio 中使用。虽然可以在其他环境中使用,但集成在 Visual Studio 中最为强大。
  • 版本冲突的潜在可能:

    • 在有许多依赖项的大型项目中,管理版本和解决冲突可能变得复杂。NuGet 提供工具来管理此事,但需要仔细关注。
  • 网络依赖性:

    • 安装和更新包需要互联网连接。如果你在一个限制或没有互联网接入的环境中工作,你可能需要使用离线方法或预先下载包。
  • 大型项目的复杂性:

    • 对于具有大量依赖树的非常大型项目,通过 NuGet 管理包的开销可能变得烦琐。在这种情况下,可能需要额外的工具或策略来有效管理依赖项。

通过 MSI 安装 Documentize

提示

MSI 安装程序是安装 Documentize 的便捷且用户友好的选项,特别是如果您希望将 DLL 安装到系统范围内。这种方法通过自动化许多步骤简化了安装过程。

如何通过 MSI 安装程序安装

  1. 下载 MSI 安装程序:

    • 点击 v24.12 MSI 下载最新版本 Documentize 的 MSI 安装程序。
  2. 运行安装程序:

    • 双击下载的 MSI 文件以启动安装向导。
  3. 按照安装向导进行操作:

    • 按照安装程序提供的屏幕说明进行操作。您可能需要同意许可协议并选择安装选项。
  4. 完成安装:

    • 安装完成后,Documentize 的 DLL 将安装到您的系统的全局程序集缓存 (GAC) 或其他指定位置。
  5. 验证安装:

    • 通过验证指定安装目录或 GAC 中是否存在 DLL 来检查其是否正确安装。

使用 MSI 安装程序的优点

  • 易于使用:

    • MSI 安装程序提供简单且指导性的安装过程。它处理所有必要的配置,并将 DLL 放置在中心位置,使您能够在多个项目中轻松使用 Documentize。
  • 系统范围安装:

    • MSI 方法将 Documentize 安装到系统的全局程序集缓存 (GAC) 或其他中心位置。这允许系统上的任何应用程序访问 DLL,而无需在每个项目中单独引用它们。
  • 自动更新:

    • 如果 Documentize 提供了更新的安装程序,您可以通过运行新的 MSI 文件轻松更新安装,通常更新过程会顺利进行。
  • 一致性:

    • 使用 MSI 安装程序可确保所有所需文件在不同环境中正确且一致地安装,从而减少缺失或放错 DLL 的风险。

使用 MSI 安装程序的缺点

  • 灵活性有限:

    • MSI 安装程序将 Documentize 安装到系统范围位置,这可能不适合所有开发环境。它可能缺乏适应项目特定配置或版本的灵活性。
  • 潜在开销:

    • 将 DLL 安装到 GAC 可能会引入开销和复杂性,特别是在需要同时使用多个版本的 Documentize 的情况下。
  • 手动卸载:

    • 如果需要卸载 Documentize,必须使用 MSI 提供的卸载程序,如果未正确管理,可能会留下残余文件或配置。
  • 版本冲突:

    • 系统范围的安装如果不同项目需要不同版本的 Documentize,可能会导致版本冲突。管理这些冲突可能需要额外的配置或清理。

通过 ZIP 安装 Documentize

提示

ZIP 存档非常适合喜欢手动管理库的开发者。这种方法允许你直接下载并提取所需的 DLL 文件,而无需依赖包管理器或安装程序。

如何通过 ZIP 存档安装

  1. 下载 ZIP 存档

    • 点击 v24.12 ZIP 下载最新版本的 Documentize 以存档格式。
  2. 提取内容

    • 下载后,将 ZIP 文件的内容提取到你选择的目录。你可以选择将这些文件保留在共享目录或项目结构内。
  3. 将引用添加到项目中

    • 在你的 IDE 中打开项目(例如 Visual Studio)。
    • 转到 项目 > 添加引用 > 浏览,导航到你提取 DLL 的目录。
    • 选择相关的 DLL 文件并将其添加为项目的引用。
  4. 手动更新

    • 如果发布了新版本的 Documentize,你需要手动下载更新的 ZIP 存档,并用新的 DLL 文件替换项目中的旧文件。

使用 ZIP 存档的优点

  • 完全控制

    • 你可以完全控制 DLL 的存储位置和引用方式。如果你更喜欢自定义设置或需要手动管理依赖关系,这可能是有益的。
  • 不依赖包管理器

    • 与 NuGet 不同,你不依赖包管理器来处理安装。在包管理器不可用或不受欢迎的环境中,这可能是有利的。
  • 可移植性

    • ZIP 存档可以轻松分享并在不同系统之间移动,非常适合需要可移植性或分发而不依赖于外部工具的项目。

使用 ZIP 存档的缺点

  • 手动管理

    • 与 NuGet 不同,更新和依赖管理是自动化的,对于 ZIP 存档,你必须手动管理更新并确保所有所需的 DLL 都被正确引用。
  • 版本冲突的风险

    • 如果你正在管理多个项目或在团队中工作,如果不同的项目使用不同版本的 DLL,就会有版本冲突的风险。这需要仔细跟踪项目间的版本。
  • 没有自动更新

    • 当有新版本可用时,你不会收到自动更新或通知。这可能导致使用过时库的风险,除非你定期检查更新。

非Windows环境

在非Windows环境中使用.NET Core DLL

由于Documentize for .NET支持.NET Standard 2.0 (.NET Core 2.0),因此可以在Linux类操作系统中运行的Core应用程序中使用。我们一直在努力改善我们API中的.NET Core支持。然而,我们建议客户在使用Documentize for .NET的功能时执行一些操作以获得更好的效果。请安装:

  • libgdiplus包
  • 与Microsoft兼容的字体包: ttf-mscorefonts-installer(例如,sudo apt-get install ttf-mscorefonts-installer)。这些字体应该放置在/usr/share/fonts/truetype/msttcorefonts目录下,因为Documentize for .NET在Linux类操作系统中扫描此文件夹。如果操作系统有其他默认的字体文件夹/目录,则在使用Documentize执行任何操作之前,您应该使用以下代码行:
    Documentize.Pdf.Text.FontRepository.Sources.Add(new FolderFontSource("<用户的ms字体路径>"));
 中文