public final Class HSSFName

Implements org.apache.poi.ss.usermodel.Name.getComment.

Returns the comment the user provided when the name was created.

Returns:String

the user comment for this named range

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Name.getNameName.

Doc from org.apache.poi.ss.usermodel.Name.getNameName.

Gets the name of the named range

Returns:String

text name of this defined name

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Name.getRefersToFormula.

Doc from org.apache.poi.ss.usermodel.Name.getRefersToFormula.

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

Returns:String

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

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Name.getSheetIndex.

Returns the sheet index this name applies to.

Returns:int

the sheet index this name applies to, -1 if this name applies to the entire workbook

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Name.getSheetName.

Get the sheets name which this named range is referenced to

Returns:String

sheet name, which this named range referred to

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Name.isDeleted.

Doc from org.apache.poi.ss.usermodel.Name.isDeleted.

Checks if this name points to a cell that no longer exists

Returns:boolean

true if the name refers to a deleted cell, false otherwise

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Name.isFunctionName.

Checks if this name is a function name

Returns:boolean

true if this name is a function name

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Name.isHidden.

Checks if this name is hidden, eg one of the built-in Excel internal names

Returns:boolean

true if this name is a hidden one

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Name.setComment.

Sets the comment the user provided when the name was created.

Parameters

comment:String

the user comment for this named range

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Name.setFunction.

Indicates 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.

Parameters

value:boolean

true indicates the name refers to a function.

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Name.setNameName.

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
HSSFName 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)"

Parameters

nameName:String

named range name to set

Annotations

@Override

Exceptions

IllegalArgumentException:

if the name is invalid or the name already exists (case-insensitive)

Implements org.apache.poi.ss.usermodel.Name.setRefersToFormula.

Doc from org.apache.poi.ss.usermodel.Name.setRefersToFormula.

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)

Parameters

formulaText:String

the reference for this name

Annotations

@Override

Implements org.apache.poi.ss.usermodel.Name.setSheetIndex.

Specifies if the defined name is a local name, and if so, which sheet it is on.

Parameters

index:int

if greater than 0, the defined name is a local name and the value MUST be a 0-based index to the collection of sheets as they appear in the workbook.

Annotations

@Override

Exceptions

IllegalArgumentException:

if the sheet index is invalid.

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object