com.aspose.cells
Class BuiltInDocumentPropertyCollection

java.lang.Object
  extended by DocumentPropertyCollection
      extended by com.aspose.cells.BuiltInDocumentPropertyCollection
All Implemented Interfaces:
com.aspose.cells.c.b.a.a.a.c.b.e, java.lang.Cloneable

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()
voidsetAuthor(java.lang.String value)
           Gets or sets the name of the document's author.
intgetBytes()
voidsetBytes(int value)
           Represents an estimate of the number of bytes in the document.
java.lang.StringgetCategory()
voidsetCategory(java.lang.String value)
           Gets or sets the category of the document.
intgetCharacters()
voidsetCharacters(int value)
           Represents an estimate of the number of characters in the document.
intgetCharactersWithSpaces()
voidsetCharactersWithSpaces(int value)
           Represents an estimate of the number of characters (including spaces) in the document.
java.lang.StringgetComments()
voidsetComments(java.lang.String value)
           Gets or sets the document comments.
java.lang.StringgetCompany()
voidsetCompany(java.lang.String value)
           Gets or sets the company property.
java.lang.StringgetContentStatus()
voidsetContentStatus(java.lang.String value)
           Gets or sets the content status of the document.
java.lang.StringgetContentType()
voidsetContentType(java.lang.String value)
           Gets or sets the content type of the document.
intgetCount()→ inherited from DocumentPropertyCollection
           Gets number of items in the collection.
com.aspose.cells.DateTimegetCreatedTime()
voidsetCreatedTime(com.aspose.cells.DateTime value)
           Gets or sets date of the document creation in UTC.
java.lang.StringgetHyperlinkBase()
voidsetHyperlinkBase(java.lang.String value)
           Gets or sets the hyperlinkbase property.
java.lang.StringgetKeywords()
voidsetKeywords(java.lang.String value)
           Gets or sets the document keywords.
com.aspose.cells.DateTimegetLastPrinted()
voidsetLastPrinted(com.aspose.cells.DateTime value)
           Gets or sets the date when the document was last printed in UTC.
java.lang.StringgetLastSavedBy()
voidsetLastSavedBy(java.lang.String value)
           Gets or sets the name of the last author.
com.aspose.cells.DateTimegetLastSavedTime()
voidsetLastSavedTime(com.aspose.cells.DateTime value)
           Gets or sets the time of the last save in UTC.
intgetLines()
voidsetLines(int value)
           Represents an estimate of the number of lines in the document.
java.lang.StringgetManager()
voidsetManager(java.lang.String value)
           Gets or sets the manager property.
java.lang.StringgetNameOfApplication()
voidsetNameOfApplication(java.lang.String value)
           Gets or sets the name of the application.
intgetPages()
voidsetPages(int value)
           Represents an estimate of the number of pages in the document.
intgetParagraphs()
voidsetParagraphs(int value)
           Represents an estimate of the number of paragraphs in the document.
intgetRevisionNumber()
voidsetRevisionNumber(int value)
           Gets or sets the document revision number.
java.lang.StringgetSubject()
voidsetSubject(java.lang.String value)
           Gets or sets the subject of the document.
java.lang.StringgetTemplate()
voidsetTemplate(java.lang.String value)
           Gets or sets the informational name of the document template.
java.lang.StringgetTitle()
voidsetTitle(java.lang.String value)
           Gets or sets the title of the document.
doublegetTotalEditingTime()
voidsetTotalEditingTime(double value)
           Gets or sets the total editing time in minutes.
intgetVersion()
voidsetVersion(int value)
           Represents the version number of the application that created the document.
intgetWords()
voidsetWords(int value)
           Represents an estimate of the number of words in the document.
DocumentPropertyget(int index)→ inherited from DocumentPropertyCollection
           Returns a DocumentProperty object by index.
DocumentPropertyget(java.lang.String name)
           Returns a DocumentProperty object by the name of the property.
 
Method Summary
voidclear()→ inherited from DocumentPropertyCollection
           Removes all properties from the collection.
booleancontains(java.lang.String name)→ inherited from DocumentPropertyCollection
           Returns true if a property with the specified name exists in the collection.
intindexOf(java.lang.String name)→ inherited from DocumentPropertyCollection
           Gets the index of a property by name.
java.util.Iteratoriterator()→ inherited from DocumentPropertyCollection
          
voidremove(java.lang.String name)→ inherited from DocumentPropertyCollection
           Removes a property with the specified name from the collection.
voidremoveAt(int index)→ inherited from DocumentPropertyCollection
           Removes a property at the specified index.
 

Property Getters/Setters Detail

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

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

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

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


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

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.


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 int getVersion() / public void setVersion(int value)
Represents the version number of the application that created the document.

getWords/setWords

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

getCount

→ inherited from DocumentPropertyCollection
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.

get

→ inherited from DocumentPropertyCollection
public DocumentProperty get(int index)
Returns a DocumentProperty object by index.
Parameters:
index - Zero-based index of the DocumentProperty to retrieve.

Method Detail

iterator

→ inherited from DocumentPropertyCollection
public java.util.Iterator iterator()
Returns:

contains

→ inherited from DocumentPropertyCollection
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

→ inherited from DocumentPropertyCollection
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

→ inherited from DocumentPropertyCollection
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

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

clear

→ inherited from DocumentPropertyCollection
public void 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.