Skip to Content
ClassesFDefinedNameBuilder

Class: FDefinedNameBuilder

Methods

build()

build(): ISetDefinedNameMutationParam;

Builds the defined name parameter.

Returns

ISetDefinedNameMutationParam

The defined name mutation parameter.

Example

const fWorkbook = univerAPI.getActiveWorkbook(); const definedNameBuilder = univerAPI.newDefinedName() .setName('MyDefinedName') .setRef('Sheet1!$A$1') .setComment('A reference to A1 cell in Sheet1') .build(); fWorkbook.insertDefinedNameBuilder(definedNameBuilder);

load()

load(param): FDefinedNameBuilder;

Loads the defined name mutation parameter.

Parameters

ParameterTypeDescription
paramISetDefinedNameMutationParamdefined name mutation parameter

Returns

FDefinedNameBuilder

The instance of FDefinedNameBuilder for method chaining.

Example

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

setComment()

setComment(comment): FDefinedNameBuilder;

Sets the comment of the defined name builder.

Parameters

ParameterTypeDescription
commentstringThe comment of the defined name.

Returns

FDefinedNameBuilder

The instance of FDefinedNameBuilder for method chaining.

Example

const fWorkbook = univerAPI.getActiveWorkbook(); const definedNameBuilder = univerAPI.newDefinedName() .setName('MyDefinedName') .setRef('Sheet1!$A$1') .setComment('A reference to A1 cell in Sheet1') .build(); fWorkbook.insertDefinedNameBuilder(definedNameBuilder);

setFormula()

setFormula(formula): FDefinedNameBuilder;

Sets the formula of the defined name builder.

Parameters

ParameterTypeDescription
formulastringThe formula of the defined name.

Returns

FDefinedNameBuilder

The instance of FDefinedNameBuilder for method chaining.

Example

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

setHidden()

setHidden(hidden): FDefinedNameBuilder;

Sets the hidden status of the defined name builder.

Parameters

ParameterTypeDescription
hiddenbooleanThe hidden status of the defined name.

Returns

FDefinedNameBuilder

The instance of FDefinedNameBuilder for method chaining.

Example

const fWorkbook = univerAPI.getActiveWorkbook(); const definedNameBuilder = univerAPI.newDefinedName() .setName('MyDefinedName') .setRef('Sheet1!$A$1') .setHidden(true) .build(); fWorkbook.insertDefinedNameBuilder(definedNameBuilder);

setName()

setName(name): FDefinedNameBuilder;

Sets the name of the defined name builder.

Parameters

ParameterTypeDescription
namestringThe name of the defined name.

Returns

FDefinedNameBuilder

The instance of FDefinedNameBuilder for method chaining.

Example

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

setRef()

setRef(a1Notation): FDefinedNameBuilder;

Sets the reference of the defined name builder.

Parameters

ParameterTypeDescription
a1NotationstringThe reference of the defined name.

Returns

FDefinedNameBuilder

The instance of FDefinedNameBuilder for method chaining.

Example

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

setRefByRange()

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

Sets the reference of the defined name builder by range .

Parameters

ParameterTypeDescription
rownumberThe start row index of the range. index start at 0.
columnnumberThe start column index of the range. index start at 0.
numRowsnumberThe number of rows in the range.
numColumnsnumberThe number of columns in the range.

Returns

FDefinedNameBuilder

The instance of FDefinedNameBuilder for method chaining.

Example

const fWorkbook = univerAPI.getActiveWorkbook(); const definedNameBuilder = univerAPI.newDefinedName() .setName('MyDefinedName') .setRefByRange(1, 3, 2, 5) // D2:H3 .build(); fWorkbook.insertDefinedNameBuilder(definedNameBuilder);

setScopeToWorkbook()

setScopeToWorkbook(): FDefinedNameBuilder;

Sets the scope of the defined name to the workbook.

Returns

FDefinedNameBuilder

The instance of FDefinedNameBuilder for method chaining.

Example

const fWorkbook = univerAPI.getActiveWorkbook(); // Create a defined name and make it available in the entire workbook const definedNameBuilder = univerAPI.newDefinedName() .setName('MyDefinedName') .setRef('Sheet1!$A$1') .setScopeToWorkbook() .build(); fWorkbook.insertDefinedNameBuilder(definedNameBuilder);

setScopeToWorksheet()

setScopeToWorksheet(worksheet): FDefinedNameBuilder;

Sets the scope of the defined name to the worksheet.

Parameters

ParameterTypeDescription
worksheetFWorksheetThe worksheet to set the scope to.

Returns

FDefinedNameBuilder

The instance of FDefinedNameBuilder for method chaining.

Example

const fWorkbook = univerAPI.getActiveWorkbook(); const sheets = fWorkbook.getSheets(); // Create a defined name and make it available only in the second worksheet const definedNameBuilder = univerAPI.newDefinedName() .setName('MyDefinedName') .setRef('Sheet1!$A$1') .setScopeToWorksheet(sheets[1]) .build(); fWorkbook.insertDefinedNameBuilder(definedNameBuilder);