protected class ExternalLinksTable.ExternalName extends java.lang.Object implements Name
Modifier | Constructor and Description |
---|---|
protected |
ExternalName(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTExternalDefinedName name) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getComment()
Returns the comment the user provided when the name was created.
|
java.lang.String |
getNameName()
Gets the name of the named range
|
java.lang.String |
getRefersToFormula()
Returns the formula that the name is defined to refer to.
|
int |
getSheetIndex()
Returns the sheet index this name applies to.
|
java.lang.String |
getSheetName()
Get the sheets name which this named range is referenced to
|
boolean |
isDeleted()
Checks if this name points to a cell that no longer exists
|
boolean |
isFunctionName()
Checks if this name is a function name
|
void |
setComment(java.lang.String comment)
Sets the comment the user provided when the name was created.
|
void |
setFunction(boolean value)
Indicates that the defined name refers to a user-defined function.
|
void |
setNameName(java.lang.String name)
Sets the name of the named range
|
void |
setRefersToFormula(java.lang.String formulaText)
Sets the formula that the name is defined to refer to.
|
void |
setSheetIndex(int sheetId)
Tell Excel that this name applies to the worksheet with the specified index instead of the entire workbook.
|
protected ExternalName(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTExternalDefinedName name)
public java.lang.String getNameName()
Name
getNameName
in interface Name
public void setNameName(java.lang.String name)
Name
The following is a list of syntax rules that you need to be aware of when you create and edit names.
A name must always be unique within its scope. POI prevents you from defining a name that is not unique within its scope. However you can use the same name in different scopes. Example:
//by default names are workbook-global Name name; name = workbook.createName(); name.setNameName("sales_08"); name = workbook.createName(); name.setNameName("sales_08"); //will throw an exception: "The workbook already contains this name (case-insensitive)" //create sheet-level name name = workbook.createName(); name.setSheetIndex(0); //the scope of the name is the first sheet name.setNameName("sales_08"); //ok name = workbook.createName(); name.setSheetIndex(0); name.setNameName("sales_08"); //will throw an exception: "The sheet already contains this name (case-insensitive)"
setNameName
in interface Name
name
- named range name to setpublic java.lang.String getSheetName()
Name
getSheetName
in interface Name
public int getSheetIndex()
Name
getSheetIndex
in interface Name
public void setSheetIndex(int sheetId)
Name
setSheetIndex
in interface Name
sheetId
- the sheet index this name applies to, -1 unsets this property making the name workbook-globalpublic java.lang.String getRefersToFormula()
Name
getRefersToFormula
in interface Name
null
if it has not been set yet. Never empty stringName.setRefersToFormula(String)
public void setRefersToFormula(java.lang.String formulaText)
Name
'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 Name
formulaText
- the reference for this namepublic boolean isFunctionName()
Name
isFunctionName
in interface Name
public boolean isDeleted()
Name
public java.lang.String getComment()
Name
getComment
in interface Name
public void setComment(java.lang.String comment)
Name
setComment
in interface Name
comment
- the user comment for this named rangepublic void setFunction(boolean value)
Name
setFunction
in interface Name
value
- true
indicates the name refers to a function.Copyright 2020 The Apache Software Foundation or its licensors, as applicable.