AddDefName

AddDefName(sName, sRef, isHidden) → { boolean }

Adds a new name to the current worksheet.

Parameters:

Name Type Description
sName string

The range name.

sRef string

Must contain the sheet name, followed by sign ! and a range of cells. Example: "Sheet1!$A$1:$B$2".

isHidden boolean

Defines if the range name is hidden or not.

Returns:

Type
boolean

Example

Copy code
builder.CreateFile("xlsx");
var oWorksheet = Api.GetActiveSheet();
oWorksheet.GetRange("A1").SetValue("1");
oWorksheet.GetRange("B1").SetValue("2");
oWorksheet.AddDefName("numbers", "Sheet1!$A$1:$B$1");
oWorksheet.GetRange("A3").SetValue("We defined a name 'numbers' for a range of cells A1:B1.");
builder.SaveFile("xlsx", "AddDefName.xlsx");
builder.CloseFile();

Resulting document