Valid characters for Excel sheet names

Question

In Java, we\'re using the following package to programmatically create excel documents:

org.apache.poi.hssf

If you attempt to set a sheet\'

Answer 1

This is what I use in C# (should be similar in Java):

const string invalidCharsRegex = @"[/\\*'?[\]:]+";
const int maxLength = 31;

string safeName = Regex.Replace(worksheetName, invalidCharsRegex, " ")
                        .Replace("  ", " ")
                        .Trim();

if (string.IsNullOrEmpty(safeName))
{
    safeName = "Default";   // cannot be empty
}
else if (safeName.Length > maxLength)
{
    safeName = safeName.Substring(0, maxLength);
}

Answer 2

You can use this:

protected Sheet createSheet(XSSFWorkbook book, String nameSheet) {
    return book.createSheet(WorkbookUtil.createSafeSheetName(nameSheet));
}

Answer 3

You can use the Apache POI's WorkbookUtil.createSafeSheetName(String s) to safely create your Sheet Name.

http://poi.apache.org/apidocs/org/apache/poi/ss/util/WorkbookUtil.html

Answer 4

I think the problem is the colon, not the exclamation point.

If you open Excel and try to manually edit a sheet name, the only characters it doesn't let you type are [ ] * / \ ? :

If you paste one of those characters in, you get the following error: (Excel 2003)

While renaming a sheet or chart, you entered an invalid name. Try one of the following:

• Make sure the name you entered does not exceed 31 characters.
• Make sure the name does not contain any of the following characters: : \ / ? * [ or ]
• Make sure you did not leave the name blank.