community/Ink Canvas/Docs/ExternalProtocol.md

Ink Canvas 外部协议 (URI Scheme) 说明文档

Ink Canvas 支持通过自定义协议 icc:// 进行外部调用。通过此功能，其他应用程序、网页脚本或系统快捷方式可以远程控制 Ink Canvas 的运行状态。

启用方法

在使用外部协议之前，必须先在软件设置中启用：

1. 打开 软件设置。
2. 进入 高级选项 面板。
3. 找到 外部协议调用 区域。
4. 开启 “启用外部协议 (icc://)” 开关。

注意：此操作会自动在系统注册表中为当前用户注册协议。如果手动关闭该功能，协议将被注销。

---

命令列表

1. 基础控制命令

命令	完整 URI	作用
Fold	icc://fold	进入收纳模式。如果当前处于展开状态，将清空墨迹并折叠到侧边栏。
Unfold	icc://unfold	退出收纳模式。如果当前已折叠，将展开浮动工具栏。
Toggle	icc://toggle	切换状态。已展开则收起，已收起则展开。
Show	icc://show	与 unfold 作用相同，用于兼容旧版指令。

2. 侧边栏工具命令

以下命令对应收纳模式下侧边栏提供的快速工具。

命令	完整 URI	作用
单次抽	icc://randone	打开随机点名窗口并执行单次抽选。
随机抽	icc://rand	打开随机点名窗口并执行随机抽选。
计时器	icc://timer	打开计时器/倒计时工具。
白板	icc://whiteboard	切换到白板模式（也可使用 icc://board）。

3. 进阶功能命令 (隐藏功能)

以下功能专门用于解决与第三方侧边栏或悬浮窗程序的兼容性问题，未在常规设置界面显示。

命令	完整 URI	作用
ThoroughHideOn	icc://thoroughHideOn	开启“收起时彻底隐藏”功能。开启后，进入收纳模式时主窗口将完全不可见。
ThoroughHideOff	icc://thoroughHideOff	关闭“收起时彻底隐藏”功能。恢复默认的侧边栏边缘留痕模式。
ThoroughHideToggle	icc://thoroughhidetoggle	切换“收起时彻底隐藏”功能的开启/关闭状态。

---

使用示例

A. 在浏览器中调用

可以直接在浏览器地址栏输入并回车，或在 HTML 中使用超链接：

<a href="icc://fold">立即收纳 Ink Canvas</a>

B. 在 Windows “运行”对话框中使用

按下 Win + R，输入 icc://toggle 并回车。

C. 在批处理或命令行中使用

start icc://unfold

---

开发者说明

运行机制

1. 唤醒启动：如果 Ink Canvas 尚未运行，调用 URI 会直接启动程序并执行命令。
2. 进程间通信 (IPC)：如果程序已经在运行，外部调用会启动一个临时的指令传递进程，通过系统事件和临时文件将指令发送给已运行的实例，实现无缝控制。

兼容性

• 支持 Windows 7 及更高版本。
• 注册表位置：HKEY_CURRENT_USER\Software\Classes\icc (无需管理员权限)。