BuiltInDocumentPropertyCollection

com.aspose.cells
Class BuiltInDocumentPropertyCollection

java.lang.Object
  DocumentPropertyCollection
      com.aspose.cells.BuiltInDocumentPropertyCollection

All Implemented Interfaces:: java.lang.Iterable

public class BuiltInDocumentPropertyCollection
extends DocumentPropertyCollection
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.String`	`getAuthor()`
`void`	`setAuthor(java.lang.String value)`
	Gets or sets the name of the document's author.
`int`	`getBytes()`
`void`	`setBytes(int value)`
	Represents an estimate of the number of bytes in the document.
`java.lang.String`	`getCategory()`
`void`	`setCategory(java.lang.String value)`
	Gets or sets the category of the document.
`int`	`getCharacters()`
`void`	`setCharacters(int value)`
	Represents an estimate of the number of characters in the document.
`int`	`getCharactersWithSpaces()`
`void`	`setCharactersWithSpaces(int value)`
	Represents an estimate of the number of characters (including spaces) in the document.
`java.lang.String`	`getComments()`
`void`	`setComments(java.lang.String value)`
	Gets or sets the document comments.
`java.lang.String`	`getCompany()`
`void`	`setCompany(java.lang.String value)`
	Gets or sets the company property.
`java.lang.String`	`getContentStatus()`
`void`	`setContentStatus(java.lang.String value)`
	Gets or sets the content status of the document.
`java.lang.String`	`getContentType()`
`void`	`setContentType(java.lang.String value)`
	Gets or sets the content type of the document.
`int`	`getCount()`	`→ inherited from DocumentPropertyCollection`
	Gets number of items in the collection.
`com.aspose.cells.DateTime`	`getCreatedTime()`
`void`	`setCreatedTime(com.aspose.cells.DateTime value)`
	Gets or sets date of the document creation in local timezone.
`com.aspose.cells.DateTime`	`getCreatedUniversalTime()`
`void`	`setCreatedUniversalTime(com.aspose.cells.DateTime value)`
	Gets or sets the Universal time of the document creation.
`java.lang.String`	`getDocumentVersion()`
`void`	`setDocumentVersion(java.lang.String value)`
	Represents the version of the file.
`java.lang.String`	`getHyperlinkBase()`
`void`	`setHyperlinkBase(java.lang.String value)`
	Gets or sets the hyperlinkbase property.
`java.lang.String`	`getKeywords()`
`void`	`setKeywords(java.lang.String value)`
	Gets or sets the document keywords.
`java.lang.String`	`getLanguage()`
`void`	`setLanguage(java.lang.String value)`
	Gets or sets the document's language.
`com.aspose.cells.DateTime`	`getLastPrinted()`
`void`	`setLastPrinted(com.aspose.cells.DateTime value)`
	Gets or sets the date when the document was last printed in local timezone.
`com.aspose.cells.DateTime`	`getLastPrintedUniversalTime()`
`void`	`setLastPrintedUniversalTime(com.aspose.cells.DateTime value)`
	Gets or sets the Universal time when the document was last printed.
`java.lang.String`	`getLastSavedBy()`
`void`	`setLastSavedBy(java.lang.String value)`
	Gets or sets the name of the last author.
`com.aspose.cells.DateTime`	`getLastSavedTime()`
`void`	`setLastSavedTime(com.aspose.cells.DateTime value)`
	Gets or sets the time of the last save in local timezone.
`com.aspose.cells.DateTime`	`getLastSavedUniversalTime()`
`void`	`setLastSavedUniversalTime(com.aspose.cells.DateTime value)`
	Gets or sets the universal time of the last save.
`int`	`getLines()`
`void`	`setLines(int value)`
	Represents an estimate of the number of lines in the document.
`boolean`	`getLinksUpToDate()`
`void`	`setLinksUpToDate(boolean value)`
	Indicates whether hyperlinks in a document are up-to-date.
`java.lang.String`	`getManager()`
`void`	`setManager(java.lang.String value)`
	Gets or sets the manager property.
`java.lang.String`	`getNameOfApplication()`
`void`	`setNameOfApplication(java.lang.String value)`
	Gets or sets the name of the application.
`int`	`getPages()`
`void`	`setPages(int value)`
	Represents an estimate of the number of pages in the document.
`int`	`getParagraphs()`
`void`	`setParagraphs(int value)`
	Represents an estimate of the number of paragraphs in the document.
`java.lang.String`	`getRevision()`
`void`	`setRevision(java.lang.String value)`
	Gets or sets the document revision number.
`int`	`getRevisionNumber()`
`void`	`setRevisionNumber(int value)`
	Gets or sets the document revision number.
`boolean`	`getScaleCrop()`
`void`	`setScaleCrop(boolean value)`
	Indicates the display mode of the document thumbnail.
`java.lang.String`	`getSubject()`
`void`	`setSubject(java.lang.String value)`
	Gets or sets the subject of the document.
`java.lang.String`	`getTemplate()`
`void`	`setTemplate(java.lang.String value)`
	Gets or sets the informational name of the document template.
`java.lang.String`	`getTitle()`
`void`	`setTitle(java.lang.String value)`
	Gets or sets the title of the document.
`double`	`getTotalEditingTime()`
`void`	`setTotalEditingTime(double value)`
	Gets or sets the total editing time in minutes.
`java.lang.String`	`getVersion()`
`void`	`setVersion(java.lang.String value)`
	Represents the version number of the application that created the document.
`int`	`getWords()`
`void`	`setWords(int value)`
	Represents an estimate of the number of words in the document.
`DocumentProperty`	`get(int index)`	`→ inherited from DocumentPropertyCollection`
	Returns a DocumentProperty object by index.
`DocumentProperty`	`get(java.lang.String name)`
	Returns a DocumentProperty object by the name of the property.

Method Summary
`void`	`clear()`	`→ inherited from DocumentPropertyCollection`
`void`	Removes all properties from the collection.
`boolean`	`contains(java.lang.String name)`	`→ inherited from DocumentPropertyCollection`
`boolean`	Returns true if a property with the specified name exists in the collection.
`int`	`indexOf(java.lang.String name)`	`→ inherited from DocumentPropertyCollection`
`int`	Gets the index of a property by name.
`java.util.Iterator`	`iterator()`	`→ inherited from DocumentPropertyCollection`
`java.util.Iterator`
`void`	`remove(java.lang.String name)`	`→ inherited from DocumentPropertyCollection`
`void`	Removes a property with the specified name from the collection.
`void`	`removeAt(int index)`	`→ inherited from DocumentPropertyCollection`
`void`	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 property, 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	`→ 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.Cells Product Documentation.
Aspose.Cells Support Forum - our preferred method of support.

setLanguage
public void setLanguage(java.lang.String value)

setCharactersWithSpaces
public void setCharactersWithSpaces(int value)

setComments
public void setComments(java.lang.String value)

setCategory
public void setCategory(java.lang.String value)

setContentType
public void setContentType(java.lang.String value)

setContentStatus
public void setContentStatus(java.lang.String value)

setCompany
public void setCompany(java.lang.String value)

setHyperlinkBase
public void setHyperlinkBase(java.lang.String value)

setCreatedTime
public void setCreatedTime(com.aspose.cells.DateTime value)

setCreatedUniversalTime
public void setCreatedUniversalTime(com.aspose.cells.DateTime value)

setKeywords
public void setKeywords(java.lang.String value)

setLastPrinted
public void setLastPrinted(com.aspose.cells.DateTime value)

setLastPrintedUniversalTime
public void setLastPrintedUniversalTime(com.aspose.cells.DateTime value)

setLastSavedBy
public void setLastSavedBy(java.lang.String value)

setLastSavedTime
public void setLastSavedTime(com.aspose.cells.DateTime value)

setLastSavedUniversalTime
public void setLastSavedUniversalTime(com.aspose.cells.DateTime value)

setManager
public void setManager(java.lang.String value)

setNameOfApplication
public void setNameOfApplication(java.lang.String value)

setRevisionNumber
public void setRevisionNumber(int value)

setRevision
public void setRevision(java.lang.String value)

com.aspose.cells Class BuiltInDocumentPropertyCollection

getLanguage/setLanguage

setLanguage

getAuthor/setAuthor

setAuthor

getBytes/setBytes

setBytes

getCharacters/setCharacters

setCharacters

getCharactersWithSpaces/setCharactersWithSpaces

setCharactersWithSpaces

getComments/setComments

setComments

getCategory/setCategory

setCategory

getContentType/setContentType

setContentType

getContentStatus/setContentStatus

setContentStatus

getCompany/setCompany

setCompany

getHyperlinkBase/setHyperlinkBase

setHyperlinkBase

getCreatedTime/setCreatedTime

setCreatedTime

getCreatedUniversalTime/setCreatedUniversalTime

setCreatedUniversalTime

getKeywords/setKeywords

setKeywords

getLastPrinted/setLastPrinted

setLastPrinted

getLastPrintedUniversalTime/setLastPrintedUniversalTime

setLastPrintedUniversalTime

getLastSavedBy/setLastSavedBy

setLastSavedBy

getLastSavedTime/setLastSavedTime

setLastSavedTime

getLastSavedUniversalTime/setLastSavedUniversalTime

setLastSavedUniversalTime

getLines/setLines

setLines

getManager/setManager

setManager

getNameOfApplication/setNameOfApplication

setNameOfApplication

getPages/setPages

setPages

getParagraphs/setParagraphs

setParagraphs

getRevisionNumber/setRevisionNumber

setRevisionNumber

getRevision/setRevision

setRevision

getSubject/setSubject

setSubject

getTemplate/setTemplate

setTemplate

getTitle/setTitle

setTitle

getTotalEditingTime/setTotalEditingTime

setTotalEditingTime

getVersion/setVersion

setVersion

getDocumentVersion/setDocumentVersion

setDocumentVersion

getScaleCrop/setScaleCrop

setScaleCrop

getLinksUpToDate/setLinksUpToDate

setLinksUpToDate

getWords/setWords

setWords

getCount

get

get

iterator

contains

indexOf

remove

removeAt

clear

com.aspose.cells
Class BuiltInDocumentPropertyCollection

setSubject
public void setSubject(java.lang.String value)

setTemplate
public void setTemplate(java.lang.String value)

setTotalEditingTime
public void setTotalEditingTime(double value)

setVersion
public void setVersion(java.lang.String value)

setDocumentVersion
public void setDocumentVersion(java.lang.String value)

setLinksUpToDate
public void setLinksUpToDate(boolean value)