|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.poi.hssf.usermodel.HSSFName
public final class HSSFName
High Level Representation of a 'defined name' which could be a 'built-in' name, 'named range' or name of a user defined function.
Method Summary | |
---|---|
java.lang.String |
getNameName()
|
java.lang.String |
getReference()
Deprecated. (Nov 2008) Misleading name. Use getRefersToFormula() instead. |
java.lang.String |
getRefersToFormula()
Returns the formula that the name is defined to refer to. |
java.lang.String |
getSheetName()
Get the sheets name which this named range is referenced to |
boolean |
isDeleted()
Tests if this name points to a cell that no longer exists |
boolean |
isFunctionName()
Checks if this name is a function name |
void |
setNameName(java.lang.String nameName)
Sets the name of the named range |
void |
setReference(java.lang.String ref)
Deprecated. (Nov 2008) Misleading name. Use setRefersToFormula(String) instead. |
void |
setRefersToFormula(java.lang.String formulaText)
Sets the formula that the name is defined to refer to. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Method Detail |
---|
public java.lang.String getSheetName()
getSheetName
in interface org.apache.poi.ss.usermodel.Name
public java.lang.String getNameName()
getNameName
in interface org.apache.poi.ss.usermodel.Name
public void setNameName(java.lang.String nameName)
The following is a list of syntax rules that you need to be aware of when you create and edit names.
setNameName
in interface org.apache.poi.ss.usermodel.Name
nameName
- named range name to set
java.lang.IllegalArgumentException
- if the name is invalid or the workbook already contains this name (case-insensitive)public java.lang.String getReference()
getRefersToFormula()
instead.
public void setReference(java.lang.String ref)
setRefersToFormula(String)
instead.
public void setRefersToFormula(java.lang.String formulaText)
'My Sheet'!$A$3
8.3
HR!$A$1:$Z$345
SUM(Sheet1!A1,Sheet2!B2)
-PMT(Interest_Rate/12,Number_of_Payments,Loan_Amount)
setRefersToFormula
in interface org.apache.poi.ss.usermodel.Name
formulaText
- the reference for this name
java.lang.IllegalArgumentException
- if the specified reference is unparsablepublic java.lang.String getRefersToFormula()
getRefersToFormula
in interface org.apache.poi.ss.usermodel.Name
setRefersToFormula(String)
public boolean isDeleted()
isDeleted
in interface org.apache.poi.ss.usermodel.Name
public boolean isFunctionName()
isFunctionName
in interface org.apache.poi.ss.usermodel.Name
public java.lang.String toString()
toString
in class java.lang.Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |