Get Started
Usage API
More information

ApiName

new ApiName()

Class representing the names.

Properties

Name Type Description
Name string

Sets a name to the active sheet.

RefersTo string

Returns or sets the formula that the name is defined to refer to.

RefersToRange apiRange

Returns the ApiRange object by reference.

Methods

Name Description
Delete

Delete the DefName object.

GetName

Return a String value representing the object name.

GetRefersTo

Return the formula that the name is defined to refer to.

GetRefersToRange

Return an ApiRange object by reference.

SetName

Set a String value representing the object name.

SetRefersTo

Set the formula that the name is defined to refer to.

Example

Copy code
builder.CreateFile("xlsx");
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");
oDefName = Api.GetDefName("numbers");
oDefName.SetName("summa");
oDefName.SetRefersTo("=SUM(A1:B1)");
oNewDefName = Api.GetDefName("summa");
oWorksheet.GetRange("A3").SetValue("The 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