Package org.apache.poi.xssf.model
Class ExternalLinksTable.ExternalName
java.lang.Object
org.apache.poi.xssf.model.ExternalLinksTable.ExternalName
- All Implemented Interfaces:
Name
- Enclosing class:
- ExternalLinksTable
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedExternalName(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTExternalDefinedName name) -
Method Summary
Modifier and TypeMethodDescriptionReturns the comment the user provided when the name was created.Gets the name of the named rangeReturns the formula that the name is defined to refer to.intReturns the sheet index this name applies to.Get the sheets name which this named range is referenced tobooleanChecks if this name points to a cell that no longer existsbooleanChecks if this name is a function namevoidsetComment(String comment) Sets the comment the user provided when the name was created.voidsetFunction(boolean value) Indicates that the defined name refers to a user-defined function.voidsetNameName(String name) Sets the name of the named rangevoidsetRefersToFormula(String formulaText) Sets the formula that the name is defined to refer to.voidsetSheetIndex(int sheetId) Tell Excel that this name applies to the worksheet with the specified index instead of the entire workbook.
-
Constructor Details
-
ExternalName
protected ExternalName(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTExternalDefinedName name)
-
-
Method Details
-
getNameName
Description copied from interface:NameGets the name of the named range- Specified by:
getNameNamein interfaceName- Returns:
- named range name
-
setNameName
Description copied from interface:NameSets the name of the named rangeThe following is a list of syntax rules that you need to be aware of when you create and edit names.
- Valid characters The first character of a name must be a letter, an underscore character (_), or a backslash (\). Remaining characters in the name can be letters, numbers, periods, and underscore characters.
- Cell references disallowed Names cannot be the same as a cell reference, such as Z$100 or R1C1.
- Spaces are not valid Spaces are not allowed as part of a name. Use the underscore character (_) and period (.) as word separators, such as, Sales_Tax or First.Quarter.
- Name length A name can contain up to 255 characters.
- Case sensitivity Names can contain uppercase and lowercase letters.
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)"
- Specified by:
setNameNamein interfaceName- Parameters:
name- named range name to set
-
getSheetName
Description copied from interface:NameGet the sheets name which this named range is referenced to- Specified by:
getSheetNamein interfaceName- Returns:
- sheet name, which this named range referred to
-
getSheetIndex
public int getSheetIndex()Description copied from interface:NameReturns the sheet index this name applies to.- Specified by:
getSheetIndexin interfaceName- Returns:
- the sheet index this name applies to, -1 if this name applies to the entire workbook
-
setSheetIndex
public void setSheetIndex(int sheetId) Description copied from interface:NameTell Excel that this name applies to the worksheet with the specified index instead of the entire workbook.- Specified by:
setSheetIndexin interfaceName- Parameters:
sheetId- the sheet index this name applies to, -1 unsets this property making the name workbook-global
-
getRefersToFormula
Description copied from interface:NameReturns the formula that the name is defined to refer to.- Specified by:
getRefersToFormulain interfaceName- Returns:
- the reference for this name,
nullif it has not been set yet. Never empty string - See Also:
-
setRefersToFormula
Description copied from interface:NameSets the formula that the name is defined to refer to. The following are representative examples:'My Sheet'!$A$38.3HR!$A$1:$Z$345SUM(Sheet1!A1,Sheet2!B2)-PMT(Interest_Rate/12,Number_of_Payments,Loan_Amount)
- Specified by:
setRefersToFormulain interfaceName- Parameters:
formulaText- the reference for this name
-
isFunctionName
public boolean isFunctionName()Description copied from interface:NameChecks if this name is a function name- Specified by:
isFunctionNamein interfaceName- Returns:
- true if this name is a function name
-
isDeleted
public boolean isDeleted()Description copied from interface:NameChecks if this name points to a cell that no longer exists -
getComment
Description copied from interface:NameReturns the comment the user provided when the name was created.- Specified by:
getCommentin interfaceName- Returns:
- the user comment for this named range
-
setComment
Description copied from interface:NameSets the comment the user provided when the name was created.- Specified by:
setCommentin interfaceName- Parameters:
comment- the user comment for this named range
-
setFunction
public void setFunction(boolean value) Description copied from interface:NameIndicates that the defined name refers to a user-defined function. This attribute is used when there is an add-in or other code project associated with the file.- Specified by:
setFunctionin interfaceName- Parameters:
value-trueindicates the name refers to a function.
-