Skip to content

字段

Field

JSSDK: v1.1.10+、WebOffice v2.4.1+ 支持

Field 对象,表示字段相关

语法

表达式.ActiveDBSheet.Field

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

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // Field 对象,表示字段相关
  const Field = await app.ActiveDBSheet.Field
}

AddCheckboxField()

JSSDK: v1.1.10+、WebOffice v2.4.1+ 支持

新增复选框字段

语法

表达式.ActiveDBSheet.Field.AddCheckboxField({ ViewCol, Name })

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

参数

属性数据类型默认值必填说明
ViewCol
Number
指定列,举例 1
Name
String
标题,举例 name

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 新增复选框字段
  await app.ActiveDBSheet.Field.AddCheckboxField({
    ViewCol: 2, // 指定列,举例 1
    Name: 'WebOffice' // 标题,举例 'name'
  })
}

AddCompleteField()

JSSDK: v1.1.10+、WebOffice v2.4.1+ 支持

新增进度字段

语法

表达式.ActiveDBSheet.Field.AddCompleteField({ ViewCol, Name })

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

参数

属性数据类型默认值必填说明
ViewCol
Number
指定列,举例 1
Name
String
标题,举例 name

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 新增进度字段
  await app.ActiveDBSheet.Field.AddCompleteField({
    ViewCol: 2, // 指定列,举例 1
    Name: 'WebOffice' // 标题,举例 'name'
  })
}

AddTimeField()

JSSDK: v1.1.10+、WebOffice v2.4.1+ 支持

新增货币字段

语法

表达式.ActiveDBSheet.Field.AddTimeField({ ViewCol, Name, Format })

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

参数

属性数据类型默认值必填说明
ViewCol
Number
指定列,举例 1
Name
String
标题,举例 name
Format
String
货币格式,举例 £#,##0;{0}-#,##0,可通过 ActiveDBSheet.Field.GetCurrencyFormat() 获取

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 新增货币字段
  await app.ActiveDBSheet.Field.AddCurrencyField({
    ViewCol: 2, // 指定列,举例 1
    Name: 'WebOffice', // 标题,举例 'name'
    Format: '£#,##0;{0}-#,##0' // 货币格式,举例 '£#,##0;{0}-#,##0',可通过 ActiveDBSheet.Field.GetCurrencyFormat() 获取
  })
}

AddDateField()

JSSDK: v1.1.10+、WebOffice v2.4.1+ 支持

新增日期字段

语法

表达式.ActiveDBSheet.Field.AddDateField({ ViewCol, Name, Format })

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

参数

属性数据类型默认值必填说明
ViewCol
Number
指定列,举例 1
Name
String
标题,举例 name
Format
String
日期格式,举例 yyyy/m/d;@,可通过 ActiveDBSheet.Field.GetDateFormat() 获取

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 新增日期字段
  await app.ActiveDBSheet.Field.AddDateField({
    ViewCol: 2, // 指定列,举例 1
    Name: 'WebOffice', // 标题,举例 'name'
    Format: 'yyyy/m/d;@' // 日期格式,举例 'yyyy/m/d;@',可通过 ActiveDBSheet.Field.GetDateFormat() 获取
  })
}

AddEmailField()

JSSDK: v1.1.10+、WebOffice v2.4.1+ 支持

新增邮箱字段

语法

表达式.ActiveDBSheet.Field.AddEmailField({ ViewCol, Name })

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

参数

属性数据类型默认值必填说明
ViewCol
Number
指定列,举例 1
Name
String
标题,举例 name

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 新增邮箱字段
  await app.ActiveDBSheet.Field.AddEmailField({
    ViewCol: 2, // 指定列,举例 1
    Name: 'WebOffice' // 标题,举例 'name'
  })
}

AddHyperLinkField()

JSSDK: v1.1.10+、WebOffice v2.4.1+ 支持

新增超链接字段

语法

表达式.ActiveDBSheet.Field.AddHyperLinkField({ ViewCol, Name })

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

参数

属性数据类型默认值必填说明
ViewCol
Number
指定列,举例 1
Name
String
标题,举例 name

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 新增超链接字段
  await app.ActiveDBSheet.Field.AddHyperLinkField({
    ViewCol: 2, // 指定列,举例 1
    Name: 'WebOffice' // 标题,举例 'name'
  })
}

AddIDCardField()

JSSDK: v1.1.10+、WebOffice v2.4.1+ 支持

新增身份证字段

语法

表达式.ActiveDBSheet.Field.AddIDCardField({ ViewCol, Name })

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

参数

属性数据类型默认值必填说明
ViewCol
Number
指定列,举例 1
Name
String
标题,举例 name

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 新增身份证字段
  await app.ActiveDBSheet.Field.AddIDCardField({
    ViewCol: 2, // 指定列,举例 1
    Name: 'WebOffice' // 标题,举例 'name'
  })
}

AddMultiLineTextField()

JSSDK: v1.1.10+、WebOffice v2.4.1+ 支持

新增多行文本字段

语法

表达式.ActiveDBSheet.Field.AddMultiLineTextField({ ViewCol, Name })

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

参数

属性数据类型默认值必填说明
ViewCol
Number
指定列,举例 1
Name
String
标题,举例 name

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 新增多行文本字段
  await app.ActiveDBSheet.Field.AddMultiLineTextField({
    ViewCol: 2, // 指定列,举例 1
    Name: 'WebOffice' // 标题,举例 'name'
  })
}

AddNumberField()

JSSDK: v1.1.10+、WebOffice v2.4.1+ 支持

在指定列增加数字字段

语法

表达式.ActiveDBSheet.Field.AddNumberField({ ViewCol, Name, Format })

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

参数

属性数据类型默认值必填说明
ViewCol
Number
指定列,举例 1
Name
String
标题,举例 name
Format
String
数字格式,举例 0.00_);[红色](0.00),可通过 ActiveDBSheet.Field.GetNumberFormat() 获取

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 在指定列增加数字字段
  await app.ActiveDBSheet.Field.AddNumberField({
    ViewCol: 2, // 指定列,举例 1
    Name: 'WebOffice', // 标题,举例 'name'
    Format: '0.00_);[红色](0.00)' // 数字格式,举例 '0.00_);[红色](0.00)',可通过 ActiveDBSheet.Field.GetNumberFormat() 获取
  })
}

AddPercentField()

JSSDK: v1.1.10+、WebOffice v2.4.1+ 支持

新增百分比字段

语法

表达式.ActiveDBSheet.Field.AddPercentField({ ViewCol, Name, Format })

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

参数

属性数据类型默认值必填说明
ViewCol
Number
指定列,举例 1
Name
String
标题,举例 name
Format
String
百分比格式,举例 0%,可通过 ActiveDBSheet.Field.GetPercentFormat() 获取

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 新增百分比字段
  await app.ActiveDBSheet.Field.AddPercentField({
    ViewCol: 2, // 指定列,举例 1
    Name: 'WebOffice', // 标题,举例 'name'
    Format: '0%' // 百分比格式,举例 '0%',可通过 ActiveDBSheet.Field.GetPercentFormat() 获取
  })
}

AddPhoneField()

JSSDK: v1.1.10+、WebOffice v2.4.1+ 支持

新增电话字段

语法

表达式.ActiveDBSheet.Field.AddPhoneField({ ViewCol, Name })

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

参数

属性数据类型默认值必填说明
ViewCol
Number
指定列,举例 1
Name
String
标题,举例 name

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 新增电话字段
  await app.ActiveDBSheet.Field.AddPhoneField({
    ViewCol: 2, // 指定列,举例 1
    Name: 'WebOffice' // 标题,举例 'name'
  })
}

AddPictureField()

JSSDK: v1.1.10+、WebOffice v2.4.1+ 支持

新增图片字段

语法

表达式.ActiveDBSheet.Field.AddPictureField({ ViewCol, Name })

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

参数

属性数据类型默认值必填说明
ViewCol
Number
指定列,举例 1
Name
String
标题,举例 name

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 新增图片字段
  await app.ActiveDBSheet.Field.AddPictureField({
    ViewCol: 2, // 指定列,举例 1
    Name: 'WebOffice' // 标题,举例 'name'
  })
}

SetRatingMax()

JSSDK: v1.1.10+、WebOffice v2.4.1+ 支持

设置等级最大值

语法

表达式.ActiveDBSheet.Field.SetRatingMax({ ViewCol, MaxValue })

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

参数

属性数据类型默认值必填说明
ViewCol
Number
指定列,举例 1
MaxValue
String
最高等级,举例 3

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 新增星星
  await app.ActiveDBSheet.Field.AddRatingField({
    ViewCol: 2, // 指定列,举例 1
    Name: 'WebOffice', // 标题,举例 'name'
    MaxValue: 5 // 最高等级,举例 3
  })

  setTimeout(async () => {
    // 设置等级最大值
    await app.ActiveDBSheet.Field.SetRatingMax({
      ViewCol: 2, // 指定列,举例 1
      MaxValue: 3 // 最高等级,举例 3
    })
  }, 1000)
}

AddSingleLineTextField()

JSSDK: v1.1.10+、WebOffice v2.4.1+ 支持

新增单行文本字段

语法

表达式.ActiveDBSheet.Field.AddSingleLineTextField({ ViewCol, Name })

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

参数

属性数据类型默认值必填说明
ViewCol
Number
指定列,举例 1
Name
String
标题,举例 name

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 新增单行文本字段
  await app.ActiveDBSheet.Field.AddSingleLineTextField({
    ViewCol: 2, // 指定列,举例 1
    Name: 'WebOffice' // 标题,举例 'name'
  })
}

AddTimeField()

JSSDK: v1.1.10+、WebOffice v2.4.1+ 支持

新增时间字段

语法

表达式.ActiveDBSheet.Field.AddTimeField({ ViewCol, Name, Format })

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

参数

属性数据类型默认值必填说明
ViewCol
Number
指定列,举例 1
Name
String
标题,举例 name
Format
String
时间格式,举例 h:mm:ss;@,可通过 ActiveDBSheet.Field.GetTimeFormat() 获取

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 新增时间字段
  await app.ActiveDBSheet.Field.AddTimeField({
    ViewCol: 2, // 指定列,举例 1
    Name: 'WebOffice', // 标题,举例 'name'
    Format: 'h:mm:ss;@' // 时间格式,举例 'h:mm:ss;@',可通过 ActiveDBSheet.Field.GetTimeFormat() 获取
  })
}

DeleteField()

JSSDK: v1.1.10+、WebOffice v2.4.1+ 支持

删除字段

语法

表达式.ActiveDBSheet.Field.DeleteField({ ViewCol })

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

参数

属性数据类型默认值必填说明
ViewCol
Number
指定列,举例 1

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 删除字段
  await app.ActiveDBSheet.Field.DeleteField({
    ViewCol: 2 // 指定列,举例 1
  })
}

GetAllFieldsList()

JSSDK: v1.1.10+、WebOffice v2.4.1+ 支持

获取所有字段

语法

表达式.ActiveDBSheet.Field.GetAllFieldsList()

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

返回值

返回 Array<Object> 表示对应的信息

属性数据类型说明
FieldId
String
fieldId
Name
String
列名称
IsHidden
Boolean
是否隐藏

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取所有字段
  const info = await app.ActiveDBSheet.Field.GetAllFieldsList()
  console.log(info)
}

GetCurrencyFormat()

JSSDK: v1.1.10+、WebOffice v2.4.1+ 支持

获取货币列表

语法

表达式.ActiveDBSheet.Field.GetCurrencyFormat()

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

返回值

返回 Array<> 表示对应的信息

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取货币列表
  const info = await app.ActiveDBSheet.Field.GetCurrencyFormat()
  console.log(info)
}

GetDateFormat()

JSSDK: v1.1.10+、WebOffice v2.4.1+ 支持

获取日期格式列表

语法

表达式.ActiveDBSheet.Field.GetDateFormat()

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

返回值

返回 Array<> 表示对应的信息

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取日期格式列表
  const info = await app.ActiveDBSheet.Field.GetDateFormat()
  console.log(info)
}

GetField()

JSSDK: v1.1.10+、WebOffice v2.4.1+ 支持

获取可见字段信息

语法

表达式.ActiveDBSheet.Field.GetField({ ViewCol })

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

参数

属性数据类型默认值必填说明
ViewCol
Number
指定列,举例 1

返回值

返回 KDbSheetField 表示对应的信息

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取可见字段信息
  const info = await app.ActiveDBSheet.Field.GetField({
    ViewCol: 2 // 指定列,举例 1
  })
  console.log(info)
}

GetFieldCount()

JSSDK: v1.1.10+、WebOffice v2.4.1+ 支持

获取可见字段数量

语法

表达式.ActiveDBSheet.Field.GetFieldCount()

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

返回值

返回 Number 表示对应的可见字段数量

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取可见字段数量
  const info = await app.ActiveDBSheet.Field.GetFieldCount()
  console.log(info)
}

GetFieldId()

JSSDK: v1.1.10+、WebOffice v2.4.1+ 支持

获取 fieldId

语法

表达式.ActiveDBSheet.Field.GetFieldId({ ViewCol })

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

参数

属性数据类型默认值必填说明
ViewCol
Number
指定列,举例 1

返回值

返回 String 表示对应的 fieldId

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取 fieldId
  await app.ActiveDBSheet.Field.GetFieldId({
    ViewCol: 2 // 指定列,举例 1
  })
}

GetNumberFormat()

JSSDK: v1.1.10+、WebOffice v2.4.1+ 支持

获取数字格式列表

语法

表达式.ActiveDBSheet.Field.GetNumberFormat()

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

返回值

返回 Array<> 表示对应的信息

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取数字格式列表
  const info = await app.ActiveDBSheet.Field.GetNumberFormat()
  console.log(info)
}

GetNumberTypeFormat()

JSSDK: v1.1.10+、WebOffice v2.4.1+ 支持

获取数字列表

语法

表达式.ActiveDBSheet.Field.GetNumberTypeFormat()

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

返回值

返回 Array<> 表示对应的信息

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取数字列表
  const info = await app.ActiveDBSheet.Field.GetNumberTypeFormat()
  console.log(info)
}

GetPercentFormat()

JSSDK: v1.1.10+、WebOffice v2.4.1+ 支持

获取百分比列表

语法

表达式.ActiveDBSheet.Field.GetPercentFormat()

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

返回值

返回 Array<> 表示对应的信息

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取百分比列表
  const info = await app.ActiveDBSheet.Field.GetPercentFormat()
  console.log(info)
}

GetTimeFormat()

JSSDK: v1.1.10+、WebOffice v2.4.1+ 支持

获取时间格式列表

语法

表达式.ActiveDBSheet.Field.GetTimeFormat()

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

返回值

返回 Array<> 表示对应的信息

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 获取时间格式列表
  const info = await app.ActiveDBSheet.Field.GetTimeFormat()
  console.log(info)
}

HideField()

JSSDK: v1.1.11+、WebOffice v2.5.1+ 支持

根据 ViewCol 或者 FieldId 隐藏字段

第 1 列不可操作

语法

表达式.ActiveDBSheet.Field.HideField({ ViewCol, FieldId })

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

参数

属性数据类型默认值必填说明
ViewCol
Number
索引
FieldId
String
FieldId,可通过 ActiveDBSheet.Field.GetFieldId 获取

示例 1:ViewCol

async function example() {
  await instance.ready()

  const app = instance.Application

  // 根据 ViewCol 隐藏字段
  const id = await app.ActiveDBSheet.Field.HideField({
    ViewCol: 2 // 索引
  })
}

示例 2:

async function example() {
  await instance.ready()

  const app = instance.Application

  // 根据 FieldId 隐藏字段
  const id = await app.ActiveDBSheet.Field.HideField({
    FieldId: ActiveDBSheet.Field.GetFieldId({
      ViewCol: 2 // 索引
    })
  })
}

IsHidden()

JSSDK: v1.1.10+、WebOffice v2.4.1+ 支持

检查字段是否隐藏

语法

表达式.ActiveDBSheet.Field.IsHidden({ ViewCol })

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

参数

属性数据类型默认值必填说明
ViewCol
Number
指定列,举例 1

返回值

返回 true 表示隐藏了,否则没隐藏

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 检查字段是否隐藏
  await app.ActiveDBSheet.Field.IsHidden({
    ViewCol: 2 // 指定列,举例 1
  })
}

SetFieldFormat()

JSSDK: v1.1.10+、WebOffice v2.4.1+ 支持

修改字段数字格式

语法

表达式.ActiveDBSheet.Field.SetFieldFormat({ ViewCol, Format })

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

参数

属性数据类型默认值必填说明
ViewCol
Number
指定列,举例 1
Format
String
数字格式,举例 £#,##0;{0}-#,##0

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 修改字段数字格式
  await app.ActiveDBSheet.Field.SetFieldFormat({
    ViewCol: 2, // 指定列,举例 1
    Format: '£#,##0;{0}-#,##0' // 数字格式,举例 '£#,##0;{0}-#,##0'
  })
}

SetFieldName()

JSSDK: v1.1.10+、WebOffice v2.4.1+ 支持

修改字段名称

语法

表达式.ActiveDBSheet.Field.SetFieldName({ ViewCol, Name })

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

参数

属性数据类型默认值必填说明
ViewCol
Number
指定列,举例 1
Name
String
标题,举例 name

示例

async function example() {
  await instance.ready()

  const app = instance.Application

  // 修改字段名称
  await app.ActiveDBSheet.Field.SetFieldName({
    ViewCol: 2, // 指定列,举例 1
    Name: 'WebOffice' // 标题,举例 'name'
  })
}

SetFieldType()

JSSDK: v1.1.10+、WebOffice v2.4.1+ 支持

修改字段类型

语法

表达式.ActiveDBSheet.Field.SetFieldType({ ViewCol, Type, Property })

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

参数

属性数据类型默认值必填说明
ViewCol
Number
指定列,举例 1
Type
Enum
标题,举例 Date,详细可见 Enum.DbSheetFieldType
Property
Number/String
属性值,当 Type 为 Number、Time、Date、Currency 以及 Percentage 和 Rating 时可用

示例 1:修改类型为单行文本

async function example() {
  await instance.ready()

  const app = instance.Application

  // 修改字段类型
  await app.ActiveDBSheet.Field.SetFieldType({
    ViewCol: 2, // 指定列,举例 1
    Type: 'SingleLineText' // 标题,举例 'SingleLineText'
  })
}

示例 2:修改类型为星级

async function example() {
  await instance.ready()

  const app = instance.Application

  // 修改字段类型
  await app.ActiveDBSheet.Field.SetFieldType({
    ViewCol: 2, // 指定列,举例 1
    Type: 'Rating', // 标题,举例 'Rating'
    Property: 5 // 属性,星级为 5
  })
}

ShowField()

JSSDK: v1.1.11+、WebOffice v2.5.1+ 支持

根据 ViewCol 或者 FieldId 显示字段

第 1 列不可操作

语法

表达式.ActiveDBSheet.Field.ShowField({ ViewCol, FieldId })

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

参数

属性数据类型默认值必填说明
ViewCol
Number
索引
FieldId
String
FieldId,可通过 ActiveDBSheet.Field.GetFieldId 获取

示例 1:ViewCol

async function example() {
  await instance.ready()

  const app = instance.Application

  // 根据 ViewCol 显示字段
  const id = await app.ActiveDBSheet.Field.ShowField({
    ViewCol: 2 // 索引
  })
}

示例 2:FieldId

async function example() {
  await instance.ready()

  const app = instance.Application

  // 根据 FieldId 显示字段
  const id = await app.ActiveDBSheet.Field.ShowField({
    FieldId: ActiveDBSheet.Field.GetFieldId({
      ViewCol: 2 // 索引
    })
  })
}