Method Details

• getManager

  String getManager()

  Gets the manager property.

  Returns the built-in document property that stores the name of the person responsible for managing the document.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setManager("Manager");
   String manager = properties.getManager();
   

  Returns:

  The manager property value. Returns null if the property has not been set.

• setManager

  void setManager(String value)

  Sets the manager property.

  Sets the built-in document property that stores the name of the person responsible for managing the document.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setManager("Manager");
   

  Parameters:

  value - The manager property value. This value can be null.

• getNameOfApplication

  String getNameOfApplication()

  Gets the name of the application.

  Use this property to read the application name stored in the built-in document properties.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setNameOfApplication("Example App");
   String applicationName = properties.getNameOfApplication();
   

  Returns:

  The application name.

• setNameOfApplication

  void setNameOfApplication(String value)

  Sets the name of the application.

  Use this property to set the application name stored in the built-in document properties.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setNameOfApplication("Example App");
   

  Parameters:

  value - The application name.

• getPages

  int getPages()

  Gets an estimate of the number of pages in the document.

  Use this property to retrieve the built-in document metadata value that stores the estimated page count.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setPages(12);
   int pages = properties.getPages();
   

  Returns:

  The estimated number of pages in the document.

• setPages

  void setPages(int value)

  Sets an estimate of the number of pages in the document.

  Use this property to set the built-in document metadata value that stores the estimated page count.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setPages(12);
   

  Parameters:

  value - The estimated number of pages in the document.

• getRevisionNumber

  String getRevisionNumber()

  Gets the revision number of the document.

  Use this property to retrieve the revision number stored in the built-in document properties.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setRevisionNumber("5");
   String revisionNumber = properties.getRevisionNumber();
   

  Returns:

  The revision number of the document.

• setRevisionNumber

  void setRevisionNumber(String value)

  Sets the revision number of the document.

  Use this property to store the revision number in the built-in document properties.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setRevisionNumber("5");
   

  Parameters:

  value - The revision number of the document.

• getTemplate

  String getTemplate()

  Gets the informational name of the document template.

  Use this property to retrieve the template name stored in the built-in document properties.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setTemplate("Quarterly Report Template");
   String template = properties.getTemplate();
   

  Returns:

  The informational name of the document template.

• setTemplate

  void setTemplate(String value)

  Sets the informational name of the document template.

  Use this property to set the template name stored in the built-in document properties.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setTemplate("Quarterly Report Template");
   

  Parameters:

  value - The informational name of the document template.

• getTitle

  String getTitle()

  Gets the title of the document.

  This method returns the value of the built-in Title document property.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setTitle("Quarterly Sales Report");
   String title = properties.getTitle();
   

  Returns:

  The title of the document.

• setTitle

  void setTitle(String value)

  Sets the title of the document.

  This method Sets the value of the built-in Title document property.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setTitle("Quarterly Sales Report");
   

  Parameters:

  value - The title of the document.

• getTotalEditingTime

  int getTotalEditingTime()

  Gets the total editing time in minutes.

  This property stores the cumulative editing time recorded for the document.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setTotalEditingTime(90);
   int totalEditingTime = properties.getTotalEditingTime();
   

  Returns:

  The total editing time, in minutes.

• setTotalEditingTime

  void setTotalEditingTime(int value)

  Sets the total editing time in minutes.

  This property stores the cumulative editing time recorded for the document.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setTotalEditingTime(90);
   

  Parameters:

  value - The total editing time, in minutes.

• getDocumentVersion

  String getDocumentVersion()

  Gets the version of the file.

  This property represents the built-in document version stored in the workbook.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setDocumentVersion("2.1");
   String documentVersion = properties.getDocumentVersion();
   

  Returns:

  The document version of the file.

• setDocumentVersion

  void setDocumentVersion(String value)

  Sets the version of the file.

  This property represents the built-in document version stored in the workbook.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setDocumentVersion("2.1");
   

  Parameters:

  value - The document version of the file.

• getScaleCrop

  boolean getScaleCrop()

  Gets the display mode of the document thumbnail.

  Use this property to determine whether the document thumbnail is displayed with scale-crop mode.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setScaleCrop(true);
   boolean scaleCrop = properties.getScaleCrop();
   

  Returns:

  true if the document thumbnail uses scale-crop mode; otherwise, false.

• setScaleCrop

  void setScaleCrop(boolean value)

  Sets the display mode of the document thumbnail.

  Use this property to set whether the document thumbnail is displayed with scale-crop mode.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setScaleCrop(true);
   

  Parameters:

  value - true if the document thumbnail uses scale-crop mode; otherwise, false.

• getSubject

  String getSubject()

  Gets the subject of the document.

  Use this method to retrieve the built-in subject property from the document metadata.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setSubject("Quarterly Sales Report");
   String subject = properties.getSubject();
   

  Returns:

  The subject of the document.

• setSubject

  void setSubject(String value)

  Sets the subject of the document.

  Use this method to set the built-in subject property from the document metadata.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setSubject("Quarterly Sales Report");
   

  Parameters:

  value - The subject of the document.

• getLastSavedTime

  Calendar getLastSavedTime()

  Gets the time of the last save in the local time zone.

  This property is not automatically updated when the document is modified. Use setLastSavedTime(Calendar) to change the stored value.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   Calendar lastSavedTime = Calendar.getInstance();
   lastSavedTime.set(2024, Calendar.JANUARY, 15, 10, 30, 0);
   properties.setLastSavedTime(lastSavedTime);
   Calendar savedTime = properties.getLastSavedTime();
   

  Returns:

  The time of the last save in the local time zone.

• setLastSavedTime

  void setLastSavedTime(Calendar value)

  Sets the time when the document was last saved in the local time zone.

  Use this method to assign a built-in document property value explicitly.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   Calendar lastSavedTime = Calendar.getInstance();
   lastSavedTime.set(2024, Calendar.JANUARY, 15, 10, 30, 0);
   properties.setLastSavedTime(lastSavedTime);
   

  Parameters:

  value - The last saved time in the local time zone. null is allowed.

• getLastSavedBy

  String getLastSavedBy()

  Gets the name of the author who last saved the document.

  This property is not automatically updated when the document is modified.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setLastSavedBy("Author");
   String lastSavedBy = properties.getLastSavedBy();
   

  Returns:

  The name of the author who last saved the document.

• setLastSavedBy

  void setLastSavedBy(String value)

  Sets the name of the author who last saved the document.

  This property is not automatically updated when the document is modified.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setLastSavedBy("Author");
   

  Parameters:

  value - The name of the author who last saved the document.

• getLastPrinted

  Calendar getLastPrinted()

  Gets the UTC time when the document was last printed.

  Use setLastPrinted(Calendar) to store the last printed time in the built-in document properties before reading it back.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   Calendar lastPrinted = Calendar.getInstance();
   lastPrinted.set(2024, Calendar.JANUARY, 15, 10, 30, 0);
   properties.setLastPrinted(lastPrinted);
   Calendar printedTime = properties.getLastPrinted();
   

  Returns:

  The UTC time when the document was last printed.

• setLastPrinted

  void setLastPrinted(Calendar value)

  Sets the UTC time when the document was last printed.

  Use this method to store the last printed timestamp in the built-in document properties.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   Calendar lastPrinted = new GregorianCalendar(TimeZone.getTimeZone("UTC"));
   lastPrinted.set(2024, Calendar.JANUARY, 15, 9, 30, 0);
   properties.setLastPrinted(lastPrinted);
   

  Parameters:

  value - The UTC time when the document was last printed.

• getLanguage

  String getLanguage()

  Gets the document language.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setLanguage("en-US");
   String language = properties.getLanguage();
   

  Returns:

  The document language.

• setLanguage

  void setLanguage(String value)

  Sets the document language.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setLanguage("en-US");
   

  Parameters:

  value - The document language.

• getAuthor

  String getAuthor()

  Gets the name of the document's author.

  Use setAuthor(String) to assign the author name before retrieving it.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setAuthor("Author");
   String author = properties.getAuthor();
   

  Returns:

  The name of the document's author.

• setAuthor

  void setAuthor(String value)

  Sets the name of the document's author.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setAuthor("Author");
   

  Parameters:

  value - The name of the document's author.

• getComments

  String getComments()

  Gets the document comments.

  Use this property to retrieve the built-in document metadata that stores descriptive comments for the workbook. To assign a value, use setComments(String).

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setComments("Quarterly sales report for internal review.");
   String comments = properties.getComments();
   

  Returns:

  The document comments, or null if no comments have been set.

• setComments

  void setComments(String value)

  Sets the document comments.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setComments("Quarterly sales report for internal review.");
   

  Parameters:

  value - The document comments. This value can be null.

• getCategory

  String getCategory()

  Gets the category of the document.

  Use this property to retrieve the built-in document metadata that stores the workbook category. To assign a value, use setCategory(String).

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setCategory("Finance");
   String category = properties.getCategory();
   

  Returns:

  The category of the document.

• setCategory

  void setCategory(String value)

  Sets the category of the document.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setCategory("Finance");
   

  Parameters:

  value - The category of the document.

• getContentType

  String getContentType()

  Gets the content type of the document.

  Use this property to retrieve the built-in document metadata that describes the document's content type. To assign a value, use setContentType(String).

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setContentType("Monthly Report");
   String contentType = properties.getContentType();
   

  Returns:

  The content type of the document.

• setContentType

  void setContentType(String value)

  Sets the content type of the document.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setContentType("Monthly Report");
   

  Parameters:

  value - The content type of the document.

• getContentStatus

  String getContentStatus()

  Gets the content status of the document.

  Use this property to read the built-in content status stored in the document properties collection returned by Workbook.getBuiltInDocumentProperties(). To update the value, use setContentStatus(String).

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setContentStatus("Final");
   String contentStatus = properties.getContentStatus();
   

  Returns:

  The content status of the document.

• setContentStatus

  void setContentStatus(String value)

  Sets the content status of the document.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setContentStatus("Final");
   

  Parameters:

  value - The content status of the document.

• getCompany

  String getCompany()

  Gets the company property.

  Use this property to retrieve the company information stored in the workbook's built-in document properties.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setCompany("Example");
   String company = properties.getCompany();
   

  Returns:

  The company property value. Returns null if the company property is not set.

• setCompany

  void setCompany(String value)

  Sets the company property.

  Use this property to set the company information stored in the workbook's built-in document properties.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setCompany("Example");
   

  Parameters:

  value - The company property value. This value can be null.

• getHyperlinkBase

  String getHyperlinkBase()

  Gets the hyperlink base property.

  This property stores the base path or URL used for hyperlinks in the document.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setHyperlinkBasey("https://www.example.com/docs/");
   String hyperlinkBase = properties.getHyperlinkBase();
   

  Returns:

  The hyperlink base property value.

• setHyperlinkBasey

  void setHyperlinkBasey(String value)

  Sets the hyperlink base property.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setHyperlinkBasey("https://example.com/docs/");
   

  Parameters:

  value - The hyperlink base property value.

• getCreatedDate

  Calendar getCreatedDate()

  Gets the document creation date in the local time zone.

  This property is not updated automatically when the document is modified.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   Calendar createdDateValue = new GregorianCalendar(2024, Calendar.JANUARY, 15, 10, 30, 0);
   properties.setCreatedDate(createdDateValue);
   Calendar createdDate = properties.getCreatedDate();
   

  Returns:

  The document creation date in the local time zone.

• setCreatedDate

  void setCreatedDate(Calendar value)

  Sets the document creation date in the local time zone.

  Use this method to store the built-in created date property for the workbook.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   Calendar createdDate = new GregorianCalendar(2024, Calendar.JANUARY, 15, 9, 30, 0);
   properties.setCreatedDate(createdDate);
   

  Parameters:

  value - The document creation date in the local time zone. null is allowed if no created date is specified.

• getKeywords

  String getKeywords()

  Gets the document keywords.

  Returns the keywords stored in the built-in document properties.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setKeywords("Budget, Forecast, Sales");
   String keywords = properties.getKeywords();
   

  Returns:

  The document keywords.

• setKeywords

  void setKeywords(String value)

  Sets the document keywords.

  Sets the keywords stored in the built-in document properties.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setKeywords("Budget, Forecast, Sales");
   

  Parameters:

  value - The document keywords.

• getLinksUpToDate

  boolean getLinksUpToDate()

  Gets whether hyperlinks in the document are up to date.

  This built-in document property indicates whether the document's hyperlink information is marked as current.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setLinksUpToDate(true);
   boolean linksUpToDate = properties.getLinksUpToDate();
   

  Returns:

  true if the document's hyperlinks are marked as up to date; otherwise, false.

• setLinksUpToDate

  void setLinksUpToDate(boolean value)

  Sets whether hyperlinks in the document are up to date.

  This built-in document property indicates whether the document's hyperlink information is marked as current.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setLinksUpToDate(true);
   

  Parameters:

  value - true if the document's hyperlinks are marked as up to date; otherwise, false.

• getWords

  int getWords()

  Gets an estimate of the number of words in the document.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setWords(320);
   int words = properties.getWords();
   

  Returns:

  The estimated number of words in the document.

• setWords

  void setWords(int value)

  Sets an estimate of the number of words in the document.

  
   IBuiltInDocumentPropertyCollection properties = workbook.getBuiltInDocumentProperties();
   properties.setWords(320);
   

  Parameters:

  value - The estimated number of words in the document.