BuiltInDocumentPropertyCollection
Inheritance: java.lang.Object, com.aspose.cells.CollectionBase, com.aspose.cells.DocumentPropertyCollection
public class BuiltInDocumentPropertyCollection extends DocumentPropertyCollection
A collection of built-in document properties.
Remarks
Provides access to objects by their names (using an indexer) and via a set of typed properties that return values of appropriate types.
Methods
| Method | Description |
|---|---|
| add(Object o) | Adds an item to the CollectionBase instance. |
| clear() | Removes all objects from the CollectionBase instance. |
| contains(Object o) | Return whether instance contains this object |
| contains(String name) | Returns true if a property with the specified name exists in the collection. |
| equals(Object arg0) | |
| get(int index) | Returns a DocumentProperty object by index. |
| get(String name) | Returns a DocumentProperty object by the name of the property. |
| getAuthor() | Gets the name of the document’s author. |
| getBytes() | Represents an estimate of the number of bytes in the document. |
| getCategory() | Gets the category of the document. |
| getCharacters() | Represents an estimate of the number of characters in the document. |
| getCharactersWithSpaces() | Represents an estimate of the number of characters (including spaces) in the document. |
| getClass() | |
| getComments() | Gets the document comments. |
| getCompany() | Gets the company property. |
| getContentStatus() | Gets the content status of the document. |
| getContentType() | Gets the content type of the document. |
| getCount() | Gets the number of elements contained in the CollectionBase instance. |
| getCreatedTime() | Gets date of the document creation in local timezone. |
| getCreatedUniversalTime() | Gets the Universal time of the document creation. |
| getDocumentVersion() | Represents the version of the file. |
| getHyperlinkBase() | Gets the hyperlinkbase property. |
| getKeywords() | Gets the document keywords. |
| getLanguage() | Gets the document’s language. |
| getLastPrinted() | Gets the date when the document was last printed in local timezone. |
| getLastPrintedUniversalTime() | Gets the Universal time when the document was last printed. |
| getLastSavedBy() | Gets the name of the last author. |
| getLastSavedTime() | Gets the time of the last save in local timezone. |
| getLastSavedUniversalTime() | Gets the universal time of the last save. |
| getLines() | Represents an estimate of the number of lines in the document. |
| getLinksUpToDate() | Indicates whether hyperlinks in a document are up-to-date. |
| getManager() | Gets the manager property. |
| getNameOfApplication() | Gets the name of the application. |
| getPages() | Represents an estimate of the number of pages in the document. |
| getParagraphs() | Represents an estimate of the number of paragraphs in the document. |
| getRevisionNumber() | Gets the document revision number. |
| getScaleCrop() | Indicates the display mode of the document thumbnail. |
| getSubject() | Gets the subject of the document. |
| getTemplate() | Gets the informational name of the document template. |
| getTitle() | Gets the title of the document. |
| getTotalEditingTime() | Gets the total editing time in minutes. |
| getVersion() | Represents the version number of the application that created the document. |
| getWords() | Represents an estimate of the number of words in the document. |
| hashCode() | |
| indexOf(Object o) | Determines the index of a specific item in the CollectionBase instance. |
| indexOf(String name) | Gets the index of a property by name. |
| iterator() | Returns an enumerator that iterates through the CollectionBase instance. |
| notify() | |
| notifyAll() | |
| remove(String name) | Removes a property with the specified name from the collection. |
| removeAt(int index) | Removes a property at the specified index. |
| setAuthor(String value) | Sets the name of the document’s author. |
| setBytes(int value) | Represents an estimate of the number of bytes in the document. |
| setCategory(String value) | Sets the category of the document. |
| setCharacters(int value) | Represents an estimate of the number of characters in the document. |
| setCharactersWithSpaces(int value) | Represents an estimate of the number of characters (including spaces) in the document. |
| setComments(String value) | Sets the document comments. |
| setCompany(String value) | Sets the company property. |
| setContentStatus(String value) | Sets the content status of the document. |
| setContentType(String value) | Sets the content type of the document. |
| setCreatedTime(DateTime value) | Sets date of the document creation in local timezone. |
| setCreatedUniversalTime(DateTime value) | Sets the Universal time of the document creation. |
| setDocumentVersion(String value) | Represents the version of the file. |
| setHyperlinkBase(String value) | Sets the hyperlinkbase property. |
| setKeywords(String value) | Sets the document keywords. |
| setLanguage(String value) | Sets the document’s language. |
| setLastPrinted(DateTime value) | Sets the date when the document was last printed in local timezone. |
| setLastPrintedUniversalTime(DateTime value) | Sets the Universal time when the document was last printed. |
| setLastSavedBy(String value) | Sets the name of the last author. |
| setLastSavedTime(DateTime value) | Sets the time of the last save in local timezone. |
| setLastSavedUniversalTime(DateTime value) | Sets the universal time of the last save. |
| setLines(int value) | Represents an estimate of the number of lines in the document. |
| setLinksUpToDate(boolean value) | Indicates whether hyperlinks in a document are up-to-date. |
| setManager(String value) | Sets the manager property. |
| setNameOfApplication(String value) | Sets the name of the application. |
| setPages(int value) | Represents an estimate of the number of pages in the document. |
| setParagraphs(int value) | Represents an estimate of the number of paragraphs in the document. |
| setRevisionNumber(String value) | Sets the document revision number. |
| setScaleCrop(boolean value) | Indicates the display mode of the document thumbnail. |
| setSubject(String value) | Sets the subject of the document. |
| setTemplate(String value) | Sets the informational name of the document template. |
| setTitle(String value) | Sets the title of the document. |
| setTotalEditingTime(double value) | Sets the total editing time in minutes. |
| setVersion(String value) | Represents the version number of the application that created the document. |
| setWords(int value) | Represents an estimate of the number of words in the document. |
| toString() | |
| wait() | |
| wait(long arg0) | |
| wait(long arg0, int arg1) |
add(Object o)
public int add(Object o)
Adds an item to the CollectionBase instance.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| o | java.lang.Object | The Object to add to the CollectionBase instance. |
Returns: int - The position into which the new element was inserted.
clear()
public void clear()
Removes all objects from the CollectionBase instance.
contains(Object o)
public boolean contains(Object o)
Return whether instance contains this object
Parameters:
| Parameter | Type | Description |
|---|---|---|
| o | java.lang.Object | test object |
Returns: boolean - Whether instance contains this object
contains(String name)
public boolean contains(String name)
Returns true if a property with the specified name exists in the collection.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| name | java.lang.String | The case-insensitive name of the property. |
Returns: boolean - True if the property exists in the collection; false otherwise.
equals(Object arg0)
public boolean equals(Object arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | java.lang.Object |
Returns: boolean
get(int index)
public DocumentProperty get(int index)
Returns a DocumentProperty object by index.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| index | int | Zero-based index of the DocumentProperty to retrieve. |
Returns: DocumentProperty
get(String name)
public DocumentProperty get(String name)
Returns a DocumentProperty object by the name of the property.
Remarks
The string names of the properties correspond to the names of the typed properties available from .
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 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:
| Parameter | Type | Description |
|---|---|---|
| name | java.lang.String | The case-insensitive name of the property to retrieve. |
Returns: DocumentProperty
getAuthor()
public String getAuthor()
Gets the name of the document’s author.
Returns: java.lang.String
getBytes()
public int getBytes()
Represents an estimate of the number of bytes in the document.
Returns: int
getCategory()
public String getCategory()
Gets the category of the document.
Returns: java.lang.String
getCharacters()
public int getCharacters()
Represents an estimate of the number of characters in the document.
Returns: int
getCharactersWithSpaces()
public int getCharactersWithSpaces()
Represents an estimate of the number of characters (including spaces) in the document.
Returns: int
getClass()
public final native Class<?> getClass()
Returns: java.lang.Class
getComments()
public String getComments()
Gets the document comments.
Returns: java.lang.String
getCompany()
public String getCompany()
Gets the company property.
Returns: java.lang.String
getContentStatus()
public String getContentStatus()
Gets the content status of the document.
Returns: java.lang.String
getContentType()
public String getContentType()
Gets the content type of the document.
Returns: java.lang.String
getCount()
public int getCount()
Gets the number of elements contained in the CollectionBase instance.
Returns: int - The number of elements contained in the CollectionBase instance.
getCreatedTime()
public DateTime getCreatedTime()
Gets date of the document creation in local timezone.
Remarks
Aspose.Cells does not update this property when you modify the document.
Returns: DateTime
getCreatedUniversalTime()
public DateTime getCreatedUniversalTime()
Gets the Universal time of the document creation.
Remarks
Aspose.Cells does not update this property when you modify the document.
Returns: DateTime
getDocumentVersion()
public String getDocumentVersion()
Represents the version of the file.
Returns: java.lang.String
getHyperlinkBase()
public String getHyperlinkBase()
Gets the hyperlinkbase property.
Returns: java.lang.String
getKeywords()
public String getKeywords()
Gets the document keywords.
Returns: java.lang.String
getLanguage()
public String getLanguage()
Gets the document’s language.
Returns: java.lang.String
getLastPrinted()
public DateTime getLastPrinted()
Gets the date when the document was last printed in local timezone.
Remarks
If the document was never printed, this property will return DateTime.MinValue.
Aspose.Cells does not update this property when you modify the document.
Returns: DateTime
getLastPrintedUniversalTime()
public DateTime getLastPrintedUniversalTime()
Gets the Universal time when the document was last printed.
Returns: DateTime
getLastSavedBy()
public String getLastSavedBy()
Gets the name of the last author.
Remarks
Aspose.Cells does not update this property when you modify the document.
Returns: java.lang.String
getLastSavedTime()
public DateTime getLastSavedTime()
Gets the time of the last save in local timezone.
Remarks
Aspose.Cells does not update this property when you modify the document.
Returns: DateTime
getLastSavedUniversalTime()
public DateTime getLastSavedUniversalTime()
Gets the universal time of the last save.
Remarks
Aspose.Cells does not update this property when you modify the document.
Returns: DateTime
getLines()
public int getLines()
Represents an estimate of the number of lines in the document.
Remarks
Aspose.Cells does not update this property when you modify the document.
Returns: int
getLinksUpToDate()
public boolean getLinksUpToDate()
Indicates whether hyperlinks in a document are up-to-date.
Returns: boolean
getManager()
public String getManager()
Gets the manager property.
Returns: java.lang.String
getNameOfApplication()
public String getNameOfApplication()
Gets the name of the application.
Returns: java.lang.String
getPages()
public int getPages()
Represents an estimate of the number of pages in the document.
Returns: int
getParagraphs()
public int getParagraphs()
Represents an estimate of the number of paragraphs in the document.
Returns: int
getRevisionNumber()
public String getRevisionNumber()
Gets the document revision number.
Remarks
Aspose.Cells does not update this property when you modify the document.
Returns: java.lang.String
getScaleCrop()
public boolean getScaleCrop()
Indicates the display mode of the document thumbnail.
Returns: boolean
getSubject()
public String getSubject()
Gets the subject of the document.
Returns: java.lang.String
getTemplate()
public String getTemplate()
Gets the informational name of the document template.
Returns: java.lang.String
getTitle()
public String getTitle()
Gets the title of the document.
Returns: java.lang.String
getTotalEditingTime()
public double getTotalEditingTime()
Gets the total editing time in minutes.
Returns: double
getVersion()
public String getVersion()
Represents the version number of the application that created the document.
Remarks
It’s format is “00.0000”,for example : 12.0000
Returns: java.lang.String
getWords()
public int getWords()
Represents an estimate of the number of words in the document.
Returns: int
hashCode()
public native int hashCode()
Returns: int
indexOf(Object o)
public int indexOf(Object o)
Determines the index of a specific item in the CollectionBase instance.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| o | java.lang.Object | Determines the index of a specific item in the CollectionBase instance. |
Returns: int - The index of value if found in the list; otherwise, -1.
indexOf(String name)
public int indexOf(String name)
Gets the index of a property by name.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| name | java.lang.String | The case-insensitive name of the property. |
Returns: int - The zero based index. Negative value if not found.
iterator()
public Iterator iterator()
Returns an enumerator that iterates through the CollectionBase instance.
Returns: java.util.Iterator - An iterator for the CollectionBase instance.
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
remove(String name)
public void remove(String name)
Removes a property with the specified name from the collection.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| name | java.lang.String | The case-insensitive name of the property. |
removeAt(int index)
public void removeAt(int index)
Removes a property at the specified index.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| index | int | The zero based index. |
setAuthor(String value)
public void setAuthor(String value)
Sets the name of the document’s author.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setBytes(int value)
public void setBytes(int value)
Represents an estimate of the number of bytes in the document.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setCategory(String value)
public void setCategory(String value)
Sets the category of the document.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setCharacters(int value)
public void setCharacters(int value)
Represents an estimate of the number of characters in the document.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setCharactersWithSpaces(int value)
public void setCharactersWithSpaces(int value)
Represents an estimate of the number of characters (including spaces) in the document.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setComments(String value)
public void setComments(String value)
Sets the document comments.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setCompany(String value)
public void setCompany(String value)
Sets the company property.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setContentStatus(String value)
public void setContentStatus(String value)
Sets the content status of the document.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setContentType(String value)
public void setContentType(String value)
Sets the content type of the document.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setCreatedTime(DateTime value)
public void setCreatedTime(DateTime value)
Sets date of the document creation in local timezone.
Remarks
Aspose.Cells does not update this property when you modify the document.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | DateTime |
setCreatedUniversalTime(DateTime value)
public void setCreatedUniversalTime(DateTime value)
Sets the Universal time of the document creation.
Remarks
Aspose.Cells does not update this property when you modify the document.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | DateTime |
setDocumentVersion(String value)
public void setDocumentVersion(String value)
Represents the version of the file.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setHyperlinkBase(String value)
public void setHyperlinkBase(String value)
Sets the hyperlinkbase property.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setKeywords(String value)
public void setKeywords(String value)
Sets the document keywords.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setLanguage(String value)
public void setLanguage(String value)
Sets the document’s language.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setLastPrinted(DateTime value)
public void setLastPrinted(DateTime value)
Sets the date when the document was last printed in local timezone.
Remarks
If the document was never printed, this property will return DateTime.MinValue.
Aspose.Cells does not update this property when you modify the document.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | DateTime |
setLastPrintedUniversalTime(DateTime value)
public void setLastPrintedUniversalTime(DateTime value)
Sets the Universal time when the document was last printed.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | DateTime |
setLastSavedBy(String value)
public void setLastSavedBy(String value)
Sets the name of the last author.
Remarks
Aspose.Cells does not update this property when you modify the document.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setLastSavedTime(DateTime value)
public void setLastSavedTime(DateTime value)
Sets the time of the last save in local timezone.
Remarks
Aspose.Cells does not update this property when you modify the document.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | DateTime |
setLastSavedUniversalTime(DateTime value)
public void setLastSavedUniversalTime(DateTime value)
Sets the universal time of the last save.
Remarks
Aspose.Cells does not update this property when you modify the document.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | DateTime |
setLines(int value)
public void setLines(int value)
Represents an estimate of the number of lines in the document.
Remarks
Aspose.Cells does not update this property when you modify the document.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setLinksUpToDate(boolean value)
public void setLinksUpToDate(boolean value)
Indicates whether hyperlinks in a document are up-to-date.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setManager(String value)
public void setManager(String value)
Sets the manager property.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setNameOfApplication(String value)
public void setNameOfApplication(String value)
Sets the name of the application.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setPages(int value)
public void setPages(int value)
Represents an estimate of the number of pages in the document.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setParagraphs(int value)
public void setParagraphs(int value)
Represents an estimate of the number of paragraphs in the document.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setRevisionNumber(String value)
public void setRevisionNumber(String value)
Sets the document revision number.
Remarks
Aspose.Cells does not update this property when you modify the document.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setScaleCrop(boolean value)
public void setScaleCrop(boolean value)
Indicates the display mode of the document thumbnail.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setSubject(String value)
public void setSubject(String value)
Sets the subject of the document.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setTemplate(String value)
public void setTemplate(String value)
Sets the informational name of the document template.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setTitle(String value)
public void setTitle(String value)
Sets the title of the document.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setTotalEditingTime(double value)
public void setTotalEditingTime(double value)
Sets the total editing time in minutes.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | double |
setVersion(String value)
public void setVersion(String value)
Represents the version number of the application that created the document.
Remarks
It’s format is “00.0000”,for example : 12.0000
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setWords(int value)
public void setWords(int value)
Represents an estimate of the number of words in the document.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
toString()
public String toString()
Returns: java.lang.String
wait()
public final void wait()
wait(long arg0)
public final native void wait(long arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long |
wait(long arg0, int arg1)
public final void wait(long arg0, int arg1)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long | |
| arg1 | int |