The requested page is not available for the requested platform. You are viewing the content for .NET Framework 4.5.2+ platform.
.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+
Row

DefinedName Interface

A defined name that refers to a cell, range of cells, formula or constant value.

Namespace: DevExpress.Spreadsheet

Assembly: DevExpress.Spreadsheet.v19.1.Core.dll

Declaration

public interface DefinedName :
    ExternalDefinedName
Public Interface DefinedName
    Inherits ExternalDefinedName
public interface DefinedName :
    ExternalDefinedName
Public Interface DefinedName
    Inherits ExternalDefinedName

Remarks

To make is easier to understand information contained in a worksheet and refer to individual cells, cell ranges, formulas and constant values, you can use defined names. A defined name is an object that implements the DefinedName interface. Its DefinedName.Name property specifies the name that refers to a cell, cell range, formula or constant specified by the DefinedName.RefersTo property.

You can provide a defined name with an explanation or additional information via the DefinedName.Comment property. To get or set a cell range associated with the defined name, use the DefinedName.Range property.

Each defined name has a scope - an area (an individual worksheet or entire workbook) within which a name is recognized and can be used without qualification. So, each worksheet contained in the workbook and the entire workbook has it's own collection of defined names (DefinedNameCollection) that can be accessed via the Worksheet.DefinedNames or IWorkbook.DefinedNames property, respectively. You can get a defined name object by its index in the collection or by its name (DefinedNameCollection.GetDefinedName).

To create a defined name, use the DefinedNameCollection.Add method or the Range.Name property. To delete an existing defined name, use the DefinedNameCollection.Remove method.

For more information on defined names, see the Defined Names document.

Examples

This example demonstrates how to create a named range of cells in a worksheet. You can do this in one of the following ways.

Note

When specifying a name for a cell or range of cells, follow the rules listed in the Defined Names document.

using DevExpress.Spreadsheet;
// ...

IWorkbook workbook = spreadsheetControl1.Document;
Worksheet worksheet = workbook.Worksheets[0];

// Create a range.
Range rangeA2A4 = worksheet.Range["A2:A4"];
// Specify the name for the created range.
rangeA2A4.Name = "rangeA2A4";

// Create a new defined name with the specifed range name and absolute reference.
DefinedName definedName = worksheet.DefinedNames.Add("rangeC2D3", "Sheet1!$C$2:$D$3");
// Create a range using the specified defined name.
Range rangeC2D3 = worksheet.Range[definedName.Name];
See Also