BuiltInDocumentPropertyCollection
Source: aspose.
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.
Methods
- add()
- clear()
- contains(name)
- contains()
- get(name)
- get(index)
- get()
- getAuthor()
- getBytes()
- getCategory()
- getCharacters()
- getCharactersWithSpaces()
- getComments()
- getCompany()
- getContentStatus()
- getContentType()
- getCount()
- getCreatedTime()
- getCreatedUniversalTime()
- getDocumentVersion()
- getHyperlinkBase()
- getKeywords()
- getLanguage()
- getLastPrinted()
- getLastPrintedUniversalTime()
- getLastSavedBy()
- getLastSavedTime()
- getLastSavedUniversalTime()
- getLines()
- getLinksUpToDate()
- getManager()
- getNameOfApplication()
- getPages()
- getParagraphs()
- getRevisionNumber()
- getScaleCrop()
- getSubject()
- getTemplate()
- getTitle()
- getTotalEditingTime()
- getVersion()
- getWords()
- indexOf(name)
- indexOf()
- iterator()
- remove(name)
- removeAt(index)
- setAuthor()
- setBytes()
- setCategory()
- setCharacters()
- setCharactersWithSpaces()
- setComments()
- setCompany()
- setContentStatus()
- setContentType()
- setCreatedTime()
- setCreatedUniversalTime()
- setDocumentVersion()
- setHyperlinkBase()
- setKeywords()
- setLanguage()
- setLastPrinted()
- setLastPrintedUniversalTime()
- setLastSavedBy()
- setLastSavedTime()
- setLastSavedUniversalTime()
- setLines()
- setLinksUpToDate()
- setManager()
- setNameOfApplication()
- setPages()
- setParagraphs()
- setRevisionNumber()
- setScaleCrop()
- setSubject()
- setTemplate()
- setTitle()
- setTotalEditingTime()
- setVersion()
- setWords()
Methods
add()
Reserved for internal use.
clear()
contains(name) → boolean
Returns true if a property with the specified name exists in the collection.
Parameter
| Name | Type | Optional | Description |
|---|---|---|---|
|
name |
String |
|
The case-insensitive name of the property. |
- Returns
-
booleanTrue if the property exists in the collection; false otherwise.
contains()
Reserved for internal use.
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.
Parameter
| Name | Type | Optional | Description |
|---|---|---|---|
|
name |
String |
|
The case-insensitive name of the property to retrieve. |
get(index)
Returns a DocumentProperty object by index.
Parameter
| Name | Type | Optional | Description |
|---|---|---|---|
|
index |
Number |
|
Zero-based index of the |
get()
Reserved for internal use.
getAuthor()
Gets or sets the name of the document's author.
getBytes()
Represents an estimate of the number of bytes in the document.
getCategory()
Gets or sets 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.
getComments()
Gets or sets the document comments.
getCompany()
Gets or sets the company property.
getContentStatus()
Gets or sets the content status of the document.
getContentType()
Gets or sets the content type of the document.
getCount()
getCreatedTime()
Gets or sets date of the document creation in local timezone. Aspose.Cells does not update this property when you modify the document.
getCreatedUniversalTime()
Gets or sets the Universal time of the document creation. Aspose.Cells does not update this property when you modify the document.
getDocumentVersion()
Represents the version of the file.
getHyperlinkBase()
Gets or sets the hyperlinkbase property.
getKeywords()
Gets or sets the document keywords.
getLanguage()
Gets or sets the document's language.
getLastPrinted()
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()
Gets or sets the Universal time when the document was last printed.
getLastSavedBy()
Gets or sets the name of the last author. Aspose.Cells does not update this property when you modify the document.
getLastSavedTime()
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()
Gets or sets the universal time of the last save. Aspose.Cells does not update this property when you modify the document.
getLines()
Represents an estimate of the number of lines in the document. Aspose.Cells does not update this property when you modify the document.
getLinksUpToDate()
Indicates whether hyperlinks in a document are up-to-date.
getManager()
Gets or sets the manager property.
getNameOfApplication()
Gets or sets 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 or sets the document revision number. Aspose.Cells does not update this property when you modify the document.
getScaleCrop()
Indicates the display mode of the document thumbnail.
getSubject()
Gets or sets the subject of the document.
getTemplate()
Gets or sets the informational name of the document template.
getTitle()
Gets or sets the title of the document.
getTotalEditingTime()
Gets or sets the total editing time in minutes.
getVersion()
Represents the version number of the application that created the document. It's format is "00.0000",for example : 12.0000
getWords()
Represents an estimate of the number of words in the document.
indexOf(name) → Number
Gets the index of a property by name.
Parameter
| Name | Type | Optional | Description |
|---|---|---|---|
|
name |
String |
|
The case-insensitive name of the property. |
- Returns
-
NumberThe zero based index. Negative value if not found.
indexOf()
Reserved for internal use.
iterator()
remove(name)
Removes a property with the specified name from the collection.
Parameter
| Name | Type | Optional | Description |
|---|---|---|---|
|
name |
String |
|
The case-insensitive name of the property. |
removeAt(index)
Removes a property at the specified index.
Parameter
| Name | Type | Optional | Description |
|---|---|---|---|
|
index |
Number |
|
The zero based index. |
setAuthor()
Gets or sets the name of the document's author.
setBytes()
Represents an estimate of the number of bytes in the document.
setCategory()
Gets or sets the category of the document.
setCharacters()
Represents an estimate of the number of characters in the document.
setCharactersWithSpaces()
Represents an estimate of the number of characters (including spaces) in the document.
setComments()
Gets or sets the document comments.
setCompany()
Gets or sets the company property.
setContentStatus()
Gets or sets the content status of the document.
setContentType()
Gets or sets the content type of the document.
setCreatedTime()
Gets or sets date of the document creation in local timezone. Aspose.Cells does not update this property when you modify the document.
setCreatedUniversalTime()
Gets or sets the Universal time of the document creation. Aspose.Cells does not update this property when you modify the document.
setDocumentVersion()
Represents the version of the file.
setHyperlinkBase()
Gets or sets the hyperlinkbase property.
setKeywords()
Gets or sets the document keywords.
setLanguage()
Gets or sets the document's language.
setLastPrinted()
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.
setLastPrintedUniversalTime()
Gets or sets the Universal time when the document was last printed.
setLastSavedBy()
Gets or sets the name of the last author. Aspose.Cells does not update this property when you modify the document.
setLastSavedTime()
Gets or sets the time of the last save in local timezone. Aspose.Cells does not update this property when you modify the document.
setLastSavedUniversalTime()
Gets or sets the universal time of the last save. Aspose.Cells does not update this property when you modify the document.
setLines()
Represents an estimate of the number of lines in the document. Aspose.Cells does not update this property when you modify the document.
setLinksUpToDate()
Indicates whether hyperlinks in a document are up-to-date.
setManager()
Gets or sets the manager property.
setNameOfApplication()
Gets or sets the name of the application.
setPages()
Represents an estimate of the number of pages in the document.
setParagraphs()
Represents an estimate of the number of paragraphs in the document.
setRevisionNumber()
Gets or sets the document revision number. Aspose.Cells does not update this property when you modify the document.
setScaleCrop()
Indicates the display mode of the document thumbnail.
setSubject()
Gets or sets the subject of the document.
setTemplate()
Gets or sets the informational name of the document template.
setTitle()
Gets or sets the title of the document.
setTotalEditingTime()
Gets or sets the total editing time in minutes.
setVersion()
Represents the version number of the application that created the document. It's format is "00.0000",for example : 12.0000
setWords()
Represents an estimate of the number of words in the document.