VSCode 插件

SpreadJS设计器VSCode插件将功能完备的SpreadJS设计器集成到Visual Studio Code中，支持用户直接在VSCode工作区内预览并编辑表格文件。

该插件以自定义编辑器形式运行，可适配VSCode的文件系统规则、主题体系以及各类安全限制。

支持的文件格式

该插件可编辑以下格式文件：

• .sjs

• .ssjson

• .xlsx

• .xltx

• .xlsm

• .xltm

• .csv

插件会为上述格式注册自定义编辑器，还可将其设置为VSCode默认打开方式。

安装教程

环境要求

• 桌面版Visual Studio Code 1.107.0及以上版本

  查看VSCode版本路径：

帮助 → 关于

从VSCode应用商店安装

1. 打开Visual Studio Code软件

2. 进入扩展面板（快捷键Ctrl+Shift+X）

3. 搜索以下名称：

   1. Excel SpreadJS Editor

   2. GrapeCity

4. 选择由葡萄城发布的对应插件

5. 点击安装按钮

   也可直接前往应用商店网页端完成安装。

安装后设置

• 安装完成无需重启软件

• 插件不会自动设为对应文件格式的默认编辑器

设置为默认编辑器步骤：

1. 打开任意一款受支持的文件（例如.xlsx文件）

2. 右键点击文件标签页

3. 选择使用SpreadJS打开

   
   

文件相关操作

打开文件

1. 受支持格式文件可直接通过SpreadJS设计器打开

   
   

   
   

2. 也可手动指定打开方式：

   资源管理器 → 右键文件 → 使用SpreadJS打开

   
   

   
   

加密XLSX文件打开

打开设有密码保护的.xlsx文件时：

• 弹出密码输入弹窗

• 密码验证通过即可正常打开文件

• 验证失败则弹出错误提示并自动关闭文件标签页

  
  

文件加载失败提示

文件无法正常打开时，弹窗会展示详细的错误原因

编辑与保存文件

文件内容发生修改后：

• VSCode会标记该文件标签为未保存状态

• 按下Ctrl+S快捷键即可保存修改

  若未保存修改就关闭文件，VSCode会弹出确认提醒

  
  

新建文件

该插件内置新建表格文件相关快捷指令

新建文件操作步骤：

1. 按下快捷键Ctrl+Shift+P

2. 执行对应的SpreadJS新建指令

   
   

新建的空白工作簿会按照预设的工作簿配置完成初始化。

VSCode融合适配功能

自定义文件菜单栏

由于VSCode依靠本地文件系统管理文件，网页版设计器里的部分操作功能无法在插件中使用。

已移除的菜单选项：

• 新建

• 打开

• 导入

• 保存

• 打印

暂不支持打印功能，原因是VSCode插件无法调用window.print网页打印接口。

导出功能

导出功能等同于另存为

如需保存为SpreadJS专属格式，可通过以下路径操作：

导出 > SpreadJS格式文件

功能区样式

插件支持两种功能区显示样式：

• classic经典样式

• toolbar工具栏样式

用户可在设计器界面内自由切换，也能在settings.json配置文件中设定默认样式。

{  
"spreadjs": {    
"ribbonMode": "classic"  
}
}

主题适配

设计器界面可自动跟随VSCode当前启用的主题切换样式：

• 浅色主题 → 界面同步变为浅色

• 深色主题 → 界面同步变为深色

  无需额外手动配置

  
  

语言与区域设置

插件默认沿用VSCode的系统显示语言

用户可手动自定义设置，配置代码如下：

{  
"spreadjs": {    
"language": "zh",    
"culture": "zh-cn"  
}
}

文件专属图标

插件为以下格式文件配备了专属图标：

• .sjs

• .ssjson

  方便用户在资源管理器中快速区分识别文件类型。

状态栏标识

插件会在VSCode状态栏添加标识文字：由GrapeCity SpreadJS提供技术支持

点击该标识可直接跳转至SpreadJS官方产品主页

自定义配置

所有相关配置参数均统一写在settings.json文件内。

工作簿基础配置

该配置仅在新建空白工作簿时生效：

{  
"spreadjs": {    
"workbookOptions": {      
"allowDynamicArray": true,      
"allowInvalidFormula": true    
}  
}
}

更多可配置属性可查阅API文档：GC.Spread.Sheets.IWorkbookOptions

文件打开与导入配置

该配置在加载各类表格文件时生效：

{  
"spreadjs": {    
"openOptions": {},    
"importOptions": {},    
"importCsvOptions": {}  
}
}

参考配置文档：

• GC.Spread.Sheets.OpenOptions

• GC.Spread.Sheets.ImportOptions

• GC.Spread.Sheets.ImportCsvOptions

兼容性说明与使用限制

版本兼容规则

插件始终搭载最新版SpreadJS运行环境

若文件由其他主次版本的SpreadJS创建，会出现版本兼容限制。

打开这类版本不匹配的文件时：

• 软件弹出版本提示通知

• 禁止直接保存文件，避免用新版本覆盖原有旧版本文件

  
  

用户可使用另存为（导出）功能，将内容保存为全新文件。

快捷键冲突问题

设计器内部的命令面板快捷键和VSCode的转到文件快捷键（Ctrl+P）冲突

现已重新设定快捷键为：

Ctrl + Alt + P

外部超链接限制

受VSCode安全策略约束，点击打开外部网页链接时，需要用户手动确认授权

=

授权使用说明

安装并启用该插件无需填写授权密钥

未购买商业授权的情况下，设计器界面右下角会自动显示试用版水印