Setting Formula for Named Range

Setting Formula for Named Range

Like Excel application, Aspose.Cells APIs provide the ability to specify a formula for a named range while using its RefersTo property. There could be numerous usability scenarios for this feature, a few of which are detailed as follow.

Setting a Simple Formula for Named Range

A simple formula could be a reference to another cell in the same (or different) worksheet. The following example creates a named range in a new spreadsheet and sets its reference to another cell.

// For complete examples and data files, please go to https://github.com/aspose-cells/Aspose.Cells-for-.NET
// The path to the documents directory.
string dataDir = RunExamples.GetDataDir(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType);
// Create an instance of Workbook
Workbook book = new Workbook();
// Get the WorksheetCollection
WorksheetCollection worksheets = book.Worksheets;
// Add a new Named Range with name "NewNamedRange"
int index = worksheets.Names.Add("NewNamedRange");
// Access the newly created Named Range
Name name = worksheets.Names[index];
// Set RefersTo property of the Named Range to a formula. Formula references another cell in the same worksheet
name.RefersTo = "=Sheet1!$A$3";
// Set the formula in the cell A1 to the newly created Named Range
worksheets[0].Cells["A1"].Formula = "NewNamedRange";
// Insert the value in cell A3 which is being referenced in the Named Range
worksheets[0].Cells["A3"].PutValue("This is the value of A3");
// Calculate formulas
book.CalculateFormula();
// Save the result in XLSX format
book.Save(dataDir + "output_out.xlsx");

Setting a Complex Formula for Named Range

A complex formula could be anything such as a dynamic range or a formula spanning over multiple cells in different worksheets. The following example creates a dynamic range using the INDEX function to get the value from a list based on its location.

// For complete examples and data files, please go to https://github.com/aspose-cells/Aspose.Cells-for-.NET
// The path to the documents directory.
string dataDir = RunExamples.GetDataDir(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType);
// Create an instance of Workbook
Workbook book = new Workbook();
// Get the WorksheetCollection
WorksheetCollection worksheets = book.Worksheets;
// Add a new Named Range with name "data"
int index = worksheets.Names.Add("data");
// Access the newly created Named Range from the collection
Name data = worksheets.Names[index];
// Set RefersTo property of the Named Range to a cell range in same worksheet
data.RefersTo = "=Sheet1!$A$1:$A$10";
// Add another Named Range with name "range"
index = worksheets.Names.Add("range");
// Access the newly created Named Range from the collection
Name range = worksheets.Names[index];
// Set RefersTo property to a formula using the Named Range data
range.RefersTo = "=INDEX(data,Sheet1!$A$1,1):INDEX(data,Sheet1!$A$1,9)";
// Save the workbook
book.Save(dataDir + "output_out.xlsx");

Here is another example that uses a named range to sum values from 2 cells in different worksheets.

// For complete examples and data files, please go to https://github.com/aspose-cells/Aspose.Cells-for-.NET
// The path to the documents directory.
string dataDir = RunExamples.GetDataDir(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType);
// Create an instance of Workbook
Workbook book = new Workbook();
// Get the WorksheetCollection
WorksheetCollection worksheets = book.Worksheets;
// Insert some data in cell A1 of Sheet1
worksheets["Sheet1"].Cells["A1"].PutValue(10);
// Add a new Worksheet and insert a value to cell A1
worksheets[worksheets.Add()].Cells["A1"].PutValue(10);
// Add a new Named Range with name "range"
int index = worksheets.Names.Add("range");
// Access the newly created Named Range from the collection
Name range = worksheets.Names[index];
// Set RefersTo property of the Named Range to a SUM function
range.RefersTo = "=SUM(Sheet1!$A$1,Sheet2!$A$1)";
// Insert the Named Range as formula to 3rd worksheet
worksheets[worksheets.Add()].Cells["A1"].Formula = "range";
// Calculate formulas
book.CalculateFormula();
// Save the result in XLSX format
book.Save(dataDir + "output_out.xlsx");