ApiName

new ApiName()

Class representing a name.

Properties

Name	Type	Description
Name	string	Sets a name to the active sheet.
RefersTo	string	Returns or sets a formula that the name is defined to refer to.
RefersToRange	ApiRange	Returns the ApiRange object by reference.

Methods

Name	Description
Delete	Deletes the DefName object.
GetName	Returns a type of the ApiName class.
GetRefersTo	Returns a formula that the name is defined to refer to.
GetRefersToRange	Returns the ApiRange object by its name.
SetName	Sets a string value representing the object name.
SetRefersTo	Sets a formula that the name is defined to refer to.

Example

builder.CreateFile("xlsx");
var oWorksheet = Api.GetActiveSheet();
oWorksheet.GetRange("A1").SetValue("1");
oWorksheet.GetRange("B1").SetValue("2");
oWorksheet.GetRange("C1").SetValue("=SUM(A1:B1)");
Api.AddDefName("numbers", "Sheet1!$A$1:$B$1");
var oDefName = Api.GetDefName("numbers");
oDefName.SetName("summa");
oDefName.SetRefersTo("=SUM(A1:B1)");
var oNewDefName = Api.GetDefName("summa");
oWorksheet.GetRange("A3").SetValue("A new name of the range: " + oNewDefName.GetName());
oWorksheet.GetRange("A4").SetValue("The name 'summa' refers to the formula from the cell C1.");
oWorksheet.GetRange("A5").SetValue("Formula: " + oDefName.GetRefersTo());
builder.SaveFile("xlsx", "ApiName.xlsx");
builder.CloseFile();

Resulting document