BuiltInDocumentProperties

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

NameTypeAccessDescription
authorStringRead/WriteGets or sets the name of the document’s author.
bytesintRead/WriteRepresents an estimate of the number of bytes in the document.
charactersintRead/WriteRepresents an estimate of the number of characters in the document.
charactersWithSpacesintRead/WriteRepresents an estimate of the number of characters (including spaces) in the document.
commentsStringRead/WriteGets or sets the document comments.
categoryStringRead/WriteGets or sets the category of the document.
companyStringRead/WriteGets or sets the company property.
createdTimejava.util.DateRead/WriteGets or sets the created time.
hyperlinkBaseStringRead/WriteSpecifies the base string used for evaluating relative hyperlinks in this document.
keywordsStringRead/WriteGets or sets the document keywords.
lastPrintedjava.util.DateRead/WriteGets or sets the last printed.
lastSavedByStringRead/WriteGets or sets the name of the last author.
lastSavedTimejava.util.DateRead/WriteGets or sets the last saved time.
linesintRead/WriteRepresents an estimate of the number of lines in the document.
linksUpToDatebooleanRead/WriteIndicates whether hyperlinks in a document are up-to-date.
scaleCropbooleanReadIndicates whether document thumbnail is cropped or scaled to fit the display.
sharedDocumentbooleanReadIndicates whether the document is a shared document.
hyperlinksChangedbooleanReadIndicates whether hyperlinks in a document were changed.
managerStringRead/WriteGets or sets the manager property.
nameOfApplicationStringRead/WriteGets or sets the name of the application.
pagesintRead/WriteRepresents an estimate of the number of pages in the document.
paragraphsintRead/WriteRepresents an estimate of the number of paragraphs in the document.
revisionNumberintRead/WriteGets or sets the document revision number.
securityintRead/WriteSpecifies the security level of a document as a numeric value.
subjectStringRead/WriteGets or sets the subject of the document.
templateStringRead/WriteGets or sets the informational name of the document template.
thumbnailbyte[]Read/WriteGets or sets the thumbnail.
titleStringRead/WriteGets or sets the title of the document.
totalEditingTimeintRead/WriteGets or sets the total editing time in minutes.
contentTypeStringRead/WriteGets or sets the content type of the document.
contentStatusStringRead/WriteGets or sets the content status of the document.
versionintRead/WriteRepresents the version number of the application that created the document.
wordsintRead/WriteRepresents an estimate of the number of words in the document.
headingPairsObject[]Read/WriteGets or sets the heading pairs.
titlesOfPartsString[]Read/WriteGets or sets the titles of parts.
countintReadGets number of items in the collection.

Methods

SignatureDescription
get(name: String) → DocumentPropertyReturns a DocumentProperty object by the name of the property.
getAuthor() → StringGets or sets the name of the document’s author.
setAuthor(value: String)Sets the author value.
getBytes() → intRepresents an estimate of the number of bytes in the document.
setBytes(value: int)Sets the bytes value.
getCharacters() → intRepresents an estimate of the number of characters in the document.
setCharacters(value: int)Sets the characters value.
getCharactersWithSpaces() → intRepresents an estimate of the number of characters (including spaces) in the document.
setCharactersWithSpaces(value: int)Sets the characters with spaces value.
getComments() → StringGets or sets the document comments.
setComments(value: String)Sets the comments value.
getCategory() → StringGets or sets the category of the document.
setCategory(value: String)Sets the category value.
getCompany() → StringGets or sets the company property.
setCompany(value: String)Sets the company value.
getCreatedTime() → java.util.DateReturns the created time.
setCreatedTime(value: java.util.Date)Sets the created time value.
getHyperlinkBase() → StringSpecifies the base string used for evaluating relative hyperlinks in this document.
setHyperlinkBase(value: String)Sets the hyperlink base value.
getKeywords() → StringGets or sets the document keywords.
setKeywords(value: String)Sets the keywords value.
getLastPrinted() → java.util.DateReturns the last printed.
setLastPrinted(value: java.util.Date)Sets the last printed value.
getLastSavedBy() → StringGets or sets the name of the last author.
setLastSavedBy(value: String)Sets the last saved by value.
getLastSavedTime() → java.util.DateReturns the last saved time.
setLastSavedTime(value: java.util.Date)Sets the last saved time value.
getLines() → intRepresents an estimate of the number of lines in the document.
setLines(value: int)Sets the lines value.
getLinksUpToDate() → booleanIndicates whether hyperlinks in a document are up-to-date.
setLinksUpToDate(value: boolean)Sets the links up to date value.
getScaleCrop() → booleanIndicates whether document thumbnail is cropped or scaled to fit the display.
getSharedDocument() → booleanIndicates whether the document is a shared document.
getHyperlinksChanged() → booleanIndicates whether hyperlinks in a document were changed.
getManager() → StringGets or sets the manager property.
setManager(value: String)Sets the manager value.
getNameOfApplication() → StringGets or sets the name of the application.
setNameOfApplication(value: String)Sets the name of application value.
getPages() → intRepresents an estimate of the number of pages in the document.
setPages(value: int)Sets the pages value.
getParagraphs() → intRepresents an estimate of the number of paragraphs in the document.
setParagraphs(value: int)Sets the paragraphs value.
getRevisionNumber() → intGets or sets the document revision number.
setRevisionNumber(value: int)Sets the revision number value.
getSecurity() → intSpecifies the security level of a document as a numeric value.
setSecurity(value: int)Sets the security value.
getSubject() → StringGets or sets the subject of the document.
setSubject(value: String)Sets the subject value.
getTemplate() → StringGets 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() → StringGets or sets the title of the document.
setTitle(value: String)Sets the title value.
getTotalEditingTime() → intGets or sets the total editing time in minutes.
setTotalEditingTime(value: int)Sets the total editing time value.
getContentType() → StringGets or sets the content type of the document.
setContentType(value: String)Sets the content type value.
getContentStatus() → StringGets or sets the content status of the document.
setContentStatus(value: String)Sets the content status value.
getVersion() → intRepresents the version number of the application that created the document.
setVersion(value: int)Sets the version value.
getWords() → intRepresents 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() → intGets number of items in the collection.
get(index: int) → DocumentPropertyReturns 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) → booleanReturns true if a property with the specified name exists in the collection.
indexOf(name: String) → intGets 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.

See Also