com.aspose.cells
Class Name

java.lang.Object
    com.aspose.cells.Name

public class Name 
extends java.lang.Object

//Instantiating a Workbook object
Workbook workbook = new Workbook();
//Accessing the first worksheet in the Excel file
Worksheet worksheet = workbook.getWorksheets().get(0);
//Creating a named range
Range range = worksheet.getCells().createRange("B4", "G14");
//Setting the name of the named range
range.setName("TestRange");
//Saving the modified Excel file in default (that is Excel 2000) format
workbook.save("C:\\output.xls");

public java.lang.String getComment() / public void setComment(java.lang.String value)

Gets and sets the comment of the name. Only applies for Excel 2007.

public java.lang.String getText() / public void setText(java.lang.String value)

Gets the name text of the object.

public java.lang.String getFullText()

Gets the name full text of the object with the scope setting.

public java.lang.String getRefersTo() / public void setRefersTo(java.lang.String value)

Returns or sets the formula that the name is defined to refer to, beginning with an equal sign.

public java.lang.String getR1C1RefersTo() / public void setR1C1RefersTo(java.lang.String value)

Gets or sets a R1C1 reference of the Name.

public boolean isReferred()

Indicates whether this name is referred by other formulas.

public boolean isVisible() / public void setVisible(boolean value)

Indicates whether the name is visible.

public int getSheetIndex() / public void setSheetIndex(int value)

Indicates this name belongs to Workbook or Worksheet. 0 = Global name, otherwise index to sheet (one-based)

public java.lang.String getRefersTo(boolean isR1C1, boolean isLocal)

Get the reference of this Name.

Parameters:

isR1C1 - Whether the reference needs to be formatted as R1C1.

isLocal - Whether the reference needs to be formatted by locale.

public java.lang.String getRefersTo(boolean isR1C1, boolean isLocal, int row, int column)

Get the reference of this Name based on specified cell.

Parameters:

isR1C1 - Whether the reference needs to be formatted as R1C1.

isLocal - Whether the reference needs to be formatted by locale.

row - The row index of the cell.

column - The column index of the cell.

public void setRefersTo(java.lang.String refersTo, boolean isR1C1, boolean isLocal)

Set the reference of this Name.

Parameters:

refersTo - The reference.

isR1C1 - Whether the reference is R1C1 format.

isLocal - Whether the reference is locale formatted.

public java.lang.String toString()

Returns a string represents the current Range object.

Returns:

public com.aspose.cells.Range[] getRanges()

Gets all ranges referred by this name.

Returns:

All ranges.

public com.aspose.cells.Range[] getRanges(boolean recalculate)

Gets all ranges referred by this name.

Parameters:

recalculate - whether recalculate it if this name has been calculated before this invocation.

Returns:

All ranges.

public com.aspose.cells.ReferredArea[] getReferredAreas(boolean recalculate)

Gets all references referred by this name.

Parameters:

recalculate - whether recalculate it if this name has been calculated before this invocation.

Returns:

All ranges.

public Range getRange()

Gets the range if this name refers to a range.

Returns:

The range.

public Range getRange(boolean recalculate)

Gets the range if this name refers to a range

Parameters:

recalculate - whether recalculate it if this name has been calculated before this invocation.

Returns:

The range.

public Range getRange(int sheetIndex, int row, int column)

Gets the range if this name refers to a range. If the reference of this name is not absolute, the range may be different for different cell.

Parameters:

sheetIndex - The according sheet index.

row - The according row index.

column - The according column index

Returns:

The range.