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

protected class ExternalLinksTable.ExternalName
extends java.lang.Object
implements Name

ExternalLinksTable.ExternalName

protected ExternalLinksTable.ExternalName(org.openxmlformats.schemas.spreadsheetml.x2006.main.CTExternalDefinedName name)

getNameName

public java.lang.String getNameName()

Description copied from interface: Name

Gets the name of the named range

Specified by:

getNameName in interface Name

Returns:

named range name

setNameName

public void setNameName(java.lang.String name)

Description copied from interface: Name

Sets the name of the named range

The 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:

setNameName in interface Name

Parameters:

name - named range name to set

getSheetName

public java.lang.String getSheetName()

Description copied from interface: Name

Get the sheets name which this named range is referenced to

Specified by:

getSheetName in interface Name

Returns:

sheet name, which this named range referred to

getSheetIndex

public int getSheetIndex()

Description copied from interface: Name

Returns the sheet index this name applies to.

Specified by:

getSheetIndex in interface Name

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: Name

Tell Excel that this name applies to the worksheet with the specified index instead of the entire workbook.

Specified by:

setSheetIndex in interface Name

Parameters:

sheetId - the sheet index this name applies to, -1 unsets this property making the name workbook-global

getRefersToFormula

public java.lang.String getRefersToFormula()

Description copied from interface: Name

Returns the formula that the name is defined to refer to.

Specified by:

getRefersToFormula in interface Name

Returns:

the reference for this name, null if it has not been set yet. Never empty string

See Also:

Name.setRefersToFormula(String)

setRefersToFormula

public void setRefersToFormula(java.lang.String formulaText)

Description copied from interface: Name

Sets the formula that the name is defined to refer to. The following are representative examples:

• '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)

Specified by:

setRefersToFormula in interface Name

Parameters:

formulaText - the reference for this name

public boolean isFunctionName()

public boolean isDeleted()

public java.lang.String getComment()

public void setComment(java.lang.String comment)

public void setFunction(boolean value)