> For the complete documentation index, see [llms.txt](https://chaoses-ib.gitbook.io/directory-opus/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://chaoses-ib.gitbook.io/directory-opus/guan-fang-shou-ce/readme.zh-10/readme.zh-3/readme.zh/func.zh.md).

# Func

**Func** 对象在脚本通过命令调用时被传递给脚本。在 [脚本函数](/directory-opus/guan-fang-shou-ce/readme.zh-8/script_functions.zh.md) 中，它被传递给 [**OnClick**](/directory-opus/guan-fang-shou-ce/readme.zh-10/readme.zh-3/readme.zh-1/onclick.zh.md) 方法作为 [**ClickData**](/directory-opus/guan-fang-shou-ce/readme.zh-10/readme.zh-3/readme.zh/clickdata.zh.md)**.func** 属性，在 [添加内部命令](/directory-opus/guan-fang-shou-ce/readme.zh-8/readme.zh-6/adding_a_new_internal_command.zh.md) 的脚本加载项中，通过 [**ScriptCommandData**](/directory-opus/guan-fang-shou-ce/readme.zh-10/readme.zh-3/readme.zh/scriptcommanddata.zh.md)**.func** 属性传递。**Func** 对象提供有关命令的默认源和目标的信息，以及有关它如何被调用的详细信息。

| 属性名称       | 返回值类型                                                                                                      | 描述                                                                                                                                                                                                                                                                                                                                                                       |
| ---------- | ---------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| args       | *object:*[**Args**](/directory-opus/guan-fang-shou-ce/readme.zh-10/readme.zh-3/readme.zh/args.zh.md)       | 返回一个 [**Args**](/directory-opus/guan-fang-shou-ce/readme.zh-10/readme.zh-3/readme.zh/args.zh.md) 对象，该对象提供对调用此脚本的命令行上给定的任何参数的访问权限。当脚本为 Opus 添加了 [内部命令](/directory-opus/guan-fang-shou-ce/readme.zh-8/readme.zh-6/adding_a_new_internal_command.zh.md) 时，使用此方法。添加命令时可以提供命令行模板，用户在命令行上为脚本命令提供的任何参数都将通过此对象提供。 对于大多数情况，**argsmap** 属性可能是访问命令参数的更简单方法。                         |
| argsmap    | *object:*[**Map**](/directory-opus/guan-fang-shou-ce/readme.zh-10/readme.zh-3/readme.zh/map.zh.md)         | 返回一个 [**Map**](/directory-opus/guan-fang-shou-ce/readme.zh-10/readme.zh-3/readme.zh/map.zh.md) 对象，该对象提供命令行上给定的每个参数的关键字查找。只有在命令行上使用了某个参数时，它才会出现在 [**Map**](/directory-opus/guan-fang-shou-ce/readme.zh-10/readme.zh-3/readme.zh/map.zh.md) 中，因此您可以使用 [**Map**](/directory-opus/guan-fang-shou-ce/readme.zh-10/readme.zh-3/readme.zh/map.zh.md)**.exists()** 方法轻松检查哪些参数存在。 |
| command    | *object:*[**Command**](/directory-opus/guan-fang-shou-ce/readme.zh-10/readme.zh-3/readme.zh/command.zh.md) | 此属性返回一个预先填充的 [**Command**](/directory-opus/guan-fang-shou-ce/readme.zh-10/readme.zh-3/readme.zh/command.zh.md) 对象，该对象可用于对源和目标标签页运行命令。使用此对象等效于调用 [**DOpusFactory**](/directory-opus/guan-fang-shou-ce/readme.zh-10/readme.zh-3/readme.zh/dopusfactory.zh.md)**.Command** 并手动设置源和目标标签页。                                                                                    |
| desttab    | *object:*[**Tab**](/directory-opus/guan-fang-shou-ce/readme.zh-10/readme.zh-3/readme.zh/tab.zh.md)         | 此对象表示函数的默认目标标签页。                                                                                                                                                                                                                                                                                                                                                         |
| fromdrop   | *bool*                                                                                                     | 如果命令是通过拖放操作调用的，则返回 **True**。                                                                                                                                                                                                                                                                                                                                             |
| fromkey    | *bool*                                                                                                     | 如果命令是通过键盘调用的（即通过热键而不是按钮），则返回 **True**。                                                                                                                                                                                                                                                                                                                                   |
| qualifiers | *string*                                                                                                   | <p>返回一个字符串，表示用户在调用命令时按下的任何限定符键。</p><p>该字符串可以包含以下任何或所有内容：<em>shift</em>, <em>ctrl</em>, <em>alt</em>, <em>lwin</em>, <em>rwin</em>。</p><p>如果没有按下限定符，该字符串将为：<em>none</em></p>                                                                                                                                                                                              |
| sourcetab  | *object:*[**Tab**](/directory-opus/guan-fang-shou-ce/readme.zh-10/readme.zh-3/readme.zh/tab.zh.md)         | 此对象表示函数的默认源标签页。                                                                                                                                                                                                                                                                                                                                                          |
| viewer     | *object:*[**Viewer**](/directory-opus/guan-fang-shou-ce/readme.zh-10/readme.zh-3/readme.zh/viewer.zh.md)   | 如果此按钮是从 [独立图像查看器](/directory-opus/guan-fang-shou-ce/readme.zh-4/readme.zh.md) 中运行的，则此对象表示查看器窗口。                                                                                                                                                                                                                                                                          |

| 方法名称 | **参数** | 返回值类型                                                                                                    | 描述                                                                                                                                                    |
| ---- | ------ | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| Dlg  | *无*    | *object:*[**Dialog**](/directory-opus/guan-fang-shou-ce/readme.zh-10/readme.zh-3/readme.zh/dialog.zh.md) | 创建一个新的 [**Dialog**](/directory-opus/guan-fang-shou-ce/readme.zh-10/readme.zh-3/readme.zh/dialog.zh.md) 对象，允许您显示对话框和弹出菜单。对话框的 **window** 属性将自动分配给源标签页。 |