> 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/viewer.zh.md).

# Viewer

**Viewer** 对象代表一个独立的 [图像查看器](/directory-opus/guan-fang-shou-ce/readme.zh-4/readme.zh.md)。[**Viewer**](/directory-opus/guan-fang-shou-ce/readme.zh-10/readme.zh-3/readme.zh/viewers.zh.md) 对象返回一个 **Viewer** 对象集合，该对象可以通过 [**DOpus**](/directory-opus/guan-fang-shou-ce/readme.zh-10/readme.zh-3/readme.zh/dopus.zh.md)**.viewers** 属性获取。对于从查看器内部启动的函数（例如，从其工具栏启动的函数），当前 **Viewer** 对象由 [**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-10/readme.zh-3/readme.zh/func.zh.md)**.viewer** 属性提供。

| 属性名称               | 返回类型                                                                                                   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |               |
| ------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------- |
| bottom             | *int*                                                                                                  | 返回查看器窗口的底部坐标。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |               |
| current            | *object:*[**Item**](/directory-opus/guan-fang-shou-ce/readme.zh-10/readme.zh-3/readme.zh/item.zh.md)   | 返回一个 [**Item**](/directory-opus/guan-fang-shou-ce/readme.zh-10/readme.zh-3/readme.zh/item.zh.md) 对象，表示当前显示的图像。                                                                                                                                                                                                                                                                                                                                                                                                                 |               |
| desktop            | *string*                                                                                               | 返回此查看器所在的虚拟桌面的 ID。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |               |
| files              | *object:*[**Items**](/directory-opus/guan-fang-shou-ce/readme.zh-10/readme.zh-3/readme.zh/items.zh.md) | 返回一个 [**Items**](/directory-opus/guan-fang-shou-ce/readme.zh-10/readme.zh-3/readme.zh/items.zh.md) 对象，表示查看器列表中的图像。                                                                                                                                                                                                                                                                                                                                                                                                             |               |
| foreground         | *bool*                                                                                                 | 如果查看器当前是系统中的前台（活动）窗口，则返回 **True**。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |               |
| imagesize          | *object:*[**Rect**](/directory-opus/guan-fang-shou-ce/readme.zh-10/readme.zh-3/readme.zh/rect.zh.md)   | 返回一个 [**Rect**](/directory-opus/guan-fang-shou-ce/readme.zh-10/readme.zh-3/readme.zh/rect.zh.md) 对象，表示当前显示的图像的大小（本机大小，忽略任何缩放）。                                                                                                                                                                                                                                                                                                                                                                                                 |               |
| index              | *int*                                                                                                  | 返回查看器文件列表中当前查看的图像的索引。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |               |
| lastactive         | *bool*                                                                                                 | 如果查看器是最新的活动查看器，则返回 **True**。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |               |
| left               | *int*                                                                                                  | 返回查看器窗口的左侧坐标。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |               |
| parentlister       | *object:*[**文件窗口**](/directory-opus/guan-fang-shou-ce/readme.zh-10/readme.zh-3/readme.zh/lister.zh.md) | <p>返回一个 <a href="/directory-opus/guan-fang-shou-ce/readme.zh-10/readme.zh-3/readme.zh/lister.zh.md"><strong>文件窗口</strong></a> 对象，表示启动查看器的文件窗口（如果有，并且它仍然存在），或者如果启用了查看器重复使用，则表示最后将文件发送到查看器的文件窗口。</p><p>在没有 <strong>parenttab</strong> 对象的情况下，可能存在 <strong>parentlister</strong> 对象。例如，如果在查看器打开后关闭了标签页，或者查看器收到来自文件夹标签页以外的某个对象的打开图像的请求，那么将不再存在 <strong>parenttab</strong>，但 <strong>parentlister</strong> 属性将保留。</p><p>此属性是创建 <strong>Viewer</strong> 脚本对象时的快照；它不会对脚本操作做出反应而更改。</p>                                                |               |
| parentlisterlinked | *bool*                                                                                                 | <p>如果查看器处于与父文件窗口 <em>链接的文件窗口</em> 模式，则返回 <strong>True</strong>。这意味着查看器充当一个分离的预览窗格，在文件窗口中选择每个文件时显示该文件。</p><p>此属性是创建 <strong>Viewer</strong> 脚本对象时的快照；它不会对脚本操作做出反应而更改。</p>                                                                                                                                                                                                                                                                                                                                                       |               |
| parenttab          | *object:*[**Tab**](/directory-opus/guan-fang-shou-ce/readme.zh-10/readme.zh-3/readme.zh/tab.zh.md)     | <p>返回一个 <a href="/directory-opus/guan-fang-shou-ce/readme.zh-10/readme.zh-3/readme.zh/tab.zh.md"><strong>Tab</strong></a> 对象，表示启动查看器的标签页（如果有，并且它仍然存在），或者如果启用了查看器重复使用，则表示最后将文件发送到查看器的标签页。</p><p>如果需要 <a href="/directory-opus/guan-fang-shou-ce/readme.zh-10/readme.zh-3/readme.zh/lister.zh.md"><strong>文件窗口</strong></a> 而不是标签页，则应使用 <strong>parentlister</strong> 属性（如上所述），因为它更加持久。此外，不要假设 <strong>parenttab</strong> 仍然是文件窗口中的活动标签页；如果您需要该标签页，请查询文件窗口对象。</p><p>此属性是创建 <strong>Viewer</strong> 脚本对象时的快照；它不会对脚本操作做出反应而更改。</p> |               |
| right              | *int*                                                                                                  | 返回查看器窗口的右侧坐标。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |               |
| selection          | *object:*[**Rect**](/directory-opus/guan-fang-shou-ce/readme.zh-10/readme.zh-3/readme.zh/rect.zh.md)   | 返回一个 [**Rect**](/directory-opus/guan-fang-shou-ce/readme.zh-10/readme.zh-3/readme.zh/rect.zh.md) 对象，表示图像的当前选择区域（如果有）。如果没有选择，则矩形将为空。                                                                                                                                                                                                                                                                                                                                                                                            |               |
| title              | *string*                                                                                               | <p>返回或设置查看器窗口的标题栏字符串。</p><p>您可以在标题字符串中使用几个特殊的“标记”来插入各种信息：</p><p><em>int</em></p>                                                                                                                                                                                                                                                                                                                                                                                                                                               | 返回查看器窗口的顶部坐标。 |
|                    |                                                                                                        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |               |
| **%P**             | 当前查看图像的完整路径                                                                                            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |               |
| **%N**             | 当前显示图像的名称                                                                                              |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |               |
| **%R**             | 当前图像的驱动器根目录                                                                                            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |               |
| **%E**             | 如果图像的元数据已修改但未保存，则显示 \*                                                                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |               |
| **%I**             | 当前图像在图像列表中的索引（编号）                                                                                      |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |               |
| **%O**             | 列表中图像的总数                                                                                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |               |
| **%W**             | 当前图像的宽度                                                                                                |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |               |
| **%H**             | 当前图像的高度                                                                                                |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |               |
| **%D**             | 当前图像的深度（每像素位数）                                                                                         |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |               |
| **%M**             | 当前图像的尺寸                                                                                                |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |               |
| **%S**             | 磁盘上的文件大小                                                                                               |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |               |
| **%F**             | 文件夹名称                                                                                                  |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |               |
| **%C**             | 如果当前图像已 [标记](/directory-opus/guan-fang-shou-ce/readme.zh-4/readme.zh/image_marking.zh.md)，则为集合名称       |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |               |
| **%L**             | 分配给当前图像的任何 [标签](/directory-opus/guan-fang-shou-ce/readme.zh-2/labels.zh.md)                            |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |               |
| **%T**             | 原始标题（用于简单地在标题中添加前缀或后缀）                                                                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |               |
| **%%%%%%**         | 插入一个字面上的 % 字符                                                                                          |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |               |
|                    |                                                                                                        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |               |
|                    |                                                                                                        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |               |
| top                |                                                                                                        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |               |

|            |                                                                                                  |   |
| ---------- | ------------------------------------------------------------------------------------------------ | - |
| **%P**     | 当前查看图像的完整路径                                                                                      |   |
| **%N**     | 当前显示图像的名称                                                                                        |   |
| **%R**     | 当前图像的驱动器根目录                                                                                      |   |
| **%E**     | 如果图像的元数据已修改但未保存，则显示 \*                                                                           |   |
| **%I**     | 当前图像在图像列表中的索引（编号）                                                                                |   |
| **%O**     | 列表中图像的总数                                                                                         |   |
| **%W**     | 当前图像的宽度                                                                                          |   |
| **%H**     | 当前图像的高度                                                                                          |   |
| **%D**     | 当前图像的深度（每像素位数）                                                                                   |   |
| **%M**     | 当前图像的尺寸                                                                                          |   |
| **%S**     | 磁盘上的文件大小                                                                                         |   |
| **%F**     | 文件夹名称                                                                                            |   |
| **%C**     | 如果当前图像已 [标记](/directory-opus/guan-fang-shou-ce/readme.zh-4/readme.zh/image_marking.zh.md)，则为集合名称 |   |
| **%L**     | 分配给当前图像的任何 [标签](/directory-opus/guan-fang-shou-ce/readme.zh-2/labels.zh.md)                      |   |
| **%T**     | 原始标题（用于简单地在标题中添加前缀或后缀）                                                                           |   |
| **%%%%%%** | 插入一个字面上的 % 字符                                                                                    |   |
|            |                                                                                                  |   |
|            |                                                                                                  |   |
| top        |                                                                                                  |   |

| 方法名称               | **参数**                                                                                                                                                            | 返回类型   | 描述                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| AddFile            | <p>\<string:filepath><br>\<int:index></p>                                                                                                                         | *none* | 将指定文件添加到查看器的当前文件列表中。您可以传递字符串或 [**Path**](/directory-opus/guan-fang-shou-ce/readme.zh-10/readme.zh-3/readme.zh/path.zh.md) 对象来指示要添加到列表中的文件。默认情况下，文件将添加到列表的末尾，除非您将基于 0 的索引指定为第二个参数。                                                                                                                                                                                                                                                                                                                                                                                                                                |
| Command            | <p>\<string:command> 或<br><<a href="/directory-opus/guan-fang-shou-ce/readme.zh-10/readme.zh-3/readme.zh/command.zh.md"><strong>Command</strong></a>:command></p> | *none* | <p>在该查看器窗口的上下文中运行命令。您可以传递字符串或 <a href="/directory-opus/guan-fang-shou-ce/readme.zh-10/readme.zh-3/readme.zh/command.zh.md"><strong>Command</strong></a> 对象。</p><p>如果您传递的论点是字符串，那么它只能是查看器命令论点，如 <a href="/directory-opus/guan-fang-shou-ce/readme.zh-10/readme.zh-2/readme.zh/show.zh.md"><strong>Show</strong></a> <strong>VIEWERCMD</strong> 命令中所述。例如，<strong>Command("next")</strong> 将在该查看器的上下文中运行 <strong>Show VIEWERCMD=next</strong> 命令。</p><p>如果您传递一个 <a href="/directory-opus/guan-fang-shou-ce/readme.zh-10/readme.zh-3/readme.zh/command.zh.md"><strong>Command</strong></a> 对象，那么可以使用所有命令（内部或外部）。</p> |
| IsOnCurrentDesktop | *none*                                                                                                                                                            | *bool* | 如果查看器位于当前虚拟桌面，则返回 **True**。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |
| MoveToDesktop      | \<string:desktop>                                                                                                                                                 | *bool* | 将查看器窗口移动到指定的虚拟桌面。如果成功，则返回 **True**。                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
| RemoveFile         | <p>\<int:index> 或<br>\<string:filepath></p>                                                                                                                       | *none* | 从查看器的当前文件列表中删除指定文件。您可以传递要删除的文件的基于 0 的索引，或者文件路径（作为字符串或 [**Path**](/directory-opus/guan-fang-shou-ce/readme.zh-10/readme.zh-3/readme.zh/path.zh.md) 对象）。                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
| SetTaskbarGroup    | \<string:group>                                                                                                                                                   | *bool* | <p>用于更改查看器窗口在任务栏上与其它 Opus 窗口的组合方式。指定一个组名以将窗口移动到备用组，或者省略组参数以重置回默认组。如果将一个或多个窗口移动到同一个组，它们将组合在一起，与默认组分开。</p><p>这仅在启用任务栏分组时有效。组名限制为 103 个字符，如果更长，将被截断。组名中的空格和点会自动转换为下划线。</p><p>成功时返回 true。</p>                                                                                                                                                                                                                                                                                                                                                                                                                        |
