BuiltInDocumentProperties
Overview
BuiltInDocumentProperties is a class in Aspose.Words FOSS for Java.
Inherits from: DocumentPropertyCollection.
A collection of built-in document properties.
Edition status of its 111 listed members (a property and its accessor methods are listed separately, overloads once): 111 not yet exercised by a verified example.
This class declares 76 methods for BuiltInDocumentProperties objects in Java programs.
Available methods include: clear, contains, get, getAuthor, getBytes, getCategory, getCharacters, getCharactersWithSpaces, getComments, getCompany, getContentStatus, getContentType, and 63 additional methods.
Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package.
Properties: author, bytes, category, characters, charactersWithSpaces, comments, and 30 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
author | String | Read/Write | Gets or sets the name of the document’s author. |
bytes | int | Read/Write | Represents an estimate of the number of bytes in the document. |
characters | int | Read/Write | Represents an estimate of the number of characters in the document. |
charactersWithSpaces | int | Read/Write | Represents an estimate of the number of characters (including spaces) in the document. |
comments | String | Read/Write | Gets or sets the document comments. |
category | String | Read/Write | Gets or sets the category of the document. |
company | String | Read/Write | Gets or sets the company property. |
createdTime | java.util.Date | Read/Write | Gets or sets the created time. |
hyperlinkBase | String | Read/Write | Specifies the base string used for evaluating relative hyperlinks in this document. |
keywords | String | Read/Write | Gets or sets the document keywords. |
lastPrinted | java.util.Date | Read/Write | Gets or sets the last printed. |
lastSavedBy | String | Read/Write | Gets or sets the name of the last author. |
lastSavedTime | java.util.Date | Read/Write | Gets or sets the last saved time. |
lines | int | Read/Write | Represents an estimate of the number of lines in the document. |
linksUpToDate | boolean | Read/Write | Indicates whether hyperlinks in a document are up-to-date. |
scaleCrop | boolean | Read | Indicates whether document thumbnail is cropped or scaled to fit the display. |
sharedDocument | boolean | Read | Indicates whether the document is a shared document. |
hyperlinksChanged | boolean | Read | Indicates whether hyperlinks in a document were changed. |
manager | String | Read/Write | Gets or sets the manager property. |
nameOfApplication | String | Read/Write | Gets or sets the name of the application. |
pages | int | Read/Write | Represents an estimate of the number of pages in the document. |
paragraphs | int | Read/Write | Represents an estimate of the number of paragraphs in the document. |
revisionNumber | int | Read/Write | Gets or sets the document revision number. |
security | int | Read/Write | Specifies the security level of a document as a numeric value. |
subject | String | Read/Write | Gets or sets the subject of the document. |
template | String | Read/Write | Gets or sets the informational name of the document template. |
thumbnail | byte[] | Read/Write | Gets or sets the thumbnail. |
title | String | Read/Write | Gets or sets the title of the document. |
totalEditingTime | int | Read/Write | Gets or sets the total editing time in minutes. |
contentType | String | Read/Write | Gets or sets the content type of the document. |
contentStatus | String | Read/Write | Gets or sets the content status of the document. |
version | int | Read/Write | Represents the version number of the application that created the document. |
words | int | Read/Write | Represents an estimate of the number of words in the document. |
headingPairs | Object[] | Read/Write | Gets or sets the heading pairs. |
titlesOfParts | String[] | Read/Write | Gets or sets the titles of parts. |
count | int | Read | Gets number of items in the collection. |
Methods
| Signature | Description |
|---|---|
get(name: String) → DocumentProperty | Returns a DocumentProperty object by the name of the property. |
getAuthor() → String | Gets or sets the name of the document’s author. |
setAuthor(value: String) | Sets the author value. |
getBytes() → int | Represents an estimate of the number of bytes in the document. |
setBytes(value: int) | Sets the bytes value. |
getCharacters() → int | Represents an estimate of the number of characters in the document. |
setCharacters(value: int) | Sets the characters value. |
getCharactersWithSpaces() → int | Represents an estimate of the number of characters (including spaces) in the document. |
setCharactersWithSpaces(value: int) | Sets the characters with spaces value. |
getComments() → String | Gets or sets the document comments. |
setComments(value: String) | Sets the comments value. |
getCategory() → String | Gets or sets the category of the document. |
setCategory(value: String) | Sets the category value. |
getCompany() → String | Gets or sets the company property. |
setCompany(value: String) | Sets the company value. |
getCreatedTime() → java.util.Date | Returns the created time. |
setCreatedTime(value: java.util.Date) | Sets the created time value. |
getHyperlinkBase() → String | Specifies the base string used for evaluating relative hyperlinks in this document. |
setHyperlinkBase(value: String) | Sets the hyperlink base value. |
getKeywords() → String | Gets or sets the document keywords. |
setKeywords(value: String) | Sets the keywords value. |
getLastPrinted() → java.util.Date | Returns the last printed. |
setLastPrinted(value: java.util.Date) | Sets the last printed value. |
getLastSavedBy() → String | Gets or sets the name of the last author. |
setLastSavedBy(value: String) | Sets the last saved by value. |
getLastSavedTime() → java.util.Date | Returns the last saved time. |
setLastSavedTime(value: java.util.Date) | Sets the last saved time value. |
getLines() → int | Represents an estimate of the number of lines in the document. |
setLines(value: int) | Sets the lines value. |
getLinksUpToDate() → boolean | Indicates whether hyperlinks in a document are up-to-date. |
setLinksUpToDate(value: boolean) | Sets the links up to date value. |
getScaleCrop() → boolean | Indicates whether document thumbnail is cropped or scaled to fit the display. |
getSharedDocument() → boolean | Indicates whether the document is a shared document. |
getHyperlinksChanged() → boolean | Indicates whether hyperlinks in a document were changed. |
getManager() → String | Gets or sets the manager property. |
setManager(value: String) | Sets the manager value. |
getNameOfApplication() → String | Gets or sets the name of the application. |
setNameOfApplication(value: String) | Sets the name of application value. |
getPages() → int | Represents an estimate of the number of pages in the document. |
setPages(value: int) | Sets the pages value. |
getParagraphs() → int | Represents an estimate of the number of paragraphs in the document. |
setParagraphs(value: int) | Sets the paragraphs value. |
getRevisionNumber() → int | Gets or sets the document revision number. |
setRevisionNumber(value: int) | Sets the revision number value. |
getSecurity() → int | Specifies the security level of a document as a numeric value. |
setSecurity(value: int) | Sets the security value. |
getSubject() → String | Gets or sets the subject of the document. |
setSubject(value: String) | Sets the subject value. |
getTemplate() → String | Gets or sets the informational name of the document template. |
setTemplate(value: String) | Sets the template value. |
getThumbnail() → byte[] | Returns the thumbnail. |
setThumbnail(value: byte[]) | Sets the thumbnail value. |
getTitle() → String | Gets or sets the title of the document. |
setTitle(value: String) | Sets the title value. |
getTotalEditingTime() → int | Gets or sets the total editing time in minutes. |
setTotalEditingTime(value: int) | Sets the total editing time value. |
getContentType() → String | Gets or sets the content type of the document. |
setContentType(value: String) | Sets the content type value. |
getContentStatus() → String | Gets or sets the content status of the document. |
setContentStatus(value: String) | Sets the content status value. |
getVersion() → int | Represents the version number of the application that created the document. |
setVersion(value: int) | Sets the version value. |
getWords() → int | Represents an estimate of the number of words in the document. |
setWords(value: int) | Sets the words value. |
getHeadingPairs() → Object[] | Returns the heading pairs. |
setHeadingPairs(value: Object[]) | Sets the heading pairs value. |
getTitlesOfParts() → String[] | Returns the titles of parts. |
setTitlesOfParts(value: String[]) | Sets the titles of parts value. |
getCount() → int | Gets number of items in the collection. |
get(index: int) → DocumentProperty | Returns a DocumentProperty object by index. |
iterator() → Iterator<DocumentProperty> | Returns an iterator object that can be used to iterate over all items in the collection. |
contains(name: String) → boolean | Returns true if a property with the specified name exists in the collection. |
indexOf(name: String) → int | Gets the index of a property by name. |
remove(name: String) | Removes a property with the specified name from the collection. |
removeAt(index: int) | Removes a property at the specified index. |
clear() | Removes all properties from the collection. |