com.aspose.cells

com.aspose.cells

Class BuiltInDocumentPropertyCollection

  • All Implemented Interfaces:
    java.lang.Iterable
    public class BuiltInDocumentPropertyCollection 
    extends DocumentPropertyCollection

A collection of built-in document properties.

Provides access to DocumentProperty objects by their names (using an indexer) and via a set of typed properties that return values of appropriate types.

Property Getters/Setters Summary
java.lang.StringgetAuthor()
void
setAuthor(java.lang.Stringvalue)
           Gets or sets the name of the document's author.
intgetBytes()
void
setBytes(intvalue)
           Represents an estimate of the number of bytes in the document.
java.lang.StringgetCategory()
void
setCategory(java.lang.Stringvalue)
           Gets or sets the category of the document.
intgetCharacters()
void
setCharacters(intvalue)
           Represents an estimate of the number of characters in the document.
intgetCharactersWithSpaces()
void
setCharactersWithSpaces(intvalue)
           Represents an estimate of the number of characters (including spaces) in the document.
java.lang.StringgetComments()
void
setComments(java.lang.Stringvalue)
           Gets or sets the document comments.
java.lang.StringgetCompany()
void
setCompany(java.lang.Stringvalue)
           Gets or sets the company property.
java.lang.StringgetContentStatus()
void
setContentStatus(java.lang.Stringvalue)
           Gets or sets the content status of the document.
java.lang.StringgetContentType()
void
setContentType(java.lang.Stringvalue)
           Gets or sets the content type of the document.
intgetCount()
Gets number of items in the collection.
com.aspose.cells.DateTimegetCreatedTime()
void
setCreatedTime(com.aspose.cells.DateTimevalue)
           Gets or sets date of the document creation in local timezone.
com.aspose.cells.DateTimegetCreatedUniversalTime()
void
setCreatedUniversalTime(com.aspose.cells.DateTimevalue)
           Gets or sets the Universal time of the document creation.
java.lang.StringgetDocumentVersion()
void
setDocumentVersion(java.lang.Stringvalue)
           Represents the version of the file.
java.lang.StringgetHyperlinkBase()
void
setHyperlinkBase(java.lang.Stringvalue)
           Gets or sets the hyperlinkbase property.
java.lang.StringgetKeywords()
void
setKeywords(java.lang.Stringvalue)
           Gets or sets the document keywords.
java.lang.StringgetLanguage()
void
setLanguage(java.lang.Stringvalue)
           Gets or sets the document's language.
com.aspose.cells.DateTimegetLastPrinted()
void
setLastPrinted(com.aspose.cells.DateTimevalue)
           Gets or sets the date when the document was last printed in local timezone.
com.aspose.cells.DateTimegetLastPrintedUniversalTime()
void
setLastPrintedUniversalTime(com.aspose.cells.DateTimevalue)
           Gets or sets the Universal time when the document was last printed.
java.lang.StringgetLastSavedBy()
void
setLastSavedBy(java.lang.Stringvalue)
           Gets or sets the name of the last author.
com.aspose.cells.DateTimegetLastSavedTime()
void
setLastSavedTime(com.aspose.cells.DateTimevalue)
           Gets or sets the time of the last save in local timezone.
com.aspose.cells.DateTimegetLastSavedUniversalTime()
void
setLastSavedUniversalTime(com.aspose.cells.DateTimevalue)
           Gets or sets the universal time of the last save.
intgetLines()
void
setLines(intvalue)
           Represents an estimate of the number of lines in the document.
booleangetLinksUpToDate()
void
setLinksUpToDate(booleanvalue)
           Indicates whether hyperlinks in a document are up-to-date.
java.lang.StringgetManager()
void
setManager(java.lang.Stringvalue)
           Gets or sets the manager property.
java.lang.StringgetNameOfApplication()
void
setNameOfApplication(java.lang.Stringvalue)
           Gets or sets the name of the application.
intgetPages()
void
setPages(intvalue)
           Represents an estimate of the number of pages in the document.
intgetParagraphs()
void
setParagraphs(intvalue)
           Represents an estimate of the number of paragraphs in the document.
java.lang.StringgetRevision()
void
setRevision(java.lang.Stringvalue)
           Gets or sets the document revision number.
intgetRevisionNumber()
void
setRevisionNumber(intvalue)
           Gets or sets the document revision number.
booleangetScaleCrop()
void
setScaleCrop(booleanvalue)
           Indicates the display mode of the document thumbnail.
java.lang.StringgetSubject()
void
setSubject(java.lang.Stringvalue)
           Gets or sets the subject of the document.
java.lang.StringgetTemplate()
void
setTemplate(java.lang.Stringvalue)
           Gets or sets the informational name of the document template.
java.lang.StringgetTitle()
void
setTitle(java.lang.Stringvalue)
           Gets or sets the title of the document.
doublegetTotalEditingTime()
void
setTotalEditingTime(doublevalue)
           Gets or sets the total editing time in minutes.
java.lang.StringgetVersion()
void
setVersion(java.lang.Stringvalue)
           Represents the version number of the application that created the document.
intgetWords()
void
setWords(intvalue)
           Represents an estimate of the number of words in the document.
DocumentPropertyget(int index)
Returns a DocumentProperty object by index.
DocumentPropertyget(java.lang.String name)
Returns a DocumentProperty object by the name of the property.
 
Method Summary
voidclear()
Removes all properties from the collection.
booleancontains(java.lang.String name)
Returns true if a property with the specified name exists in the collection.
intindexOf(java.lang.String name)
Gets the index of a property by name.
java.util.Iteratoriterator()
voidremove(java.lang.String name)
Removes a property with the specified name from the collection.
voidremoveAt(int index)
Removes a property at the specified index.
 

    • Property Getters/Setters Detail

      • getLanguage/setLanguage

        public java.lang.String getLanguage() / public void setLanguage(java.lang.String value)
        Gets or sets the document's language.

      • getAuthor/setAuthor

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

      • getBytes/setBytes

        public int getBytes() / public void setBytes(int value)
        Represents an estimate of the number of bytes in the document.

      • getCharacters/setCharacters

        public int getCharacters() / public void setCharacters(int value)
        Represents an estimate of the number of characters in the document.

      • getCharactersWithSpaces/setCharactersWithSpaces

        public int getCharactersWithSpaces() / public void setCharactersWithSpaces(int value)
        Represents an estimate of the number of characters (including spaces) in the document.

      • getComments/setComments

        public java.lang.String getComments() / public void setComments(java.lang.String value)
        Gets or sets the document comments.

      • getCategory/setCategory

        public java.lang.String getCategory() / public void setCategory(java.lang.String value)
        Gets or sets the category of the document.

      • getContentType/setContentType

        public java.lang.String getContentType() / public void setContentType(java.lang.String value)
        Gets or sets the content type of the document.

      • getContentStatus/setContentStatus

        public java.lang.String getContentStatus() / public void setContentStatus(java.lang.String value)
        Gets or sets the content status of the document.

      • getCompany/setCompany

        public java.lang.String getCompany() / public void setCompany(java.lang.String value)
        Gets or sets the company property.

      • getHyperlinkBase/setHyperlinkBase

        public java.lang.String getHyperlinkBase() / public void setHyperlinkBase(java.lang.String value)
        Gets or sets the hyperlinkbase property.

      • getCreatedTime/setCreatedTime

        public com.aspose.cells.DateTime getCreatedTime() / public void setCreatedTime(com.aspose.cells.DateTime value)
        Gets or sets date of the document creation in local timezone.

        Aspose.Cells does not update this property when you modify the document.

      • getCreatedUniversalTime/setCreatedUniversalTime

        public com.aspose.cells.DateTime getCreatedUniversalTime() / public void setCreatedUniversalTime(com.aspose.cells.DateTime value)
        Gets or sets the Universal time of the document creation.

        Aspose.Cells does not update this property when you modify the document.

      • getKeywords/setKeywords

        public java.lang.String getKeywords() / public void setKeywords(java.lang.String value)
        Gets or sets the document keywords.

      • getLastPrinted/setLastPrinted

        public com.aspose.cells.DateTime getLastPrinted() / public void setLastPrinted(com.aspose.cells.DateTime value)
        Gets or sets the date when the document was last printed in local timezone.

        If the document was never printed, this property will return DateTime.MinValue.

        Aspose.Cells does not update this property when you modify the document.

      • getLastPrintedUniversalTime/setLastPrintedUniversalTime

        public com.aspose.cells.DateTime getLastPrintedUniversalTime() / public void setLastPrintedUniversalTime(com.aspose.cells.DateTime value)
        Gets or sets the Universal time when the document was last printed.

      • getLastSavedBy/setLastSavedBy

        public java.lang.String getLastSavedBy() / public void setLastSavedBy(java.lang.String value)
        Gets or sets the name of the last author.

        Aspose.Cells does not update this property when you modify the document.

      • getLastSavedTime/setLastSavedTime

        public com.aspose.cells.DateTime getLastSavedTime() / public void setLastSavedTime(com.aspose.cells.DateTime value)
        Gets or sets the time of the last save in local timezone.

        Aspose.Cells does not update this property when you modify the document.

      • getLastSavedUniversalTime/setLastSavedUniversalTime

        public com.aspose.cells.DateTime getLastSavedUniversalTime() / public void setLastSavedUniversalTime(com.aspose.cells.DateTime value)
        Gets or sets the universal time of the last save.

        Aspose.Cells does not update this property when you modify the document.

      • getLines/setLines

        public int getLines() / public void setLines(int value)
        Represents an estimate of the number of lines in the document.

        Aspose.Cells does not update this property when you modify the document.

      • getManager/setManager

        public java.lang.String getManager() / public void setManager(java.lang.String value)
        Gets or sets the manager property.

      • getNameOfApplication/setNameOfApplication

        public java.lang.String getNameOfApplication() / public void setNameOfApplication(java.lang.String value)
        Gets or sets the name of the application.

      • getPages/setPages

        public int getPages() / public void setPages(int value)
        Represents an estimate of the number of pages in the document.

      • getParagraphs/setParagraphs

        public int getParagraphs() / public void setParagraphs(int value)
        Represents an estimate of the number of paragraphs in the document.

      • getRevisionNumber/setRevisionNumber

        public int getRevisionNumber() / public void setRevisionNumber(int value)
        Gets or sets the document revision number.

        Aspose.Cells does not update this property when you modify the document.

        NOTE: This property is now obsolete. Instead, please use BuiltInDocumentPropertyCollection.Revision propery, this property will be removed 12 months later since February 2017. Aspose apologizes for any inconvenience you may have experienced.

      • getRevision/setRevision

        public java.lang.String getRevision() / public void setRevision(java.lang.String value)
        Gets or sets the document revision number.

        Aspose.Cells does not update this property when you modify the document.

      • getSubject/setSubject

        public java.lang.String getSubject() / public void setSubject(java.lang.String value)
        Gets or sets the subject of the document.

      • getTemplate/setTemplate

        public java.lang.String getTemplate() / public void setTemplate(java.lang.String value)
        Gets or sets the informational name of the document template.

      • getTitle/setTitle

        public java.lang.String getTitle() / public void setTitle(java.lang.String value)
        Gets or sets the title of the document.

      • getTotalEditingTime/setTotalEditingTime

        public double getTotalEditingTime() / public void setTotalEditingTime(double value)
        Gets or sets the total editing time in minutes.

      • getVersion/setVersion

        public java.lang.String getVersion() / public void setVersion(java.lang.String value)
        Represents the version number of the application that created the document. It's format is "00.0000",for example : 12.0000

      • getDocumentVersion/setDocumentVersion

        public java.lang.String getDocumentVersion() / public void setDocumentVersion(java.lang.String value)
        Represents the version of the file.

      • getScaleCrop/setScaleCrop

        public boolean getScaleCrop() / public void setScaleCrop(boolean value)
        Indicates the display mode of the document thumbnail.

      • getLinksUpToDate/setLinksUpToDate

        public boolean getLinksUpToDate() / public void setLinksUpToDate(boolean value)
        Indicates whether hyperlinks in a document are up-to-date.

      • getWords/setWords

        public int getWords() / public void setWords(int value)
        Represents an estimate of the number of words in the document.

      • getCount

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

      • get

        public DocumentProperty get(java.lang.String name)
        Returns 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 BuiltInDocumentPropertyCollection.

        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 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-insensitive name of the property to retrieve.

    setLanguage

    public voidsetLanguage(java.lang.Stringvalue)
    Gets or sets the document's language.

    setAuthor

    public voidsetAuthor(java.lang.Stringvalue)
    Gets or sets the name of the document's author.

    setBytes

    public voidsetBytes(intvalue)
    Represents an estimate of the number of bytes in the document.

    setCharacters

    public voidsetCharacters(intvalue)
    Represents an estimate of the number of characters in the document.

    setCharactersWithSpaces

    public voidsetCharactersWithSpaces(intvalue)
    Represents an estimate of the number of characters (including spaces) in the document.

    setComments

    public voidsetComments(java.lang.Stringvalue)
    Gets or sets the document comments.

    setCategory

    public voidsetCategory(java.lang.Stringvalue)
    Gets or sets the category of the document.

    setContentType

    public voidsetContentType(java.lang.Stringvalue)
    Gets or sets the content type of the document.

    setContentStatus

    public voidsetContentStatus(java.lang.Stringvalue)
    Gets or sets the content status of the document.

    setCompany

    public voidsetCompany(java.lang.Stringvalue)
    Gets or sets the company property.

    setHyperlinkBase

    public voidsetHyperlinkBase(java.lang.Stringvalue)
    Gets or sets the hyperlinkbase property.

    setCreatedTime

    public voidsetCreatedTime(com.aspose.cells.DateTimevalue)
    Gets or sets date of the document creation in local timezone.

    Aspose.Cells does not update this property when you modify the document.

    setCreatedUniversalTime

    public voidsetCreatedUniversalTime(com.aspose.cells.DateTimevalue)
    Gets or sets the Universal time of the document creation.

    Aspose.Cells does not update this property when you modify the document.

    setKeywords

    public voidsetKeywords(java.lang.Stringvalue)
    Gets or sets the document keywords.

    setLastPrinted

    public voidsetLastPrinted(com.aspose.cells.DateTimevalue)
    Gets or sets the date when the document was last printed in local timezone.

    If the document was never printed, this property will return DateTime.MinValue.

    Aspose.Cells does not update this property when you modify the document.

    setLastPrintedUniversalTime

    public voidsetLastPrintedUniversalTime(com.aspose.cells.DateTimevalue)
    Gets or sets the Universal time when the document was last printed.

    setLastSavedBy

    public voidsetLastSavedBy(java.lang.Stringvalue)
    Gets or sets the name of the last author.

    Aspose.Cells does not update this property when you modify the document.

    setLastSavedTime

    public voidsetLastSavedTime(com.aspose.cells.DateTimevalue)
    Gets or sets the time of the last save in local timezone.

    Aspose.Cells does not update this property when you modify the document.

    setLastSavedUniversalTime

    public voidsetLastSavedUniversalTime(com.aspose.cells.DateTimevalue)
    Gets or sets the universal time of the last save.

    Aspose.Cells does not update this property when you modify the document.

    setLines

    public voidsetLines(intvalue)
    Represents an estimate of the number of lines in the document.

    Aspose.Cells does not update this property when you modify the document.

    setManager

    public voidsetManager(java.lang.Stringvalue)
    Gets or sets the manager property.

    setNameOfApplication

    public voidsetNameOfApplication(java.lang.Stringvalue)
    Gets or sets the name of the application.

    setPages

    public voidsetPages(intvalue)
    Represents an estimate of the number of pages in the document.

    setParagraphs

    public voidsetParagraphs(intvalue)
    Represents an estimate of the number of paragraphs in the document.

    setRevisionNumber

    public voidsetRevisionNumber(intvalue)
    Gets or sets the document revision number.

    Aspose.Cells does not update this property when you modify the document.

    NOTE: This property is now obsolete. Instead, please use BuiltInDocumentPropertyCollection.Revision propery, this property will be removed 12 months later since February 2017. Aspose apologizes for any inconvenience you may have experienced.

    setRevision

    public voidsetRevision(java.lang.Stringvalue)
    Gets or sets the document revision number.

    Aspose.Cells does not update this property when you modify the document.

    setSubject

    public voidsetSubject(java.lang.Stringvalue)
    Gets or sets the subject of the document.

    setTemplate

    public voidsetTemplate(java.lang.Stringvalue)
    Gets or sets the informational name of the document template.

    setTitle

    public voidsetTitle(java.lang.Stringvalue)
    Gets or sets the title of the document.

    setTotalEditingTime

    public voidsetTotalEditingTime(doublevalue)
    Gets or sets the total editing time in minutes.

    setVersion

    public voidsetVersion(java.lang.Stringvalue)
    Represents the version number of the application that created the document. It's format is "00.0000",for example : 12.0000

    setDocumentVersion

    public voidsetDocumentVersion(java.lang.Stringvalue)
    Represents the version of the file.

    setScaleCrop

    public voidsetScaleCrop(booleanvalue)
    Indicates the display mode of the document thumbnail.

    setLinksUpToDate

    public voidsetLinksUpToDate(booleanvalue)
    Indicates whether hyperlinks in a document are up-to-date.

    setWords

    public voidsetWords(intvalue)
    Represents an estimate of the number of words in the document.

    • Method Detail

      • iterator

        public java.util.Iterator iterator()
        Returns:

      • contains

        public boolean contains(java.lang.String name)
        Returns true if a property with the specified name exists in the collection.
        Parameters:
        name - The case-insensitive name of the property.
        Returns:
        True if the property exists in the collection; false otherwise.

      • indexOf

        public int indexOf(java.lang.String name)
        Gets the index of a property by name.
        Parameters:
        name - The case-insensitive name of the property.
        Returns:
        The zero based index. Negative value if not found.

      • remove

        public void remove(java.lang.String name)
        Removes a property with the specified name from the collection.
        Parameters:
        name - The case-insensitive name of the property.

      • removeAt

        public void removeAt(int index)
        Removes a property at the specified index.
        Parameters:
        index - The zero based index.

      • clear

        public void clear()
        Removes all properties from the collection.