Class: FDefinedName

Methods

delete()


delete(): void;

Deletes the defined name.

Returns

void

Example


const fWorkbook = univerAPI.getActiveWorkbook();
const definedName = fWorkbook.getDefinedNames()[0];
definedName?.delete();

getComment()


getComment(): string;

Gets the comment of the defined name.

Returns

string

The comment of the defined name.

Example


const fWorkbook = univerAPI.getActiveWorkbook();
const definedName = fWorkbook.getDefinedNames()[0];
console.log(definedName?.getComment());

getFormulaOrRefString()


getFormulaOrRefString(): string;

Gets the formula or reference string of the defined name.

Returns

string

The formula or reference string of the defined name.

Example


const fWorkbook = univerAPI.getActiveWorkbook();
const definedName = fWorkbook.getDefinedNames()[0];
console.log(definedName?.getFormulaOrRefString());

getLocalSheetId()


getLocalSheetId(): string;

Gets the local sheet id of the defined name.

Returns

string

The local sheet id of the defined name.

Example


const fWorkbook = univerAPI.getActiveWorkbook();
const definedName = fWorkbook.getDefinedNames()[0];
console.log(definedName?.getLocalSheetId());

getName()


getName(): string;

Gets the name of the defined name.

Returns

string

The name of the defined name.

Example


const fWorkbook = univerAPI.getActiveWorkbook();
const definedName = fWorkbook.getDefinedNames()[0];
console.log(definedName?.getName());

isWorkbookScope()


isWorkbookScope(): boolean;

Checks if the defined name is in the workbook scope.

Returns

boolean

True if the defined name is in the workbook scope, false otherwise.

Example


const fWorkbook = univerAPI.getActiveWorkbook();
const definedName = fWorkbook.getDefinedNames()[0];
console.log(definedName?.isWorkbookScope());

setComment()


setComment(comment): void;

Sets the comment of the defined name.

Parameters

Parameter	Type	Description
`comment`	`string`	The comment of the defined name.

Returns

void

Example


const fWorkbook = univerAPI.getActiveWorkbook();
const definedName = fWorkbook.getDefinedNames()[0];
definedName?.setComment('This is a comment');

setFormula()


setFormula(formula): void;

Sets the formula of the defined name.

Parameters

Parameter	Type	Description
`formula`	`string`	The formula of the defined name.

Returns

void

Example


const fWorkbook = univerAPI.getActiveWorkbook();
const definedName = fWorkbook.getDefinedNames()[0];
definedName?.setFormula('SUM(Sheet1!$A$1)');

setHidden()


setHidden(hidden): void;

Sets the hidden status of the defined name.

Parameters

Parameter	Type	Description
`hidden`	`boolean`	The hidden status of the defined name.

Returns

void

Example


const fWorkbook = univerAPI.getActiveWorkbook();
const definedName = fWorkbook.getDefinedNames()[0];
definedName?.setHidden(true);

setName()


setName(name): void;

Sets the name of the defined name.

Parameters

Parameter	Type	Description
`name`	`string`	The name of the defined name.

Returns

void

Example


const fWorkbook = univerAPI.getActiveWorkbook();
const definedName = fWorkbook.getDefinedNames()[0];
definedName?.setName('NewDefinedName');

setRef()


setRef(refString): void;

Sets the reference of the defined name.

Parameters

Parameter	Type	Description
`refString`	`string`	The reference of the defined name.

Returns

void

Example


const fWorkbook = univerAPI.getActiveWorkbook();
const definedName = fWorkbook.getDefinedNames()[0];
definedName?.setRef('Sheet1!$A$1');

setRefByRange()


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

Sets the reference of the defined name by range.

Parameters

Parameter	Type	Description
`row`	`number`	The start row of the range.
`column`	`number`	The start column of the range.
`numRows`	`number`	The number of rows in the range.
`numColumns`	`number`	The number of columns in the range.

Returns

void

Example


const fWorkbook = univerAPI.getActiveWorkbook();
const definedName = fWorkbook.getDefinedNames()[0];
definedName?.setRefByRange(1, 3, 2, 5); // D2:H3

setScopeToWorkbook()


setScopeToWorkbook(): void;

Sets the scope of the defined name to the workbook.

Returns

void

Example


const fWorkbook = univerAPI.getActiveWorkbook();
const definedName = fWorkbook.getDefinedNames()[0];
definedName?.setScopeToWorkbook();

setScopeToWorksheet()


setScopeToWorksheet(worksheet): void;

Sets the scope of the defined name to the worksheet.

Parameters

Parameter	Type	Description
`worksheet`	`FWorksheet`	The worksheet to set the scope to.

Returns

void

Example


const fWorkbook = univerAPI.getActiveWorkbook();
const sheets = fWorkbook.getSheets();
 
// Get the first defined name and make it available only in the second worksheet
const definedName = fWorkbook.getDefinedNames()[0];
definedName?.setScopeToWorksheet(sheets[1]);

toBuilder()


toBuilder(): FDefinedNameBuilder;

Converts the defined name to a defined name builder.

Returns

FDefinedNameBuilder

The defined name builder.

Example


const fWorkbook = univerAPI.getActiveWorkbook();
const definedName = fWorkbook.getDefinedNames()[0];
if (!definedName) return;
const definedNameBuilder = definedName
  .toBuilder()
  .setName('NewDefinedName')
  .setFormula('SUM(Sheet1!$A$1)')
  .build();
fWorkbook.updateDefinedNameBuilder(definedNameBuilder);