FieldDescriptor (对象)

说明

FieldDescriptor 描述了字段的属性，可以通过SetType修改字段的类型，修改属性之后需要主动调用Apply()方法使得修改生效。 每次读取FieldDescriptor都会重新生成数据，所以修改前需要记录下当前的FieldDescriptor，才能正确调用Apply()

const fieldDescriptor = Sheets(1).FieldDescriptors(1)
// 设置属性
// ....
fieldDescriptor.Apply()

不同的字段类型有不同的属性设置，不是对应的字段类型，获取相关的属性时会返回null，无法正常设置

字段类型	特有的字段属性
按钮字段	Button
地址字段	Address
级联字段	Cascade
联系人字段	Contact
日期字段	Date
最后修改人/最后修改时间	Watch
公式字段	Formula
引用/查找引用/统计	Lookup
单向关联/双向关联	Link
自动任务	Automation
图片和附件	Attachment
超链接	Url
数字	Number
单选项/多选项	Select
等级	Rating

方法

• Apply
• Delete

属性

• Id
• Type
• Name
• Description
• IsSyncField
• DefaultVal
• DefaultValType
• NumberFormat
• IsValueUnique
• Button
• Address
• Cascade
• Contact
• Date
• Watch
• Formula
• Lookup
• Link
• Automation
• Attachment
• Url
• Number
• Select
• Rating

事件

• OnUpdate
• OnDelete

浏览器环境示例

async function example() {
    await instance.ready();
    const app = instance.Application;
    const fieldDescriptor = await app.Sheets(1).FieldDescriptors(1)
    fieldDescriptor.Name = "修改字段名"
    fieldDescriptor.Apply()
    console.log(await fieldDescriptor.Name)
 }

脚本编辑器 示例

function main() {
    const fieldDescriptor = Application.Sheets(1).FieldDescriptors(1)
    fieldDescriptor.Name = "修改字段名"
    fieldDescriptor.Apply()
    console.log(fieldDescriptor.Name)
 }
main()