asposecells.api
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
methodgetAuthor()
methodsetAuthor(value)
           Gets or sets the name of the document's author.
methodgetBytes()
methodsetBytes(value)
           Represents an estimate of the number of bytes in the document.
methodgetCategory()
methodsetCategory(value)
           Gets or sets the category of the document.
methodgetCharacters()
methodsetCharacters(value)
           Represents an estimate of the number of characters in the document.
methodgetCharactersWithSpaces()
methodsetCharactersWithSpaces(value)
           Represents an estimate of the number of characters (including spaces) in the document.
methodgetComments()
methodsetComments(value)
           Gets or sets the document comments.
methodgetCompany()
methodsetCompany(value)
           Gets or sets the company property.
methodgetContentStatus()
methodsetContentStatus(value)
           Gets or sets the content status of the document.
methodgetContentType()
methodsetContentType(value)
           Gets or sets the content type of the document.
methodgetCount()
           Gets number of items in the collection.
methodgetCreatedTime()
methodsetCreatedTime(value)
           Gets or sets date of the document creation in local timezone.
methodgetCreatedUniversalTime()
methodsetCreatedUniversalTime(value)
           Gets or sets the Universal time of the document creation.
methodgetDocumentVersion()
methodsetDocumentVersion(value)
           Represents the version of the file.
methodgetHyperlinkBase()
methodsetHyperlinkBase(value)
           Gets or sets the hyperlinkbase property.
methodgetKeywords()
methodsetKeywords(value)
           Gets or sets the document keywords.
methodgetLanguage()
methodsetLanguage(value)
           Gets or sets the document's language.
methodgetLastPrinted()
methodsetLastPrinted(value)
           Gets or sets the date when the document was last printed in local timezone.
methodgetLastPrintedUniversalTime()
methodsetLastPrintedUniversalTime(value)
           Gets or sets the Universal time when the document was last printed.
methodgetLastSavedBy()
methodsetLastSavedBy(value)
           Gets or sets the name of the last author.
methodgetLastSavedTime()
methodsetLastSavedTime(value)
           Gets or sets the time of the last save in local timezone.
methodgetLastSavedUniversalTime()
methodsetLastSavedUniversalTime(value)
           Gets or sets the universal time of the last save.
methodgetLines()
methodsetLines(value)
           Represents an estimate of the number of lines in the document.
methodgetLinksUpToDate()
methodsetLinksUpToDate(value)
           Indicates whether hyperlinks in a document are up-to-date.
methodgetManager()
methodsetManager(value)
           Gets or sets the manager property.
methodgetNameOfApplication()
methodsetNameOfApplication(value)
           Gets or sets the name of the application.
methodgetPages()
methodsetPages(value)
           Represents an estimate of the number of pages in the document.
methodgetParagraphs()
methodsetParagraphs(value)
           Represents an estimate of the number of paragraphs in the document.
methodgetRevision()
methodsetRevision(value)
           Gets or sets the document revision number.
methodgetRevisionNumber()
methodsetRevisionNumber(value)
           Gets or sets the document revision number.
methodgetScaleCrop()
methodsetScaleCrop(value)
           Indicates the display mode of the document thumbnail.
methodgetSubject()
methodsetSubject(value)
           Gets or sets the subject of the document.
methodgetTemplate()
methodsetTemplate(value)
           Gets or sets the informational name of the document template.
methodgetTitle()
methodsetTitle(value)
           Gets or sets the title of the document.
methodgetTotalEditingTime()
methodsetTotalEditingTime(value)
           Gets or sets the total editing time in minutes.
methodgetVersion()
methodsetVersion(value)
           Represents the version number of the application that created the document.
methodgetWords()
methodsetWords(value)
           Represents an estimate of the number of words in the document.
methodget(index)
           Returns a DocumentProperty object by index.
methodget(name)
           Returns a DocumentProperty object by the name of the property.
 
Method Summary
methodclear()→ inherited from DocumentPropertyCollection
           Removes all properties from the collection.
methodcontains(name)→ inherited from DocumentPropertyCollection
           Returns true if a property with the specified name exists in the collection.
methodindexOf(name)→ inherited from DocumentPropertyCollection
           Gets the index of a property by name.
methoditerator()→ inherited from DocumentPropertyCollection
          
methodremove(name)→ inherited from DocumentPropertyCollection
           Removes a property with the specified name from the collection.
methodremoveAt(index)→ inherited from DocumentPropertyCollection
           Removes a property at the specified index.
 

Property Getters/Setters Detail

getLanguage/setLanguage : String 

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

getAuthor/setAuthor : String 

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

getBytes/setBytes : int 

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

getCharacters/setCharacters : int 

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

getCharactersWithSpaces/setCharactersWithSpaces : int 

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

getComments/setComments : String 

String getComments() / setComments(value)
Gets or sets the document comments.

getCategory/setCategory : String 

String getCategory() / setCategory(value)
Gets or sets the category of the document.

getContentType/setContentType : String 

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

getContentStatus/setContentStatus : String 

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

getCompany/setCompany : String 

String getCompany() / setCompany(value)
Gets or sets the company property.

getHyperlinkBase/setHyperlinkBase : String 

String getHyperlinkBase() / setHyperlinkBase(value)
Gets or sets the hyperlinkbase property.

getCreatedTime/setCreatedTime : DateTime 

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

DateTime getCreatedUniversalTime() / 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 

String getKeywords() / setKeywords(value)
Gets or sets the document keywords.

getLastPrinted/setLastPrinted : DateTime 

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

DateTime getLastPrintedUniversalTime() / setLastPrintedUniversalTime(value)
Gets or sets the Universal time when the document was last printed.

getLastSavedBy/setLastSavedBy : String 

String getLastSavedBy() / 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 

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

DateTime getLastSavedUniversalTime() / 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 : int 

int getLines() / 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 

String getManager() / setManager(value)
Gets or sets the manager property.

getNameOfApplication/setNameOfApplication : String 

String getNameOfApplication() / setNameOfApplication(value)
Gets or sets the name of the application.

getPages/setPages : int 

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

getParagraphs/setParagraphs : int 

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

getRevisionNumber/setRevisionNumber : int 

int getRevisionNumber() / 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 

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

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


getSubject/setSubject : String 

String getSubject() / setSubject(value)
Gets or sets the subject of the document.

getTemplate/setTemplate : String 

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

getTitle/setTitle : String 

String getTitle() / setTitle(value)
Gets or sets the title of the document.

getTotalEditingTime/setTotalEditingTime : float 

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

getVersion/setVersion : String 

String getVersion() / 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 

String getDocumentVersion() / setDocumentVersion(value)
Represents the version of the file.

getScaleCrop/setScaleCrop : boolean 

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

getLinksUpToDate/setLinksUpToDate : boolean 

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

getWords/setWords : int 

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

getCount : int 

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

get : DocumentProperty 

DocumentProperty 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.

get : DocumentProperty 

DocumentProperty get(index)
Returns a DocumentProperty object by index.
Parameters:
index - Zero-based index of the DocumentProperty to retrieve.

Method Detail

iterator

Iterator iterator()
Returns:

contains

boolean 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

int 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

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

removeAt

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

clear

 clear()
Removes all properties from the collection.

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cellss Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.