Home  Products  Purchase  Downloads  Demos  Forums  Blogs  Ticket  Wiki  API  Corporate


com.aspose.cells
Class BuiltInDocumentProperties

java.lang.Object
  extended by com.aspose.cells.BuiltInDocumentProperties
All Implemented Interfaces:
java.lang.Cloneable, java.lang.Iterable<DocumentProperty>

public class BuiltInDocumentProperties
extends java.lang.Object
implements java.lang.Iterable<DocumentProperty>, java.lang.Cloneable

Represents a collection of built-in document properties. Provides access to objects by their names (using an indexer) and via a set of typed properties that return values of appropriate types.


Method Summary
 DocumentProperty get(int index)
          Gets a DocumentProperty object by index.
 DocumentProperty get(java.lang.String name)
          Gets a DocumentProperty object by the name of the property.
 java.lang.String getAuthor()
          Gets the name of the document's author.
 int getBytes()
          Gets an estimate of the number of bytes in the excel file.
 java.lang.String getCategory()
          Gets the category of the document.
 int getCharacters()
          Gets an estimate of the number of characters in the excel file.
 int getCharactersWithSpaces()
          Gets an estimate of the number of characters (including spaces) in the excel file.
 java.lang.String getComments()
          Gets the document comments.
 java.lang.String getCompany()
          Gets the company property.
 java.lang.String getContentStatus()
          Gets the status of the document.
 java.lang.String getContentType()
          Gets the content type of the document.
 int getCount()
          Gets number of items in the collection.
 java.util.Date getCreatedTime()
          Gets date of the document creation in UTC.
 java.lang.String getDocumentVersion()
          Gets the status of the document.
 java.lang.String getKeywords()
          Gets the document keywords.
 java.lang.String getLanguage()
          Gets the Language of the document.
 java.util.Date getLastPrinted()
          Gets the date when the document was last printed in UTC.
 java.lang.String getLastSavedBy()
          Gets the name of the last author.
 java.util.Date getLastSavedTime()
          Gets the time of the last save in UTC.
 int getLines()
          Gets an estimate of the number of lines in the document.
 java.lang.String getManager()
          Gets the manager property.
 java.lang.String getNameOfApplication()
          Gets the name of the application.
 int getPages()
          Gets an estimate of the number of pages in the document.
 int getParagraphs()
          Gets an estimate of the number of paragraphs in the document.
 int getRevisionNumber()
          Gets the document revision number.
 java.lang.String getSubject()
          Gets the subject of the document.
 java.lang.String getTemplate()
          Gets the informational name of the document template.
 java.lang.String getTitle()
          Gets the title of the document.
 double getTotalEditingTime()
          Gets the total editing time in minutes.
 int getVersion()
          Gets the version number of the application that created the document.
 int getWords()
          Gets an estimate of the number of words in the document.
 java.util.Iterator<DocumentProperty> iterator()
          Returns an DocumentProperty iterator.
 void setAuthor(java.lang.String value)
          Gets or sets the name of the document's author.
 void setBytes(int value)
          Sets an estimate of the number of bytes in the excel file.
 void setCategory(java.lang.String value)
          Sets the category of the document.
 void setCharacters(int value)
          Sets an estimate of the number of characters in the excel file.
 void setCharactersWithSpaces(int value)
          Sets an estimate of the number of characters (including spaces) in the excel file.
 void setComments(java.lang.String value)
          Sets the document comments.
 void setCompany(java.lang.String value)
          Sets the company property.
 void setContentStatus(java.lang.String value)
          Sets the status of the document.
 void setContentType(java.lang.String value)
          Sets the content type of the document.
 void setCreatedTime(java.util.Date value)
          Sets date of the document creation in UTC.
 void setDocumentVersion(java.lang.String value)
          Sets the version of the document.
 void setKeywords(java.lang.String value)
          Sets the document keywords.
 void setLanguage(java.lang.String value)
          Sets the Language of the document.
 void setLastPrinted(java.util.Date value)
          Sets the date when the document was last printed in UTC.
 void setLastSavedBy(java.lang.String value)
          Sets the name of the last author.
 void setLastSavedTime(java.util.Date value)
          Sets the time of the last save in UTC.
 void setLines(int value)
          Sets an estimate of the number of lines in the document.
 void setManager(java.lang.String value)
          Gets the manager property.
 void setNameOfApplication(java.lang.String value)
          Sets the name of the application.
 void setPages(int value)
          Represents an estimate of the number of pages in the document.
 void setParagraphs(int value)
          Sets an estimate of the number of paragraphs in the document.
 void setRevisionNumber(int value)
          Sets the document revision number.
 void setSubject(java.lang.String value)
          Sets the subject of the document.
 void setTemplate(java.lang.String value)
          Sets the informational name of the document template.
 void setTitle(java.lang.String value)
          Sets the title of the document.
 void setTotalEditingTime(double value)
          Sets the total editing time in minutes.
 void setVersion(int value)
          Sets the version number of the application that created the document.
 void setWords(int value)
          Represents an estimate of the number of words in the document.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getCount

public int getCount()
Gets number of items in the collection.


get

public DocumentProperty get(java.lang.String name)
                     throws java.lang.Exception
Gets a DocumentProperty object by the name of the property. The string names of the properties correspond to the names of the typed properties available from BuiltInDocumentProperties. If you request a property that is not present in the document, but the name of the property is recognized as a valid built-in name, a new DocumentProperty Object is created, added to the collection and returned. The newly created property is assigned a default value (empty string, zero, false or DateTime.MinValue depending on the type of the built-in property). If you request a property that is not present in the document and the name is not recognized as a built-in name, a null is returned.

Parameters:
name - The case-sensitive name of the property to retrieve.
Returns:
a DocumentProperty object
Throws:
java.lang.Exception

get

public DocumentProperty get(int index)
Gets a DocumentProperty object by index.

Parameters:
index - Zero-based index of the DocumentProperty to return.
Returns:
a DocumentProperty object.

getAuthor

public java.lang.String getAuthor()
                           throws java.lang.Exception
Gets the name of the document's author.

Returns:
the name of the document's author.
Throws:
java.lang.Exception

setAuthor

public void setAuthor(java.lang.String value)
               throws java.lang.Exception
Gets or sets the name of the document's author.

Parameters:
value - the name of the document's author.
Throws:
java.lang.Exception

getBytes

public int getBytes()
             throws java.lang.Exception
Gets an estimate of the number of bytes in the excel file.

Returns:
an estimate of the number of bytes in the excel file.
Throws:
java.lang.Exception

setBytes

public void setBytes(int value)
              throws java.lang.Exception
Sets an estimate of the number of bytes in the excel file. Aspose.Cells does not update this property when you modify the excel file.

Parameters:
value - an estimate of the number of bytes in the excel file.
Throws:
java.lang.Exception

getCharacters

public int getCharacters()
                  throws java.lang.Exception
Gets an estimate of the number of characters in the excel file.

Returns:
an estimate of the number of characters in the excel file.
Throws:
java.lang.Exception

setCharacters

public void setCharacters(int value)
                   throws java.lang.Exception
Sets an estimate of the number of characters in the excel file.

Parameters:
value - an estimate of the number of characters in the excel file.
Throws:
java.lang.Exception

getCharactersWithSpaces

public int getCharactersWithSpaces()
                            throws java.lang.Exception
Gets an estimate of the number of characters (including spaces) in the excel file.

Returns:
an estimate of the number of characters (including spaces) in the excel file.
Throws:
java.lang.Exception

setCharactersWithSpaces

public void setCharactersWithSpaces(int value)
                             throws java.lang.Exception
Sets an estimate of the number of characters (including spaces) in the excel file.

Parameters:
value - an estimate of the number of characters (including spaces) in the excel file.
Throws:
java.lang.Exception

getComments

public java.lang.String getComments()
                             throws java.lang.Exception
Gets the document comments.

Returns:
the document comments.
Throws:
java.lang.Exception

setComments

public void setComments(java.lang.String value)
                 throws java.lang.Exception
Sets the document comments.

Parameters:
value - the document comments.
Throws:
java.lang.Exception

getCategory

public java.lang.String getCategory()
                             throws java.lang.Exception
Gets the category of the document.

Returns:
the category of the document.
Throws:
java.lang.Exception

setCategory

public void setCategory(java.lang.String value)
                 throws java.lang.Exception
Sets the category of the document.

Parameters:
value - the category of the document.
Throws:
java.lang.Exception

getCompany

public java.lang.String getCompany()
                            throws java.lang.Exception
Gets the company property.

Returns:
the company property.
Throws:
java.lang.Exception

setCompany

public void setCompany(java.lang.String value)
                throws java.lang.Exception
Sets the company property.

Parameters:
value - the company property.
Throws:
java.lang.Exception

getCreatedTime

public java.util.Date getCreatedTime()
                              throws java.lang.Exception
Gets date of the document creation in UTC.

Returns:
date of the document creation in UTC.
Throws:
java.lang.Exception

setCreatedTime

public void setCreatedTime(java.util.Date value)
                    throws java.lang.Exception
Sets date of the document creation in UTC. Aspose.Cells does not update this property when you modify the document.

Parameters:
value - date of the document creation in UTC.
Throws:
java.lang.Exception

getKeywords

public java.lang.String getKeywords()
                             throws java.lang.Exception
Gets the document keywords.

Returns:
the document keywords.
Throws:
java.lang.Exception

setKeywords

public void setKeywords(java.lang.String value)
                 throws java.lang.Exception
Sets the document keywords.

Parameters:
value - the document keywords.
Throws:
java.lang.Exception

getLastPrinted

public java.util.Date getLastPrinted()
                              throws java.lang.Exception
Gets the date when the document was last printed in UTC.

Returns:
the date when the document was last printed in UTC.
Throws:
java.lang.Exception

setLastPrinted

public void setLastPrinted(java.util.Date value)
                    throws java.lang.Exception
Sets the date when the document was last printed in UTC. If the document was never printed, this property will return DateTime.MinValue.

Parameters:
value - the date when the document was last printed in UTC.
Throws:
java.lang.Exception

getLastSavedBy

public java.lang.String getLastSavedBy()
                                throws java.lang.Exception
Gets the name of the last author.

Returns:
the name of the last author.
Throws:
java.lang.Exception

setLastSavedBy

public void setLastSavedBy(java.lang.String value)
                    throws java.lang.Exception
Sets the name of the last author. Aspose.Cells does not update this property when you modify the document.

Parameters:
value - the name of the last author.
Throws:
java.lang.Exception

getLastSavedTime

public java.util.Date getLastSavedTime()
                                throws java.lang.Exception
Gets the time of the last save in UTC.

Returns:
the time of the last save in UTC.
Throws:
java.lang.Exception

setLastSavedTime

public void setLastSavedTime(java.util.Date value)
                      throws java.lang.Exception
Sets the time of the last save in UTC. Aspose.Cells does not update this property when you modify the document.

Parameters:
value - the time of the last save in UTC.
Throws:
java.lang.Exception

getLines

public int getLines()
             throws java.lang.Exception
Gets an estimate of the number of lines in the document.

Returns:
an estimate of the number of lines in the document.
Throws:
java.lang.Exception

setLines

public void setLines(int value)
              throws java.lang.Exception
Sets an estimate of the number of lines in the document. Aspose.Cells does not update this property when you modify the document.

Parameters:
value - an estimate of the number of lines in the document.
Throws:
java.lang.Exception

getManager

public java.lang.String getManager()
                            throws java.lang.Exception
Gets the manager property.

Returns:
the manager property.
Throws:
java.lang.Exception

setManager

public void setManager(java.lang.String value)
                throws java.lang.Exception
Gets the manager property.

Parameters:
value - the manager property.
Throws:
java.lang.Exception

getNameOfApplication

public java.lang.String getNameOfApplication()
                                      throws java.lang.Exception
Gets the name of the application.

Returns:
the name of the application.
Throws:
java.lang.Exception

setNameOfApplication

public void setNameOfApplication(java.lang.String value)
                          throws java.lang.Exception
Sets the name of the application.

Parameters:
value - the name of the application.
Throws:
java.lang.Exception

getPages

public int getPages()
             throws java.lang.Exception
Gets an estimate of the number of pages in the document.

Returns:
an estimate of the number of pages in the document.
Throws:
java.lang.Exception

setPages

public void setPages(int value)
              throws java.lang.Exception
Represents an estimate of the number of pages in the document. Aspose.Cells does not update this property when you modify the document.

Parameters:
value - an estimate of the number of pages in the document.
Throws:
java.lang.Exception

getParagraphs

public int getParagraphs()
                  throws java.lang.Exception
Gets an estimate of the number of paragraphs in the document.

Returns:
an estimate of the number of paragraphs in the document.
Throws:
java.lang.Exception

setParagraphs

public void setParagraphs(int value)
                   throws java.lang.Exception
Sets an estimate of the number of paragraphs in the document.

Parameters:
value - an estimate of the number of paragraphs in the document.
Throws:
java.lang.Exception

getRevisionNumber

public int getRevisionNumber()
                      throws java.lang.Exception
Gets the document revision number.

Returns:
the document revision number.
Throws:
java.lang.Exception

setRevisionNumber

public void setRevisionNumber(int value)
                       throws java.lang.Exception
Sets the document revision number. Aspose.Cells does not update this property when you modify the document.

Parameters:
value - the document revision number.
Throws:
java.lang.Exception

getSubject

public java.lang.String getSubject()
                            throws java.lang.Exception
Gets the subject of the document.

Returns:
the subject of the document.
Throws:
java.lang.Exception

setSubject

public void setSubject(java.lang.String value)
                throws java.lang.Exception
Sets the subject of the document.

Parameters:
value - the subject of the document.
Throws:
java.lang.Exception

getTemplate

public java.lang.String getTemplate()
                             throws java.lang.Exception
Gets the informational name of the document template.

Returns:
the informational name of the document template.
Throws:
java.lang.Exception

setTemplate

public void setTemplate(java.lang.String value)
                 throws java.lang.Exception
Sets the informational name of the document template.

Parameters:
value - the informational name of the document template.
Throws:
java.lang.Exception

getTitle

public java.lang.String getTitle()
                          throws java.lang.Exception
Gets the title of the document.

Returns:
the title of the document.
Throws:
java.lang.Exception

setTitle

public void setTitle(java.lang.String value)
              throws java.lang.Exception
Sets the title of the document.

Parameters:
value - the title of the document.
Throws:
java.lang.Exception

getTotalEditingTime

public double getTotalEditingTime()
                           throws java.lang.Exception
Gets the total editing time in minutes.

Returns:
the total editing time in minutes.
Throws:
java.lang.Exception

setTotalEditingTime

public void setTotalEditingTime(double value)
                         throws java.lang.Exception
Sets the total editing time in minutes.

Parameters:
value - the total editing time in minutes.
Throws:
java.lang.Exception

getVersion

public int getVersion()
               throws java.lang.Exception
Gets the version number of the application that created the document.

Returns:
the version number of the application that created the document.
Throws:
java.lang.Exception

setVersion

public void setVersion(int value)
                throws java.lang.Exception
Sets the version number of the application that created the document.

Parameters:
value - the version number of the application that created the document.
Throws:
java.lang.Exception

getWords

public int getWords()
             throws java.lang.Exception
Gets an estimate of the number of words in the document.

Returns:
an estimate of the number of words in the document.
Throws:
java.lang.Exception

setWords

public void setWords(int value)
              throws java.lang.Exception
Represents an estimate of the number of words in the document.

Parameters:
value - an estimate of the number of words in the document.
Throws:
java.lang.Exception

getContentType

public java.lang.String getContentType()
                                throws java.lang.Exception
Gets the content type of the document.

Returns:
the content type of the document.
Throws:
java.lang.Exception

setContentType

public void setContentType(java.lang.String value)
                    throws java.lang.Exception
Sets the content type of the document.

Parameters:
value - the content type of the document.
Throws:
java.lang.Exception

getContentStatus

public java.lang.String getContentStatus()
                                  throws java.lang.Exception
Gets the status of the document.

Returns:
the status of the document.
Throws:
java.lang.Exception

setContentStatus

public void setContentStatus(java.lang.String value)
                      throws java.lang.Exception
Sets the status of the document.

Parameters:
value - the status of the document.
Throws:
java.lang.Exception

getLanguage

public java.lang.String getLanguage()
                             throws java.lang.Exception
Gets the Language of the document.

Returns:
the Language of the document.
Throws:
java.lang.Exception

setLanguage

public void setLanguage(java.lang.String value)
                 throws java.lang.Exception
Sets the Language of the document.

Parameters:
value - the Language of the document.
Throws:
java.lang.Exception

getDocumentVersion

public java.lang.String getDocumentVersion()
                                    throws java.lang.Exception
Gets the status of the document.

Returns:
the status of the document.
Throws:
java.lang.Exception

setDocumentVersion

public void setDocumentVersion(java.lang.String value)
                        throws java.lang.Exception
Sets the version of the document.

Parameters:
value - the version of the document.
Throws:
java.lang.Exception

iterator

public java.util.Iterator<DocumentProperty> iterator()
Returns an DocumentProperty iterator.

Specified by:
iterator in interface java.lang.Iterable<DocumentProperty>