Inspired by Stackoverflow #61292598 - Expose if a Named Range is hidden or not

git-svn-id: https://svn.apache.org/repos/asf/poi/trunk@1876722 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/src/java/org/apache/poi/hssf/usermodel/HSSFName.java b/src/java/org/apache/poi/hssf/usermodel/HSSFName.java
index d2f8b857f48f26e134775470407917151a2014f5..c805c573e9611a7ddb37072e16ff42b3d94f6c8e 100644 (file)
--- a/src/java/org/apache/poi/hssf/usermodel/HSSFName.java
+++ b/src/java/org/apache/poi/hssf/usermodel/HSSFName.java
@@ -264,6 +264,16 @@ public final class HSSFName implements Name {
         return _definedNameRec.isFunctionName();
     }
 
+    /**
+     * Checks if this name is hidden, eg one of the built-in Excel
+     *  internal names
+     *
+     * @return true if this name is a hidden one
+     */
+    public boolean isHidden() {
+        return _definedNameRec.isHiddenName();
+    }
+
     public String toString() {
         return getClass().getName() + " [" +
                 _definedNameRec.getNameText() +

diff --git a/src/java/org/apache/poi/ss/usermodel/Name.java b/src/java/org/apache/poi/ss/usermodel/Name.java
index 67bc245d0ccdf11a0e76cfc99ea490ab9f0a60a7..03e13a83d97d7ce1a9978f4618a71412f67f3332 100644 (file)
--- a/src/java/org/apache/poi/ss/usermodel/Name.java
+++ b/src/java/org/apache/poi/ss/usermodel/Name.java
@@ -158,6 +158,14 @@ public interface Name {
      */
     boolean isDeleted();
 
+    /**
+     * Checks if this name is hidden, eg one of the built-in Excel
+     *  internal names
+     *
+     * @return <code>true</code> if the name is a hidden name, <code>false</code> otherwise
+     */
+    boolean isHidden();
+
     /**
      * Tell Excel that this name applies to the worksheet with the specified index instead of the entire workbook.
      *

diff --git a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFName.java b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFName.java
index e56af69d9a35ec09bd8e653cd40c5d54a35659bb..21300d47e38b0f5e365a6ae56977d35897d0e121 100644 (file)
--- a/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFName.java
+++ b/src/ooxml/java/org/apache/poi/xssf/usermodel/XSSFName.java
@@ -305,6 +305,16 @@ public final class XSSFName implements Name {
         return getFunction();
     }
 
+    /**
+     * Checks if this name is hidden, eg one of the built-in Excel
+     *  internal names
+     *
+     * @return true if this name is a hidden one
+     */
+    public boolean isHidden() {
+        return _ctName.getHidden();
+    }
+
     /**
      * Returns the comment the user provided when the name was created.
      *