AllowEditRanges

本文介绍与表格文档AllowEditRanges相关的API。

AllowEditRanges

ActiveWorkbook.ActiveSheet.AllowEditRanges

获取活动工作簿中的活动工作表的可编辑区域。

  • 语法

    表达式.ActiveWorkbook.ActiveSheet.AllowEditRanges

    表达式:文档类型应用对象

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取活动工作簿中的活动工作表
      const activeSheet = await app.ActiveWorkbook.ActiveSheet;
    
      //获取活动工作表的可编辑区域
      const allowEditRanges = await activeSheet.AllowEditRanges;
    }

方法

ActiveWorkbook.ActiveSheet.AllowEditRanges.Add()

通过Add()方法,您可以在活动工作表中添加一个可编辑区域。

  • 语法

    表达式.ActiveWorkbook.ActiveSheet.AllowEditRanges.Add({ Title, Range, Password })

    表达式:文档类型应用对象

  • 参数

    属性

    数据类型

    是否必填

    描述

    Range

    Object

    区域范围。

    Title

    String

    标题。

    Password

    String

    活动工作表的密码。

  • 示例

    async function example() {
      await instance.ready();
    
      const app = instance.Application;
      
      //获取活动工作簿中的活动工作表
      const activeSheet = await app.ActiveWorkbook.ActiveSheet;
    
      //获取活动工作表的可编辑区域
      const allowEditRanges = await activeSheet.AllowEditRanges;
    
      //选择范围为左上角至A1,右下角至E20
      const range = await activeSheet.Range('$A1:$E20');
    
      //添加可编辑区域
      await allowEditRanges.Add(undefined, range, 'Aliyun');
    }

属性

ActiveWorkbook.ActiveSheet.AllowEditRanges.Count

重要

JS-SDK V1.1.19及以上版本支持此功能。

通过Count属性,您可以获取受保护的工作表(Sheet)中可编辑区域的数量。

  • 语法

    表达式.ActiveWorkbook.ActiveSheet.AllowEditRanges.Count

    表达式:文档类型应用对象

  • 示例

    async function example() {
      await instance.ready();
      const app = instance.Application;
    
      // 活动工作簿中的活动工作表
      const activeSheet = await app.ActiveWorkbook.ActiveSheet;
    
      // 可编辑区域
      const allowEditRanges = await activeSheet.AllowEditRanges;
      
      // 可编辑区域数量
      const count = await allowEditRanges.Count;
    }

AllowEditRange

ActiveWorkbook.ActiveSheet.AllowEditRanges.Item()

获取活动工作表的可编辑区域的元素。

重要

JS-SDK V1.1.19及以上版本支持此功能。

  • 语法

    表达式.ActiveWorkbook.ActiveSheet.AllowEditRanges.Item(Index)

    表达式:文档类型应用对象

  • 参数

    属性

    数据类型

    必填

    说明

    Index

    Variant

    对象的索引

  • 示例

    async function example() {
      await instance.ready();
      const app = instance.Application;
    
      // 活动工作簿中的活动工作表
      const activeSheet = await app.ActiveWorkbook.ActiveSheet;
    
      // 可编辑区域
      const allowEditRanges = await activeSheet.AllowEditRanges;
      const item = await allowEditRanges.Item(1);
    }

方法

ActiveWorkbook.ActiveSheet.AllowEditRanges.Item().Delete()

通过Delete()方法,可以删除受保护的工作表(Sheet)中可编辑区域的元素。

重要

JS-SDK V1.1.19及以上版本支持此功能。

  • 语法

    表达式.ActiveWorkbook.ActiveSheet.AllowEditRanges.Item(Index).Delete()

    表达式:文档类型应用对象

  • 参数

    属性

    数据类型

    必填

    说明

    Password

    Variant

    保护工作表的密码

  • 示例

    async function example() {
      await instance.ready();
      const app = instance.Application;
    
      // 活动工作簿中的活动工作表
      const activeSheet = await app.ActiveWorkbook.ActiveSheet;
    
      // 可编辑区域
      const allowEditRanges = await activeSheet.AllowEditRanges;
      const item = await allowEditRanges.Item(1);
      await item.Delete('123');
    }

ActiveWorkbook.ActiveSheet.AllowEditRanges.Item().AddUser()

通过AddUser()方法,可以在受保护的工作表(Sheet)中为可编辑区域元素添加用户。

重要

JS-SDK V1.1.19及以上版本支持此功能。

  • 语法

    表达式.ActiveWorkbook.ActiveSheet.AllowEditRanges.Item(Index).AddUser()

    表达式:文档类型应用对象

  • 参数

    属性

    数据类型

    必填

    说明

    Password

    Variant

    保护工作表的密码

    UserId

    Variant

    用户ID

  • 示例

async function example() {
  await instance.ready();
  const app = instance.Application;

  // 活动工作簿中的活动工作表
  const activeSheet = await app.ActiveWorkbook.ActiveSheet;

  // 可编辑区域
  const allowEditRanges = await activeSheet.AllowEditRanges;
  const item = await allowEditRanges.Item(1);

  //增加用户
  await item.AddUser({Password:'', UserId:'280289376'});
}

ActiveWorkbook.ActiveSheet.AllowEditRanges.Item().RemoveUser()

通过RemoveUser()方法,可以在受保护的工作表(Sheet)中为可编辑区域元素移除用户。

重要

JS-SDK V1.1.19及以上版本支持此功能。

  • 语法

    表达式.ActiveWorkbook.ActiveSheet.AllowEditRanges.Item(Index).RemoveUser()

    表达式:文档类型应用对象

  • 参数

    属性

    数据类型

    必填

    说明

    Password

    Variant

    保护工作表的密码

    UserId

    Variant

    用户ID

  • 示例

    async function example() {
      await instance.ready();
      const app = instance.Application;
    
      // 活动工作簿中的活动工作表
      const activeSheet = await app.ActiveWorkbook.ActiveSheet;
    
      // 可编辑区域
      const allowEditRanges = await activeSheet.AllowEditRanges;
      const item = await allowEditRanges.Item(1);
      // 移除用户
      await item.RemoveUser({Password:'', UserId:'280289376'});
    }

属性

ActiveWorkbook.ActiveSheet.AllowEditRanges.Item().Range

通过Range属性,您可以获取受保护的工作表中编辑可编辑区域的元素的选区。

重要

JS-SDK V1.1.19及以上版本支持此功能。

  • 语法

    表达式.ActiveWorkbook.ActiveSheet.AllowEditRanges.Item(Index).Range

    表达式:文档类型应用对象

  • 示例

    async function example() {
      await instance.ready();
      const app = instance.Application;
    
      // 活动工作簿中的活动工作表
      const activeSheet = await app.ActiveWorkbook.ActiveSheet;
    
      // 可编辑区域
      const allowEditRanges = await activeSheet.AllowEditRanges;
      const item = await allowEditRanges.Item(1);
      await item.Range;
    }

ActiveWorkbook.ActiveSheet.AllowEditRanges.Item().Users

通过Users属性,您可以获取受保护的工作表中可编辑区域的元素的选区。

重要

JS-SDK V1.1.19及以上版本支持此功能。

  • 语法

    表达式.ActiveWorkbook.ActiveSheet.AllowEditRanges.Item(Index).Users

    表达式:文档类型应用对象

  • 示例

    async function example() {
      await instance.ready();
      const app = instance.Application;
    
      // 活动工作簿中的活动工作表
      const activeSheet = await app.ActiveWorkbook.ActiveSheet;
    
      // 可编辑区域
      const allowEditRanges = await activeSheet.AllowEditRanges;
      const item = await allowEditRanges.Item(1);
      // 可编辑区域用户组
      await item.Users;
    }