com.aspose.cells
Class Name

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

public class Name 
extends java.lang.Object

Represents a defined name for a range of cells.

Example:

//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");

Property Getters/Setters Summary
java.lang.StringgetComment()
voidsetComment(java.lang.String value)
           Gets and sets the commont of the name. Only applies for Excel 2007.
java.lang.StringgetFullText()
           Gets the name full text of the object with the scope setting.
booleanisReferred()
           Indicates whether this name is referred by other formulas.
booleanisVisible()
voidsetVisible(boolean value)
           Indicates whether the name is visible.
java.lang.StringgetR1C1RefersTo()
voidsetR1C1RefersTo(java.lang.String value)
           Gets or sets a R1C1 reference of the Name.
java.lang.StringgetRefersTo()
voidsetRefersTo(java.lang.String value)
           Returns or sets the formula that the name is defined to refer to, beginning with an equal sign.
intgetSheetIndex()
voidsetSheetIndex(int value)
           Indicates this name belongs to Workbook or Worksheet. 0 = Global name, otherwise index to sheet (one-based)
java.lang.StringgetText()
voidsetText(java.lang.String value)
           Gets the name text of the object.
 
Method Summary
RangegetRange()
           Gets the range if this name refers to a range.
com.aspose.cells.Range[]getRanges()
           Gets all ranges which referred by this name.
java.lang.StringtoString()
           Returns a string represents the current Range object.
 

Property Getters/Setters Detail

getComment/setComment

public java.lang.String getComment() / public void setComment(java.lang.String value)
Gets and sets the commont of the name. Only applies for Excel 2007.

getText/setText

public java.lang.String getText() / public void setText(java.lang.String value)
Gets the name text of the object.

getFullText

public java.lang.String getFullText()
Gets the name full text of the object with the scope setting.

getRefersTo/setRefersTo

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.

getR1C1RefersTo/setR1C1RefersTo

public java.lang.String getR1C1RefersTo() / public void setR1C1RefersTo(java.lang.String value)
Gets or sets a R1C1 reference of the Name.

isReferred

public boolean isReferred()
Indicates whether this name is referred by other formulas.

isVisible/setVisible

public boolean isVisible() / public void setVisible(boolean value)
Indicates whether the name is visible.

getSheetIndex/setSheetIndex

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)

Method Detail

toString

public java.lang.String toString()
Returns a string represents the current Range object.
Returns:

getRanges

public com.aspose.cells.Range[] getRanges()
Gets all ranges which referred by this name.
Returns:
All ranges.

getRange

public Range getRange()
Gets the range if this name refers to a range.
Returns:
The range.

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cellss Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.