禁用单元格编辑

问题：表单保护状态下，如何禁用单元格编辑？

背景

很多用户对如何设置SpreadJS单元格是编辑状态比较困惑。在SpreadJS示例网站上表单保护章节有对接口的详细说明，但是仍然有用户对表单保护机制并不是很理解。下面我们就详细说明下spreadJS的表单保护机制，如何不让单元格被编辑。

SpreadJS 虽然是一款控件但是他并不是像其他控件一样只要设置disabled 等属性就可以禁止编辑。和Excel一样需要同时设定锁定（locked）和保护（Protect）两个状态为true，才能让单元格禁止编辑。

具体我们分三种情况详细说明一下。

1. 所有单元格都不能编辑

这种情况比较简单只要设置以下代码：

   // 设置表单保护 
sheet.options.isProtected = true;

就可以实现效果，因为sheet默认是被锁定的，我们只需要设置保护即可。

2. Sheet中大部分单元格不可编辑，只有少数行列可编辑。

如果我们不希望单元格被编辑，只要给单元格设置一个locked 为true的style即可，如果整行都不希望被编辑，使用setStyle方法时第二个参数设置为-1，那么这一行都被locked了。

// 粉色区域为可编辑部分               
var style = new GC.Spread.Sheets.Style();               
style.locked = false;              
style.backColor = "pink"               
// 设置第二行、第二列、单元格D6可编辑            
sheet.setStyle(1, -1, style, GC.Spread.Sheets.SheetArea.viewport);               
sheet.setStyle(-1, 1, style, GC.Spread.Sheets.SheetArea.viewport);                
sheet.setStyle(5, 3, style, GC.Spread.Sheets.SheetArea.viewport);               
// 设置表单保护               
sheet.options.isProtected = true;

3. Sheet中大部分单元格可以编辑少数不能编辑。

和上面第二种情况相反，我们可能只希望少数几个单元格是不能编辑的，比如希望第一行作为列头是不能编辑的。这时只要设置sheet默认locked为false，然后将第一行锁定即可。

var defaultStyle = new GC.Spread.Sheets.Style();
defaultStyle.locked = false;
sheet.setDefaultStyle(defaultStyle, GC.Spread.Sheets.SheetArea.viewport);
// 设置第1行不可编辑
var style = new GC.Spread.Sheets.Style();
style.locked = true;
style.backColor = "red";
sheet.setStyle(0, -1, style);
// 设置表单保护
sheet.options.isProtected = true;

以上三种情况就是我们所能遇到的所有情况了。只要理解了表单保护的机制，设置起来是很简单的。只要记得最后一定要设置 isProtected 为true！

同时，以上代码都是通过setStyle来完成locked属性设置，但是，这种方法会有个问题，就是在导入表单后，通过上述方法设置表单保护不生效，原因是什么呢？这是因为用样式设置locked属性在单元格中会存在样式的优先级。样式在不同的层级结构中具有不同的优先级别, 如下: 单元格 > 行 > 列。所以无法通过设置行样式覆盖单元格上的样式。

那么可以使用getRange方法为单元格设置locked属性，这样能更加灵活。

sheet.options.isProtected = true;
spread.suspendPaint();
                      
sheet.getRange(0,0,1,sheet.getColumnCount()).locked(true)
sheet.getRange(1,0,sheet.getRowCount()-1,sheet.getColumnCount()).locked(false);

spread.resumePaint();

作者: Lynn.Dou | 审核：Clark.Pan | 更新时间：2023.12.03