BuiltInDocumentProperties (Aspose.Words for Java API Reference)

java.lang.Object
- com.aspose.words.DocumentPropertyCollection
- - com.aspose.words.BuiltInDocumentProperties

All Implemented Interfaces:

java.lang.Iterable
```
public class BuiltInDocumentProperties
extends DocumentPropertyCollection
```
A collection of built-in document properties.
To learn more, visit the Work with Document Properties documentation article.

Provides access to DocumentProperty objects by their names (using an indexer) and via a set of typed properties that return values of appropriate types.

The names of the properties are case-insensitive.

The properties in the collection are sorted alphabetically by name.

See Also:

Document, Document.getBuiltInDocumentProperties(), Document.getCustomDocumentProperties()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DocumentProperty`	`get(java.lang.String name)` Returns a `DocumentProperty` object.
`java.lang.String`	`getAuthor()` Gets the name of the document's author.
`int`	`getBytes()` Represents an estimate of the number of bytes in the document.
`java.lang.String`	`getCategory()` Gets the category of the document.
`int`	`getCharacters()` Represents an estimate of the number of characters in the document.
`int`	`getCharactersWithSpaces()` Represents an estimate of the number of characters (including spaces) in the document.
`java.lang.String`	`getComments()` Gets the document comments.
`java.lang.String`	`getCompany()` Gets the company property.
`java.lang.String`	`getContentStatus()` Gets the ContentStatus of the document.
`java.lang.String`	`getContentType()` Gets the ContentStatus of the document.
`java.util.Date`	`getCreatedTime()` Gets date of the document creation in UTC.
`java.lang.Object[]`	`getHeadingPairs()` Specifies document headings and their names.
`java.lang.String`	`getHyperlinkBase()` Specifies the base string used for evaluating relative hyperlinks in this document.
`java.lang.String`	`getKeywords()` Gets the document keywords.
`java.util.Date`	`getLastPrinted()` Gets the date when the document was last printed in UTC.
`java.lang.String`	`getLastSavedBy()` Gets the name of the last author.
`java.util.Date`	`getLastSavedTime()` Gets the time of the last save in UTC.
`int`	`getLines()` Represents an estimate of the number of lines in the document.
`boolean`	`getLinksUpToDate()` Indicates whether hyperlinks in a document are up-to-date.
`java.lang.String`	`getManager()` Gets the manager property.
`java.lang.String`	`getNameOfApplication()` Gets the name of the application.
`int`	`getPages()` Represents an estimate of the number of pages in the document.
`int`	`getParagraphs()` Represents an estimate of the number of paragraphs in the document.
`int`	`getRevisionNumber()` Gets the document revision number.
`int`	`getSecurity()` Specifies the security level of a document as a numeric value.
`java.lang.String`	`getSubject()` Gets the subject of the document.
`java.lang.String`	`getTemplate()` Gets the informational name of the document template.
`byte[]`	`getThumbnail()` Gets or sets the thumbnail of the document.
`java.lang.String`	`getTitle()` Gets the title of the document.
`java.lang.String[]`	`getTitlesOfParts()` Each string in the array specifies the name of a part in the document.
`int`	`getTotalEditingTime()` Gets the total editing time in minutes.
`int`	`getVersion()` Represents the version number of the application that created the document.
`int`	`getWords()` Represents an estimate of the number of words in the document.
`void`	`setAuthor(java.lang.String value)` Sets the name of the document's author.
`void`	`setBytes(int value)` Represents an estimate of the number of bytes in the document.
`void`	`setCategory(java.lang.String value)` Sets the category of the document.
`void`	`setCharacters(int value)` Represents an estimate of the number of characters in the document.
`void`	`setCharactersWithSpaces(int value)` Represents an estimate of the number of characters (including spaces) in the document.
`void`	`setComments(java.lang.String value)` Sets the document comments.
`void`	`setCompany(java.lang.String value)` Sets the company property.
`void`	`setContentStatus(java.lang.String value)` Sets the ContentStatus of the document.
`void`	`setContentType(java.lang.String value)` Sets the ContentStatus of the document.
`void`	`setCreatedTime(java.util.Date value)` Sets date of the document creation in UTC.
`void`	`setHeadingPairs(java.lang.Object[] value)` Specifies document headings and their names.
`void`	`setHyperlinkBase(java.lang.String value)` Specifies the base string used for evaluating relative hyperlinks in this document.
`void`	`setKeywords(java.lang.String value)` Sets the document keywords.
`void`	`setLastPrinted(java.util.Date value)` Sets the date when the document was last printed in UTC.
`void`	`setLastSavedBy(java.lang.String value)` Sets the name of the last author.
`void`	`setLastSavedTime(java.util.Date value)` Sets the time of the last save in UTC.
`void`	`setLines(int value)` Represents an estimate of the number of lines in the document.
`void`	`setLinksUpToDate(boolean value)` Indicates whether hyperlinks in a document are up-to-date.
`void`	`setManager(java.lang.String value)` Sets the manager property.
`void`	`setNameOfApplication(java.lang.String value)` Sets the name of the application.
`void`	`setPages(int value)` Represents an estimate of the number of pages in the document.
`void`	`setParagraphs(int value)` Represents an estimate of the number of paragraphs in the document.
`void`	`setRevisionNumber(int value)` Sets the document revision number.
`void`	`setSecurity(int value)` Specifies the security level of a document as a numeric value.
`void`	`setSubject(java.lang.String value)` Sets the subject of the document.
`void`	`setTemplate(java.lang.String value)` Sets the informational name of the document template.
`void`	`setThumbnail(byte[] value)` Gets or sets the thumbnail of the document.
`void`	`setTitle(java.lang.String value)` Sets the title of the document.
`void`	`setTitlesOfParts(java.lang.String[] value)` Each string in the array specifies the name of a part in the document.
`void`	`setTotalEditingTime(int value)` Sets the total editing time in minutes.
`void`	`setVersion(int value)` Represents the version number of the application that created the document.
`void`	`setWords(int value)` Represents an estimate of the number of words in the document.

Methods inherited from class com.aspose.words.DocumentPropertyCollection
clear, contains, get, getCount, indexOf, iterator, remove, removeAt

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Method Detail
  - get
```
public DocumentProperty get(java.lang.String name)
```
    Returns a DocumentProperty object. 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 BuiltInDocumentProperties.
    
    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.
    
    Overrides:
    
    get in class DocumentPropertyCollection
    
    Parameters:
    
    name - The case-insensitive name of the property to retrieve.
    
    Returns:
    
    The corresponding DocumentProperty value.
  - getAuthor
```
public java.lang.String getAuthor()
```
    Gets the name of the document's author.
    
    Returns:
    
    The name of the document's author.
  - setAuthor
```
public void setAuthor(java.lang.String value)
```
    Sets the name of the document's author.
    
    Parameters:
    
    value - The name of the document's author.
  - getBytes
```
public int getBytes()
```
    Represents an estimate of the number of bytes in the document.
    Microsoft Word does not always set this property.
    
    Aspose.Words does not update this property.
    
    Returns:
    
    The corresponding int value.
  - setBytes
```
public void setBytes(int value)
```
    Represents an estimate of the number of bytes in the document.
    Microsoft Word does not always set this property.
    
    Aspose.Words does not update this property.
    
    Parameters:
    
    value - The corresponding int value.
  - getCharacters
```
public int getCharacters()
```
    Represents an estimate of the number of characters in the document.
    Aspose.Words updates this property when you call Document.updateWordCount().
    
    Returns:
    
    The corresponding int value.
  - setCharacters
```
public void setCharacters(int value)
```
    Represents an estimate of the number of characters in the document.
    Aspose.Words updates this property when you call Document.updateWordCount().
    
    Parameters:
    
    value - The corresponding int value.
  - getCharactersWithSpaces
```
public int getCharactersWithSpaces()
```
    Represents an estimate of the number of characters (including spaces) in the document.
    Aspose.Words updates this property when you call Document.updateWordCount().
    
    Returns:
    
    The corresponding int value.
  - setCharactersWithSpaces
```
public void setCharactersWithSpaces(int value)
```
    Represents an estimate of the number of characters (including spaces) in the document.
    Aspose.Words updates this property when you call Document.updateWordCount().
    
    Parameters:
    
    value - The corresponding int value.
  - getComments
```
public java.lang.String getComments()
```
    Gets the document comments.
    
    Returns:
    
    The document comments.
  - setComments
```
public void setComments(java.lang.String value)
```
    Sets the document comments.
    
    Parameters:
    
    value - The document comments.
  - getCategory
```
public java.lang.String getCategory()
```
    Gets the category of the document.
    
    Returns:
    
    The category of the document.
  - setCategory
```
public void setCategory(java.lang.String value)
```
    Sets the category of the document.
    
    Parameters:
    
    value - The category of the document.
  - getCompany
```
public java.lang.String getCompany()
```
    Gets the company property.
    
    Returns:
    
    The company property.
  - setCompany
```
public void setCompany(java.lang.String value)
```
    Sets the company property.
    
    Parameters:
    
    value - The company property.
  - getCreatedTime
```
public java.util.Date getCreatedTime()
```
    Gets date of the document creation in UTC.
    For documents originated from RTF format this property returns local time of the author's machine at the moment of document creation.
    
    Aspose.Words does not update this property.
    
    Returns:
    
    Date of the document creation in UTC.
  - setCreatedTime
```
public void setCreatedTime(java.util.Date value)
```
    Sets date of the document creation in UTC.
    For documents originated from RTF format this property returns local time of the author's machine at the moment of document creation.
    
    Aspose.Words does not update this property.
    
    Parameters:
    
    value - Date of the document creation in UTC.
  - getHyperlinkBase
```
public java.lang.String getHyperlinkBase()
```
    Specifies the base string used for evaluating relative hyperlinks in this document.
    Aspose.Words does not use this property.
    
    Returns:
    
    The corresponding String value.
  - setHyperlinkBase
```
public void setHyperlinkBase(java.lang.String value)
```
    Specifies the base string used for evaluating relative hyperlinks in this document.
    Aspose.Words does not use this property.
    
    Parameters:
    
    value - The corresponding String value.
  - getKeywords
```
public java.lang.String getKeywords()
```
    Gets the document keywords.
    
    Returns:
    
    The document keywords.
  - setKeywords
```
public void setKeywords(java.lang.String value)
```
    Sets the document keywords.
    
    Parameters:
    
    value - The document keywords.
  - getLastPrinted
```
public java.util.Date getLastPrinted()
```
    Gets the date when the document was last printed in UTC.
    For documents originated from RTF format this property returns the local time of last print operation.
    
    If the document was never printed, this property will return DateTime.MinValue.
    
    Aspose.Words does not update this property.
    
    Returns:
    
    The date when the document was last printed in UTC.
  - setLastPrinted
```
public void setLastPrinted(java.util.Date value)
```
    Sets the date when the document was last printed in UTC.
    For documents originated from RTF format this property returns the local time of last print operation.
    
    If the document was never printed, this property will return DateTime.MinValue.
    
    Aspose.Words does not update this property.
    
    Parameters:
    
    value - The date when the document was last printed in UTC.
  - getLastSavedBy
```
public java.lang.String getLastSavedBy()
```
    Gets the name of the last author.
    Aspose.Words does not update this property.
    
    Returns:
    
    The name of the last author.
  - setLastSavedBy
```
public void setLastSavedBy(java.lang.String value)
```
    Sets the name of the last author.
    Aspose.Words does not update this property.
    
    Parameters:
    
    value - The name of the last author.
  - getLastSavedTime
```
public java.util.Date getLastSavedTime()
```
    Gets the time of the last save in UTC.
    For documents originated from RTF format this property returns the local time of last save operation.
    
    Aspose.Words does not update this property.
    
    Returns:
    
    The time of the last save in UTC.
  - setLastSavedTime
```
public void setLastSavedTime(java.util.Date value)
```
    Sets the time of the last save in UTC.
    For documents originated from RTF format this property returns the local time of last save operation.
    
    Aspose.Words does not update this property.
    
    Parameters:
    
    value - The time of the last save in UTC.
  - getLines
```
public int getLines()
```
    Represents an estimate of the number of lines in the document.
    Aspose.Words updates this property when you call Document.updateWordCount(boolean).
    
    Returns:
    
    The corresponding int value.
  - setLines
```
public void setLines(int value)
```
    Represents an estimate of the number of lines in the document.
    Aspose.Words updates this property when you call Document.updateWordCount(boolean).
    
    Parameters:
    
    value - The corresponding int value.
  - getLinksUpToDate
```
public boolean getLinksUpToDate()
```
    Indicates whether hyperlinks in a document are up-to-date.
    Aspose.Words does not update this property.
    
    Returns:
    
    The corresponding boolean value.
  - setLinksUpToDate
```
public void setLinksUpToDate(boolean value)
```
    Indicates whether hyperlinks in a document are up-to-date.
    Aspose.Words does not update this property.
    
    Parameters:
    
    value - The corresponding boolean value.
  - getManager
```
public java.lang.String getManager()
```
    Gets the manager property.
    
    Returns:
    
    The manager property.
  - setManager
```
public void setManager(java.lang.String value)
```
    Sets the manager property.
    
    Parameters:
    
    value - The manager property.
  - getNameOfApplication
```
public java.lang.String getNameOfApplication()
```
    Gets the name of the application.
    
    Returns:
    
    The name of the application.
  - setNameOfApplication
```
public void setNameOfApplication(java.lang.String value)
```
    Sets the name of the application.
    
    Parameters:
    
    value - The name of the application.
  - getPages
```
public int getPages()
```
    Represents an estimate of the number of pages in the document.
    Aspose.Words updates this property when you call Document.updatePageLayout().
    
    Returns:
    
    The corresponding int value.
  - setPages
```
public void setPages(int value)
```
    Represents an estimate of the number of pages in the document.
    Aspose.Words updates this property when you call Document.updatePageLayout().
    
    Parameters:
    
    value - The corresponding int value.
  - getParagraphs
```
public int getParagraphs()
```
    Represents an estimate of the number of paragraphs in the document.
    Aspose.Words updates this property when you call Document.updateWordCount().
    
    Returns:
    
    The corresponding int value.
  - setParagraphs
```
public void setParagraphs(int value)
```
    Represents an estimate of the number of paragraphs in the document.
    Aspose.Words updates this property when you call Document.updateWordCount().
    
    Parameters:
    
    value - The corresponding int value.
  - getRevisionNumber
```
public int getRevisionNumber()
```
    Gets the document revision number.
    Aspose.Words does not update this property.
    
    Returns:
    
    The document revision number.
  - setRevisionNumber
```
public void setRevisionNumber(int value)
```
    Sets the document revision number.
    Aspose.Words does not update this property.
    
    Parameters:
    
    value - The document revision number.
  - getSecurity
```
public int getSecurity()
```
    Specifies the security level of a document as a numeric value.
    Use this property for informational purposes only because Microsoft Word does not always set this property. This property is available in DOC and OOXML documents only.
    
    To protect or unprotect a document use the M:Aspose.Words.Document.Protect(Aspose.Words.ProtectionType,System.String) and Document.unprotect() methods.
    
    Aspose.Words updates this property to a correct value before saving a document.
    
    Returns:
    
    The corresponding int value. The returned value is a bitwise combination of DocumentSecurity constants.
  - setSecurity
```
public void setSecurity(int value)
```
    Specifies the security level of a document as a numeric value.
    Use this property for informational purposes only because Microsoft Word does not always set this property. This property is available in DOC and OOXML documents only.
    
    To protect or unprotect a document use the M:Aspose.Words.Document.Protect(Aspose.Words.ProtectionType,System.String) and Document.unprotect() methods.
    
    Aspose.Words updates this property to a correct value before saving a document.
    
    Parameters:
    
    value - The corresponding int value. The value must be a bitwise combination of DocumentSecurity constants.
  - getSubject
```
public java.lang.String getSubject()
```
    Gets the subject of the document.
    
    Returns:
    
    The subject of the document.
  - setSubject
```
public void setSubject(java.lang.String value)
```
    Sets the subject of the document.
    
    Parameters:
    
    value - The subject of the document.
  - getTemplate
```
public java.lang.String getTemplate()
```
    Gets the informational name of the document template.
    In Microsoft Word, this property is for informational purposes only and usually contains only the file name of the template without the path.
    
    Empty string means the document is attached to the Normal template.
    
    To get or set the actual name of the attached template, use the Document.getAttachedTemplate() / Document.setAttachedTemplate(java.lang.String) property.
    
    Returns:
    
    The informational name of the document template.
    
    See Also:
    
    Document.getAttachedTemplate(), Document.setAttachedTemplate(java.lang.String)
  - setTemplate
```
public void setTemplate(java.lang.String value)
```
    Sets the informational name of the document template.
    In Microsoft Word, this property is for informational purposes only and usually contains only the file name of the template without the path.
    
    Empty string means the document is attached to the Normal template.
    
    To get or set the actual name of the attached template, use the Document.getAttachedTemplate() / Document.setAttachedTemplate(java.lang.String) property.
    
    Parameters:
    
    value - The informational name of the document template.
    
    See Also:
    
    Document.getAttachedTemplate(), Document.setAttachedTemplate(java.lang.String)
  - getThumbnail
```
public byte[] getThumbnail()
```
    Gets or sets the thumbnail of the document.
    
    For now this property is used only when a document is being exported to ePub, it's not read from and written to other document formats.
    
    Image of arbitrary format can be set to this property, but the format is checked during export. IllegalStateException is thrown if the image is invalid or its format is unsupported for specific format of document.
    
    Only gif, jpeg and png images can be used for ePub publication.
    
    Returns:
    
    The corresponding byte[] value.
  - setThumbnail
```
public void setThumbnail(byte[] value)
```
    Gets or sets the thumbnail of the document.
    
    For now this property is used only when a document is being exported to ePub, it's not read from and written to other document formats.
    
    Image of arbitrary format can be set to this property, but the format is checked during export. IllegalStateException is thrown if the image is invalid or its format is unsupported for specific format of document.
    
    Only gif, jpeg and png images can be used for ePub publication.
    
    Parameters:
    
    value - The corresponding byte[] value.
  - getTitle
```
public java.lang.String getTitle()
```
    Gets the title of the document.
    
    Returns:
    
    The title of the document.
  - setTitle
```
public void setTitle(java.lang.String value)
```
    Sets the title of the document.
    
    Parameters:
    
    value - The title of the document.
  - getTotalEditingTime
```
public int getTotalEditingTime()
```
    Gets the total editing time in minutes.
    
    Returns:
    
    The total editing time in minutes.
  - setTotalEditingTime
```
public void setTotalEditingTime(int value)
```
    Sets the total editing time in minutes.
    
    Parameters:
    
    value - The total editing time in minutes.
  - getContentType
```
public java.lang.String getContentType()
```
    Gets the ContentStatus of the document.
    
    Returns:
    
    The ContentStatus of the document.
  - setContentType
```
public void setContentType(java.lang.String value)
```
    Sets the ContentStatus of the document.
    
    Parameters:
    
    value - The ContentStatus of the document.
  - getContentStatus
```
public java.lang.String getContentStatus()
```
    Gets the ContentStatus of the document.
    
    Returns:
    
    The ContentStatus of the document.
  - setContentStatus
```
public void setContentStatus(java.lang.String value)
```
    Sets the ContentStatus of the document.
    
    Parameters:
    
    value - The ContentStatus of the document.
  - getVersion
```
public int getVersion()
```
    Represents the version number of the application that created the document.
    When a document was created by Microsoft Word, then high 16 bit represent the major version and low 16 bit represent the build number.
    
    Returns:
    
    The corresponding int value.
  - setVersion
```
public void setVersion(int value)
```
    Represents the version number of the application that created the document.
    When a document was created by Microsoft Word, then high 16 bit represent the major version and low 16 bit represent the build number.
    
    Parameters:
    
    value - The corresponding int value.
  - getWords
```
public int getWords()
```
    Represents an estimate of the number of words in the document.
    Aspose.Words updates this property when you call Document.updateWordCount().
    
    Returns:
    
    The corresponding int value.
  - setWords
```
public void setWords(int value)
```
    Represents an estimate of the number of words in the document.
    Aspose.Words updates this property when you call Document.updateWordCount().
    
    Parameters:
    
    value - The corresponding int value.
  - getHeadingPairs
```
public java.lang.Object[] getHeadingPairs()
```
    Specifies document headings and their names.
    Every heading pair occupies two elements in this array.
    
    The first element of the pair is a String and specifies the heading name. The second element of the pair is an int and specifies the count of document parts for this heading in the getTitlesOfParts() / setTitlesOfParts(java.lang.String[]) property.
    
    The total sum of counts for all heading pairs in this property must be equal to the number of elements in the getTitlesOfParts() / setTitlesOfParts(java.lang.String[]) property.
    
    Aspose.Words does not update this property.
    
    Returns:
    
    The corresponding java.lang.Object[] value.
    
    See Also:
    
    getTitlesOfParts(), setTitlesOfParts(java.lang.String[])
  - setHeadingPairs
```
public void setHeadingPairs(java.lang.Object[] value)
```
    Specifies document headings and their names.
    Every heading pair occupies two elements in this array.
    
    The first element of the pair is a String and specifies the heading name. The second element of the pair is an int and specifies the count of document parts for this heading in the getTitlesOfParts() / setTitlesOfParts(java.lang.String[]) property.
    
    The total sum of counts for all heading pairs in this property must be equal to the number of elements in the getTitlesOfParts() / setTitlesOfParts(java.lang.String[]) property.
    
    Aspose.Words does not update this property.
    
    Parameters:
    
    value - The corresponding java.lang.Object[] value.
    
    See Also:
    
    getTitlesOfParts(), setTitlesOfParts(java.lang.String[])
  - getTitlesOfParts
```
public java.lang.String[] getTitlesOfParts()
```
    Each string in the array specifies the name of a part in the document.
    Aspose.Words does not update this property.
    
    Returns:
    
    The corresponding java.lang.String[] value.
    
    See Also:
    
    getHeadingPairs(), setHeadingPairs(java.lang.Object[])
  - setTitlesOfParts
```
public void setTitlesOfParts(java.lang.String[] value)
```
    Each string in the array specifies the name of a part in the document.
    Aspose.Words does not update this property.
    
    Parameters:
    
    value - The corresponding java.lang.String[] value.
    
    See Also:
    
    getHeadingPairs(), setHeadingPairs(java.lang.Object[])

Class BuiltInDocumentProperties

Method Summary

Methods inherited from class com.aspose.words.DocumentPropertyCollection

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Method Detail

get

getAuthor

setAuthor

getBytes

setBytes

getCharacters

setCharacters

getCharactersWithSpaces

setCharactersWithSpaces

getComments

setComments

getCategory

setCategory

getCompany

setCompany

getCreatedTime

setCreatedTime

getHyperlinkBase

setHyperlinkBase

getKeywords

setKeywords

getLastPrinted

setLastPrinted

getLastSavedBy

setLastSavedBy

getLastSavedTime

setLastSavedTime

getLines

setLines

getLinksUpToDate

setLinksUpToDate

getManager

setManager

getNameOfApplication

setNameOfApplication

getPages

setPages

getParagraphs

setParagraphs

getRevisionNumber

setRevisionNumber

getSecurity

setSecurity

getSubject

setSubject

getTemplate

setTemplate

getThumbnail

setThumbnail

getTitle

setTitle

getTotalEditingTime

setTotalEditingTime

getContentType

setContentType

getContentStatus

setContentStatus

getVersion

setVersion

getWords

setWords

getHeadingPairs

setHeadingPairs

getTitlesOfParts

setTitlesOfParts