Class Shell

Shell 相关对象

外壳 对象

Shell:Close () 关闭外壳窗口
Shell:WaitAndClose () 关闭外壳窗口 外壳窗口不存在时，将等待外壳窗口出现后再关闭

桌面 对象

Desktop:Link (lnk, target[, param[, icon[, index[, showcmd]]]]) 创建 快捷方式到桌面
Desktop:Refresh () 刷新 桌面
Desktop:GetWallpaper () 获取 壁纸路径
Desktop:SetWallpaper (path) 设置 桌面壁纸
Desktop:SetIconSize (level) 设置 桌面图标大小
Desktop:AutoArrange (checked) 设置 自动排列图标 选项
Desktop:SnapToGrid (checked) 设置 将图标与网格对齐 选项
Desktop:ShowIcons (checked) 设置 显示桌面图标 选项

任务栏 对象

Taskbar:IsReady (sec) 检测 任务栏是否准备就绪
Taskbar:WaitForReady () 等待 任务栏准备就绪
Taskbar:GetSetting (key) 获取 任务栏相关设置
Taskbar:SetSetting (key, value, type) 设定 任务栏相关设置
Taskbar:CombineButtons (value[, update]) 更改 任务栏合并按钮选项
Taskbar:UseSmallIcons (value[, update]) 更改 任务栏使用小图标选项
Taskbar:AutoHide (value) 更改 任务栏自动隐藏选项
Taskbar:Hide () 隐藏 任务栏
Taskbar:Show () 显示 任务栏
Taskbar:Pin (target[, name[, param[, icon[, index[, showcmd]]]]]) 固定 程序到任务栏

开始菜单 对象

Startmenu:Pin (target[, name[, param[, icon[, index[, showcmd]]]]]) 固定 程序到开始菜单
Startmenu:Link (lnk, target[, param[, icon[, index[, showcmd]]]]) 创建 快捷方式到开始菜单


外壳 对象

Shell:Close ()
关闭外壳窗口
Shell:WaitAndClose ()
关闭外壳窗口 外壳窗口不存在时，将等待外壳窗口出现后再关闭

桌面 对象

Desktop:Link (lnk, target[, param[, icon[, index[, showcmd]]]])
创建 快捷方式到桌面

Parameters:

  • lnk string 指定要创建的快捷方式的路径
  • target string 快捷方式的目标路径
  • param string 程序执行参数 (optional)
  • icon string 指定任务栏图标(ico文件，或者包含图标的资源文件) (optional)
  • index int 图标索引号 (optional)
  • showcmd string 启动参数 (optional)

See also:

Usage:

    Desktop:Link('Hello.lnk', 'cmd.exe', '/k echo hello', 'shell32.dll', 27)
Desktop:Link('#{@shell32.dll,22022}.lnk', 'cmd.exe')
Desktop:Link('Internet Explorer.lnk', '%ProgramFiles%\\Internet Explorer\\iexplore.exe')
Desktop:Link([[Tools\Everything.lnk]], [[%ProgramFile%\Everything\Everything.exe]])
Desktop:Refresh ()
刷新 桌面
Desktop:GetWallpaper ()
获取 壁纸路径

Returns:

    壁纸路径
Desktop:SetWallpaper (path)
设置 桌面壁纸

Parameters:

Usage:

    WinXShell.exe -code Desktop:SetWallpaper([[%SystemRoot%\Web\img0.jpg]])
Desktop:SetIconSize (level)
设置 桌面图标大小

Parameters:

  • level string

    图标大小级别。

    • 'S' - 小图标
    • 'M' - 中图标
    • 'L' - 大图标

Usage:

    WinXShell.exe -code Desktop:SizeIconSize('M')
Desktop:AutoArrange (checked)
设置 自动排列图标 选项

Parameters:

  • checked int

    是否使用此选项。

    • 0 - 不自动排列
    • 1 - 自动排列
Desktop:SnapToGrid (checked)
设置 将图标与网格对齐 选项

Parameters:

  • checked int

    是否使用此选项。

    • 0 - 不与网格对齐
    • 1 - 与网格对齐
Desktop:ShowIcons (checked)
设置 显示桌面图标 选项

Parameters:

  • checked int

    是否使用此选项。

    • 0 - 不显示
    • 1 - 显示

任务栏 对象

Taskbar:IsReady (sec)
检测 任务栏是否准备就绪 指定sec秒内判断任务栏是否准备就绪(sec为-1时，直到任务栏准备好为止)

Parameters:

  • sec int 设置检测间隔(秒数)
Taskbar:WaitForReady ()
等待 任务栏准备就绪 用于控制启动时，一些需要在外壳创建后才进行初始化任务执行。 内部调用Taskbar:IsReady(-1)方法
Taskbar:GetSetting (key)
获取 任务栏相关设置

Parameters:

Taskbar:SetSetting (key, value, type)
设定 任务栏相关设置

Parameters:

  • key string 设置项目名
  • value 设定值
  • type 类型
Taskbar:CombineButtons (value[, update])
更改 任务栏合并按钮选项

Parameters:

  • value string

    合并按钮选项

    • 'always' - 总是合并
    • 'auto' - 自动合并
    • 'never' - 从不合并
  • update int 是否立即更新任务栏(非0时， 立即更新) (optional)
Taskbar:UseSmallIcons (value[, update])
更改 任务栏使用小图标选项

Parameters:

  • value int

    使用小图标选项

    • 0 - 不使用小图标
    • 1 - 使用小图标
  • update int 是否立即更新任务栏(非0时， 立即更新) (optional)
Taskbar:AutoHide (value)
更改 任务栏自动隐藏选项

Parameters:

  • value int

    自动隐藏选项

    • 0 - 不自动隐藏
    • 1 - 自动隐藏
Taskbar:Hide ()
隐藏 任务栏
Taskbar:Show ()
显示 任务栏
Taskbar:Pin (target[, name[, param[, icon[, index[, showcmd]]]]])
固定 程序到任务栏

Parameters:

  • target string 指定需要固定的程序路径
  • name string 固定图标名称(鼠标悬停时显示), 不指定时使用程序自身描述信息 (optional)
  • param string 程序执行参数 (optional)
  • icon string 指定任务栏图标(ico文件，或者包含图标的资源文件) (optional)
  • index int 图标索引号 (optional)
  • showcmd string 启动参数 (optional)

Usage:

    WinXShell.exe -code Taskbar:Pin('regedit.exe')
WinXShell.exe -code "Taskbar:Pin([[%ProgramFile%\Everything\Everything.exe]])"
WinXShell.exe -code "Taskbar:Pin('cmd.exe', nil, '/k echo hello', 'shell32.dll', 27)"

开始菜单 对象

Startmenu:Pin (target[, name[, param[, icon[, index[, showcmd]]]]])
固定 程序到开始菜单

Parameters:

  • target string 指定需要固定的程序路径
  • name string 固定图标名称(鼠标悬停时显示), 不指定时使用程序自身描述信息 (optional)
  • param string 程序执行参数 (optional)
  • icon string 指定任务栏图标(ico文件，或者包含图标的资源文件) (optional)
  • index int 图标索引号 (optional)
  • showcmd string 启动参数 (optional)

Usage:

    WinXShell.exe -code Startmenu:Pin('regedit.exe')
WinXShell.exe -code "Startmenu:Pin([[%ProgramFile%\Everything\Everything.exe]])"
WinXShell.exe -code "Startmenu:Pin('cmd.exe', nil, '/k echo hello', 'shell32.dll', 27)"
Startmenu:Link (lnk, target[, param[, icon[, index[, showcmd]]]])
创建 快捷方式到开始菜单

Parameters:

  • lnk string 指定要创建的快捷方式的路径
  • target string 快捷方式的目标路径
  • param string 程序执行参数 (optional)
  • icon string 指定任务栏图标(ico文件，或者包含图标的资源文件) (optional)
  • index int 图标索引号 (optional)
  • showcmd string 启动参数 (optional)

See also:

Usage:

    Startmenu:Link('Hello.lnk', 'cmd.exe', '/k echo hello', 'shell32.dll', 27)
Startmenu:Link('Microsoft Edge.lnk', [[%ProgramFiles%\Microsoft\Edge\Application\msedge.exe]])
Startmenu:Link([[Tools\Everything.lnk]], [[%ProgramFile%\Everything\Everything.exe]])
generated by LDoc 1.4.6