Skip to Content
ClassesFDefinedNameBuilder

类: FDefinedNameBuilder

方法

build()

build(): ISetDefinedNameMutationParam

Builds the defined name parameter.

返回

ISetDefinedNameMutationParam

The defined name mutation parameter.

示例

const workbook = univerAPI.getActiveWorkbook();
const definedNameBuilder = univerAPI.newDefinedName()
  .setRef('Sheet1!$A$1')
  .setName('MyDefinedName')
  .setComment('This is a comment')
  .build();
workbook.insertDefinedNameBuilder(definedNameBuilder);

load()

load(param): FDefinedNameBuilder

Loads the defined name mutation parameter.

参数

参数类型描述
paramISetDefinedNameMutationParamdefined name mutation parameter

返回

FDefinedNameBuilder

The instance of FDefinedNameBuilder for method chaining.

示例

const workbook = univerAPI.getActiveWorkbook();
const definedNameParam = {
  id: '4TMPceoqg8',
  unitId: workbook.getId(),
  name: 'MyDefinedName',
  formulaOrRefString: 'Sheet1!$A$1',
}
const definedNameBuilder = univerAPI.newDefinedName()
  .load(definedNameParam)
  .build();
workbook.insertDefinedNameBuilder(definedNameBuilder);

setComment()

setComment(comment): FDefinedNameBuilder

Sets the comment of the defined name builder.

参数

参数类型描述
commentstringThe comment of the defined name.

返回

FDefinedNameBuilder

The instance of FDefinedNameBuilder for method chaining.

示例

const workbook = univerAPI.getActiveWorkbook();
const definedNameBuilder = univerAPI.newDefinedName()
  .setComment('This is a comment')
  .build();
workbook.insertDefinedNameBuilder(definedNameBuilder);

setFormula()

setFormula(formula): FDefinedNameBuilder

Sets the formula of the defined name builder.

参数

参数类型描述
formulastringThe formula of the defined name.

返回

FDefinedNameBuilder

The instance of FDefinedNameBuilder for method chaining.

示例

const workbook = univerAPI.getActiveWorkbook();
const definedNameBuilder = univerAPI.newDefinedName()
  .setFormula('SUM(Sheet1!$A$1)')
  .setName('MyDefinedName')
  .build();
workbook.insertDefinedNameBuilder(definedNameBuilder);

setHidden()

setHidden(hidden): FDefinedNameBuilder

Sets the hidden status of the defined name builder.

参数

参数类型描述
hiddenbooleanThe hidden status of the defined name.

返回

FDefinedNameBuilder

The instance of FDefinedNameBuilder for method chaining.

示例

const workbook = univerAPI.getActiveWorkbook();
const definedNameBuilder = univerAPI.newDefinedName()
  .setHidden(true)
  .build();
workbook.insertDefinedNameBuilder(definedNameBuilder);

setName()

setName(name): FDefinedNameBuilder

Sets the name of the defined name builder.

参数

参数类型描述
namestringThe name of the defined name.

返回

FDefinedNameBuilder

The instance of FDefinedNameBuilder for method chaining.

示例

const workbook = univerAPI.getActiveWorkbook();
const definedNameBuilder = univerAPI.newDefinedName()
  .setName('MyDefinedName')
  .build();
workbook.insertDefinedNameBuilder(definedNameBuilder);

setRef()

setRef(a1Notation): FDefinedNameBuilder

Sets the reference of the defined name builder.

参数

参数类型描述
a1NotationstringThe reference of the defined name.

返回

FDefinedNameBuilder

The instance of FDefinedNameBuilder for method chaining.

示例

const workbook = univerAPI.getActiveWorkbook();
const definedNameBuilder = univerAPI.newDefinedName()
  .setRef('Sheet1!$A$1')
  .build();
workbook.insertDefinedNameBuilder(definedNameBuilder);

setRefByRange()

setRefByRange(
   row, 
   column, 
   numRows, 
   numColumns): FDefinedNameBuilder

Sets the reference of the defined name builder by range .

参数

参数类型描述
rownumberThe start row of the range.
columnnumberThe start column of the range.
numRowsnumberThe number of rows in the range.
numColumnsnumberThe number of columns in the range.

返回

FDefinedNameBuilder

The instance of FDefinedNameBuilder for method chaining.

示例

const workbook = univerAPI.getActiveWorkbook();
const definedNameBuilder = univerAPI.newDefinedName()
  .setRefByRange(1, 3, 2, 5)
  .build();
workbook.insertDefinedNameBuilder(definedNameBuilder);
FDataValidationBuilderFOverGridImageBuilder