使用 Kanzi Engine 插件

Kanzi Engine 插件扩展了 Kanzi Engine 的功能。Kanzi Engine 在目标平台上执行这些插件。

使用 Kanzi Engine 插件来：

  • 使用 Kanzi Engine API 创建自定义节点，在您的 Kanzi Studio 项目中使用它们，并在 Kanzi Studio Preview 中查看它们的工作原理。

  • 使用 Kanzi Engine API 创建自定义属性类型和消息，并在您的 Kanzi Studio 项目中使用它们。

  • 定义数据入口点到您的 Kanzi 应用程序，并在 Kanzi 应用程序设计师和开发人员之间形成合同。

要了解如何使用 Kanzi Engine 插件，请参阅：

将 Kanzi Engine 插件添加到 Kanzi Studio 项目中。

要将 Kanzi Engine 插件添加到 Kanzi Studio 项目中：

  1. 在 Library 中右键单击 Kanzi Engine Plugins 并选择 Import Kanzi Engine Plugin。

    ../../_images/import-kanzi-engine-plugin.png

    小技巧

    您可以使用脚本自动导入 Kanzi Engine 插件。请参阅 使用脚本导入 Kanzi Engine 插件。

  2. 选择您要导入的插件的 DLL 或 JAR 文件，然后点击 Open。

    备注

    从 Kanzi Studio 3.9.5 开始，Kanzi Java 插件的路径必须遵循以下模式：

    • 对于调试，路径必须是 lib/java/Debug/<PluginName>.jar。

    • 对于发布，路径必须是 lib/java/Release/<PluginName>.jar。

    请参阅 Kanzi Engine Java 插件的 Debug 和 Release 构建类型支持的更改。。

    当您在 Library > Kanzi Engine Plugins 中选择您导入的插件时，您可以在 Properties 中看到该插件为 Kanzi Studio 项目带来的内容列表。例如，在 Properties 中，您可以看到所选插件提供的属性类型、组件、数据源、渲染通道、节点组件和触发器动作类型的列表。

  3. 对于 DLL 插件，确保 Kanzi Studio 工程中的设置与您在 Visual Studio 中构建应用程序和插件工程所使用的解决方案配置相匹配。

    例如，如果您在 Visual Studio 2022 中使用 Release 解决方案配置，则在 Kanzi Studio 工程的 Project > Properties 中设置：

    • Preview Build Configuration 到 Release

    • 将 Preview Visual Studio Version 设置为 2022

    • Preview Working Directory 到 ..\Application\bin。

    通过这些设置，您可以将 Kanzi Studio Preview 设置为与插件一起使用。

    ../../_images/project-properties.png ../../_images/project-properties1.png

  4. 在 Library > Kanzi Engine Plugins 中选择插件，并在 Properties 中确保将 Is Enabled 属性启用。

    ../../_images/enable-is-enabled-property.png

    小技巧

    使用 Is Enabled 属性在您的项目中启用或禁用任何 Kanzi Engine 插件。

  5. 通过按下 Ctrl F8，或选择 Preview > Restart Preview 来重启 Preview。

    您现在可以在您的 Kanzi Studio 项目中使用 Kanzi Engine 插件提供的内容。

检查 Kanzi Engine 插件的更改

在更新 Kanzi Studio 项目中的 Kanzi Engine 插件之前，您可以比较当前使用的 Kanzi Engine 插件与该插件的另一个版本之间的差异。Kanzi Studio 会比较这些插件并列出差异和问题。

要检查 Kanzi Engine 插件的更改：

  1. 构建或复制 Kanzi Engine 插件的 DLL 或 JAR 文件到与插件的先前版本相同的位置。

    ../../_images/mykanziengineplugin-dll-in-file-explorer.png

  2. 在 Library > Kanzi Engine Plugins 的 Kanzi Studio 中，右键单击一个插件并选择 Inspect Kanzi Engine Plugin。

    Kanzi Studio 比较当前使用的 Kanzi Engine 插件的 DLL 或 JAR 与您在上一步中复制的文件，并列出差异。

    ../../_images/inspect-kanzi-engine-plugin.png

在项目中更新 Kanzi Engine 插件

当您想在 Kanzi Studio 项目中使用不同版本的 Kanzi Engine 插件时，您必须在您的 Kanzi Studio 项目中更新该 Kanzi Engine 插件。

要在 Kanzi Studio 项目中更新 Kanzi Engine 插件：

  1. 构建或复制 Kanzi Engine 插件的 DLL 或 JAR 文件到与插件的先前版本相同的位置。

    ../../_images/mykanziengineplugin-dll-in-file-explorer.png

  2. 通过以下方式之一更新 Kanzi Engine 插件：

    • 要更新特定的 Kanzi Engine 插件，在 Library > Kanzi Engine Plugins 中右键单击该插件并选择 Update Kanzi Engine Plugin。

      当 Kanzi Studio 加载插件的新版本时，它会显示插件中定义的属性和类的更改。

      ../../_images/update-plugin-metadata.png

    • 要更新项目或解决方案中的所有 Kanzi Engine 插件， 在 Library 中右键单击 Kanzi Engine Plugins，然后选择：

      • Update Kanzi Engine Plugins in Project 更新 Kanzi Studio 项目中的插件。

      • Update Kanzi Engine Plugins in Solution 更新 Kanzi Studio 项目和引用的项目中的插件。

      当 Kanzi Studio 加载插件的新版本时，它会在 Log 窗口中打印插件中定义的属性和类的更改。

      ../../_images/update-kanzi-engine-plugins-in-project.png

    • 要使用脚本更新 Kanzi Engine 插件，请参阅 使用脚本更新 Kanzi Engine 插件 和 使用脚本更新项目或解决方案中的所有 Kanzi Engine 插件。。

从项目中移除 Kanzi Engine 插件

当您从 Kanzi Studio 项目中移除 Kanzi Engine 插件时，Kanzi Studio 会移除对 Kanzi Engine 插件的引用，但不会删除您移除的 Kanzi Engine 插件的 dll 文件。

要从 Kanzi Studio 项目中删除 Kanzi Engine 插件，请在 Library > Kanzi Engine Plugins 中右键单击要删除的插件，然后选择 Delete。

另请参阅

创建 Kanzi Engine 插件

Kanzi Engine 插件

使用脚本导入和更新 Kanzi Engine 插件