aspose.cells

Class BuiltInDocumentPropertyCollection

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
functiongetAuthor()
function
setAuthor(value)
           Gets or sets the name of the document's author.
functiongetBytes()
function
setBytes(value)
           Represents an estimate of the number of bytes in the document.
functiongetCategory()
function
           Gets or sets the category of the document.
functiongetCharacters()
function
           Represents an estimate of the number of characters in the document.
functiongetCharactersWithSpaces()
function
           Represents an estimate of the number of characters (including spaces) in the document.
functiongetComments()
function
           Gets or sets the document comments.
functiongetCompany()
function
setCompany(value)
           Gets or sets the company property.
functiongetContentStatus()
function
           Gets or sets the content status of the document.
functiongetContentType()
function
           Gets or sets the content type of the document.
functiongetCount()
Gets number of items in the collection.
functiongetCreatedTime()
function
           Gets or sets date of the document creation in local timezone.
functiongetCreatedUniversalTime()
function
           Gets or sets the Universal time of the document creation.
functiongetDocumentVersion()
function
           Represents the version of the file.
functiongetHyperlinkBase()
function
           Gets or sets the hyperlinkbase property.
functiongetKeywords()
function
           Gets or sets the document keywords.
functiongetLanguage()
function
           Gets or sets the document's language.
functiongetLastPrinted()
function
           Gets or sets the date when the document was last printed in local timezone.
functiongetLastPrintedUniversalTime()
function
           Gets or sets the Universal time when the document was last printed.
functiongetLastSavedBy()
function
           Gets or sets the name of the last author.
functiongetLastSavedTime()
function
           Gets or sets the time of the last save in local timezone.
functiongetLastSavedUniversalTime()
function
           Gets or sets the universal time of the last save.
functiongetLines()
function
setLines(value)
           Represents an estimate of the number of lines in the document.
functiongetLinksUpToDate()
function
           Indicates whether hyperlinks in a document are up-to-date.
functiongetManager()
function
setManager(value)
           Gets or sets the manager property.
functiongetNameOfApplication()
function
           Gets or sets the name of the application.
functiongetPages()
function
setPages(value)
           Represents an estimate of the number of pages in the document.
functiongetParagraphs()
function
           Represents an estimate of the number of paragraphs in the document.
functiongetRevision()
function
           Gets or sets the document revision number.
functiongetRevisionNumber()
function
           Gets or sets the document revision number.
functiongetScaleCrop()
function
           Indicates the display mode of the document thumbnail.
functiongetSubject()
function
setSubject(value)
           Gets or sets the subject of the document.
functiongetTemplate()
function
           Gets or sets the informational name of the document template.
functiongetTitle()
function
setTitle(value)
           Gets or sets the title of the document.
functiongetTotalEditingTime()
function
           Gets or sets the total editing time in minutes.
functiongetVersion()
function
setVersion(value)
           Represents the version number of the application that created the document.
functiongetWords()
function
setWords(value)
           Represents an estimate of the number of words in the document.
functionget(index)
Returns a DocumentProperty object by index.
functionget(name)
Returns a DocumentProperty object by the name of the property.
 
Method Summary
functionclear()
Removes all properties from the collection.
functioncontains(name)
Returns true if a property with the specified name exists in the collection.
functionindexOf(name)
Gets the index of a property by name.
functioniterator()
functionremove(name)
Removes a property with the specified name from the collection.
functionremoveAt(index)
Removes a property at the specified index.
 

    • Property Getters/Setters Detail

      • getLanguage/setLanguage : String 

        function getLanguage() / function setLanguage(value)
        
        Gets or sets the document's language.
      • getAuthor/setAuthor : String 

        function getAuthor() / function setAuthor(value)
        
        Gets or sets the name of the document's author.
      • getBytes/setBytes : Number 

        function getBytes() / function setBytes(value)
        
        Represents an estimate of the number of bytes in the document.
      • getCharacters/setCharacters : Number 

        function getCharacters() / function setCharacters(value)
        
        Represents an estimate of the number of characters in the document.
      • getCharactersWithSpaces/setCharactersWithSpaces : Number 

        function getCharactersWithSpaces() / function setCharactersWithSpaces(value)
        
        Represents an estimate of the number of characters (including spaces) in the document.
      • getComments/setComments : String 

        function getComments() / function setComments(value)
        
        Gets or sets the document comments.
      • getCategory/setCategory : String 

        function getCategory() / function setCategory(value)
        
        Gets or sets the category of the document.
      • getContentType/setContentType : String 

        function getContentType() / function setContentType(value)
        
        Gets or sets the content type of the document.
      • getContentStatus/setContentStatus : String 

        function getContentStatus() / function setContentStatus(value)
        
        Gets or sets the content status of the document.
      • getCompany/setCompany : String 

        function getCompany() / function setCompany(value)
        
        Gets or sets the company property.
      • getHyperlinkBase/setHyperlinkBase : String 

        function getHyperlinkBase() / function setHyperlinkBase(value)
        
        Gets or sets the hyperlinkbase property.
      • getCreatedTime/setCreatedTime : DateTime 

        function getCreatedTime() / function setCreatedTime(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 : DateTime 

        function getCreatedUniversalTime() / function setCreatedUniversalTime(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 : String 

        function getKeywords() / function setKeywords(value)
        
        Gets or sets the document keywords.
      • getLastPrinted/setLastPrinted : DateTime 

        function getLastPrinted() / function setLastPrinted(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 : DateTime 

        function getLastPrintedUniversalTime() / function setLastPrintedUniversalTime(value)
        
        Gets or sets the Universal time when the document was last printed.
      • getLastSavedBy/setLastSavedBy : String 

        function getLastSavedBy() / function setLastSavedBy(value)
        
        Gets or sets the name of the last author.

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

      • getLastSavedTime/setLastSavedTime : DateTime 

        function getLastSavedTime() / function setLastSavedTime(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 : DateTime 

        function getLastSavedUniversalTime() / function setLastSavedUniversalTime(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 : Number 

        function getLines() / function setLines(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 : String 

        function getManager() / function setManager(value)
        
        Gets or sets the manager property.
      • getNameOfApplication/setNameOfApplication : String 

        function getNameOfApplication() / function setNameOfApplication(value)
        
        Gets or sets the name of the application.
      • getPages/setPages : Number 

        function getPages() / function setPages(value)
        
        Represents an estimate of the number of pages in the document.
      • getParagraphs/setParagraphs : Number 

        function getParagraphs() / function setParagraphs(value)
        
        Represents an estimate of the number of paragraphs in the document.
      • getRevisionNumber/setRevisionNumber : Number 

        function getRevisionNumber() / function setRevisionNumber(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 : String 

        function getRevision() / function setRevision(value)
        
        Gets or sets the document revision number.

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

      • getSubject/setSubject : String 

        function getSubject() / function setSubject(value)
        
        Gets or sets the subject of the document.
      • getTemplate/setTemplate : String 

        function getTemplate() / function setTemplate(value)
        
        Gets or sets the informational name of the document template.
      • getTitle/setTitle : String 

        function getTitle() / function setTitle(value)
        
        Gets or sets the title of the document.
      • getTotalEditingTime/setTotalEditingTime : Number 

        function getTotalEditingTime() / function setTotalEditingTime(value)
        
        Gets or sets the total editing time in minutes.
      • getVersion/setVersion : String 

        function getVersion() / function setVersion(value)
        
        Represents the version number of the application that created the document. It's format is "00.0000",for example : 12.0000
      • getDocumentVersion/setDocumentVersion : String 

        function getDocumentVersion() / function setDocumentVersion(value)
        
        Represents the version of the file.
      • getScaleCrop/setScaleCrop : boolean 

        function getScaleCrop() / function setScaleCrop(value)
        
        Indicates the display mode of the document thumbnail.
      • getLinksUpToDate/setLinksUpToDate : boolean 

        function getLinksUpToDate() / function setLinksUpToDate(value)
        
        Indicates whether hyperlinks in a document are up-to-date.
      • getWords/setWords : Number 

        function getWords() / function setWords(value)
        
        Represents an estimate of the number of words in the document.
      • getCount : Number 

        function getCount()
        
        Gets number of items in the collection.
      • get : DocumentProperty 

        function get(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.
    • Method Detail

      • iterator

        function iterator()
        Returns:
      • contains

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

        function indexOf(name)
        Gets the index of a property by name.
        Parameters:
        name: String - The case-insensitive name of the property.
        Returns:
        The zero based index. Negative value if not found.
      • remove

        function remove(name)
        Removes a property with the specified name from the collection.
        Parameters:
        name: String - The case-insensitive name of the property.
      • removeAt

        function removeAt(index)
        Removes a property at the specified index.
        Parameters:
        index: Number - The zero based index.
      • clear

        function clear()
        Removes all properties from the collection.