ASPOSE home

com.aspose.words
Class BuiltInDocumentProperties

java.lang.Object
  extended by DocumentProperties
      extended by com.aspose.words.BuiltInDocumentProperties
All Implemented Interfaces:
java.lang.Cloneable, java.lang.Iterable

public class BuiltInDocumentProperties
extends DocumentProperties

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.

The names of the properties are case-insensitive.

The properties in the collection are sorted alphabetically by name.

See Also:
Document, Document.BuiltInDocumentProperties, Document.CustomDocumentProperties

Property Getters/Setters Summary
java.lang.StringgetAuthor()
voidsetAuthor(java.lang.String value)
           Gets or sets the name of the document's author.
intgetBytes()
voidsetBytes(int value)
           Represents an estimate of the number of bytes in the document.
java.lang.StringgetCategory()
voidsetCategory(java.lang.String value)
           Gets or sets the category of the document.
intgetCharacters()
voidsetCharacters(int value)
           Represents an estimate of the number of characters in the document.
intgetCharactersWithSpaces()
voidsetCharactersWithSpaces(int value)
           Represents an estimate of the number of characters (including spaces) in the document.
java.lang.StringgetComments()
voidsetComments(java.lang.String value)
           Gets or sets the document comments.
java.lang.StringgetCompany()
voidsetCompany(java.lang.String value)
           Gets or sets the company property.
intgetCount()→ inherited from DocumentProperties
           Gets number of items in the collection.
java.util.DategetCreatedTime()
voidsetCreatedTime(java.util.Date value)
           Gets or sets date of the document creation in UTC.
java.lang.StringgetKeywords()
voidsetKeywords(java.lang.String value)
           Gets or sets the document keywords.
java.util.DategetLastPrinted()
voidsetLastPrinted(java.util.Date value)
           Gets or sets the date when the document was last printed in UTC.
java.lang.StringgetLastSavedBy()
voidsetLastSavedBy(java.lang.String value)
           Gets or sets the name of the last author.
java.util.DategetLastSavedTime()
voidsetLastSavedTime(java.util.Date value)
           Gets or sets the time of the last save in UTC.
intgetLines()
voidsetLines(int value)
           Represents an estimate of the number of lines in the document.
java.lang.StringgetManager()
voidsetManager(java.lang.String value)
           Gets or sets the manager property.
java.lang.StringgetNameOfApplication()
voidsetNameOfApplication(java.lang.String value)
           Gets or sets the name of the application.
intgetPages()
voidsetPages(int value)
           Represents an estimate of the number of pages in the document.
intgetParagraphs()
voidsetParagraphs(int value)
           Represents an estimate of the number of paragraphs in the document.
intgetRevisionNumber()
voidsetRevisionNumber(int value)
           Gets or sets the document revision number.
java.lang.StringgetSubject()
voidsetSubject(java.lang.String value)
           Gets or sets the subject of the document.
java.lang.StringgetTemplate()
voidsetTemplate(java.lang.String value)
           Gets or sets the informational name of the document template.
java.lang.StringgetTitle()
voidsetTitle(java.lang.String value)
           Gets or sets the title of the document.
doublegetTotalEditingTime()
voidsetTotalEditingTime(double value)
           Gets or sets the total editing time in minutes.
intgetVersion()
voidsetVersion(int value)
           Represents the version number of the application that created the document.
intgetWords()
voidsetWords(int value)
           Represents an estimate of the number of words in the document.
DocumentPropertyget(int index)→ inherited from DocumentProperties
           Returns a DocumentProperty object by index.
DocumentPropertyget(java.lang.String name)
           Returns a DocumentProperty object by the name of the property.
 
Method Summary
voidclear()→ inherited from DocumentProperties
           Removes all properties from the collection.
booleancontains(java.lang.String name)→ inherited from DocumentProperties
           Returns true if a property with the specified name exists in the collection.
intindexOf(java.lang.String name)→ inherited from DocumentProperties
           Gets the index of a property by name.
java.util.Iteratoriterator()→ inherited from DocumentProperties
           Returns an iterator object that can be used to iterate over all items in the collection.
voidremove(java.lang.String name)→ inherited from DocumentProperties
           Removes a property with the specified name from the collection.
voidremoveAt(int index)→ inherited from DocumentProperties
           Removes a property at the specified index.
 

Property Getters/Setters Detail

getAuthor/setAuthor

public java.lang.String getAuthor()

public void setAuthor(java.lang.String value)
Gets or sets the name of the document's author.

getBytes/setBytes

public int getBytes()

public void setBytes(int value)
Represents an estimate of the number of bytes in the document.

This property is sometimes not set by Microsoft Word.

Aspose.Words does not update this property when you create or modify the document.


getCharacters/setCharacters

public int getCharacters()

public void setCharacters(int value)
Represents an estimate of the number of characters in the document.

This property is updated when you call Document.updateWordCount().


getCharactersWithSpaces/setCharactersWithSpaces

public int getCharactersWithSpaces()

public void setCharactersWithSpaces(int value)
Represents an estimate of the number of characters (including spaces) in the document.

This property is updated when you call Document.updateWordCount().


getComments/setComments

public java.lang.String getComments()

public void setComments(java.lang.String value)
Gets or sets the document comments.

getCategory/setCategory

public java.lang.String getCategory()

public void setCategory(java.lang.String value)
Gets or sets the category of the document.

getCompany/setCompany

public java.lang.String getCompany()

public void setCompany(java.lang.String value)
Gets or sets the company property.

getCreatedTime/setCreatedTime

public java.util.Date getCreatedTime()

public void setCreatedTime(java.util.Date value)
Gets or sets date of the document creation in UTC.

Aspose.Words does not update this property when you create or modify the document.


getKeywords/setKeywords

public java.lang.String getKeywords()

public void setKeywords(java.lang.String value)
Gets or sets the document keywords.

getLastPrinted/setLastPrinted

public java.util.Date getLastPrinted()

public void setLastPrinted(java.util.Date value)
Gets or sets the date when the document was last printed in UTC.

If the document was never printed, this property will return DateTime.MinValue.

Aspose.Words does not update this property when you create or modify the document.


getLastSavedBy/setLastSavedBy

public java.lang.String getLastSavedBy()

public void setLastSavedBy(java.lang.String value)
Gets or sets the name of the last author.

Aspose.Words does not update this property when you create or modify the document.


getLastSavedTime/setLastSavedTime

public java.util.Date getLastSavedTime()

public void setLastSavedTime(java.util.Date value)
Gets or sets the time of the last save in UTC.

Aspose.Words does not update this property when you create or modify the document.


getLines/setLines

public int getLines()

public void setLines(int value)
Represents an estimate of the number of lines in the document.

Aspose.Words does not update this property when you create or modify the document.


getManager/setManager

public java.lang.String getManager()

public void setManager(java.lang.String value)
Gets or sets the manager property.

getNameOfApplication/setNameOfApplication

public java.lang.String getNameOfApplication()

public void setNameOfApplication(java.lang.String value)
Gets or sets the name of the application.

getPages/setPages

public int getPages()

public void setPages(int value)
Represents an estimate of the number of pages in the document.

Aspose.Words does not update this property when you create or modify the document.


getParagraphs/setParagraphs

public int getParagraphs()

public void setParagraphs(int value)
Represents an estimate of the number of paragraphs in the document.

This property is updated when you call Document.updateWordCount().


getRevisionNumber/setRevisionNumber

public int getRevisionNumber()

public void setRevisionNumber(int value)
Gets or sets the document revision number.

Aspose.Words does not update this property when you create or modify the document.


getSubject/setSubject

public java.lang.String getSubject()

public void setSubject(java.lang.String value)
Gets or sets the subject of the document.

getTemplate/setTemplate

public java.lang.String getTemplate()

public void setTemplate(java.lang.String value)
Gets or 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.AttachedTemplate property.

See Also:
Document.AttachedTemplate

getTitle/setTitle

public java.lang.String getTitle()

public void setTitle(java.lang.String value)
Gets or sets the title of the document.

getTotalEditingTime/setTotalEditingTime

public double getTotalEditingTime()

public void setTotalEditingTime(double value)
Gets or sets the total editing time in minutes.

getVersion/setVersion

public int getVersion()

public void setVersion(int value)
Represents the version number of the application that created the document.

getWords/setWords

public int getWords()

public void setWords(int value)
Represents an estimate of the number of words in the document.

This property is updated when you call Document.updateWordCount().


getCount

→ inherited from DocumentProperties
public int getCount()
Gets number of items in the collection.

get

public DocumentProperty get(java.lang.String 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 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.

Parameters:
name - The case-insensitive name of the property to retrieve.

get

→ inherited from DocumentProperties
public DocumentProperty get(int index)
Returns a DocumentProperty object by index.

Note: In Java this method is slow because iterates over all nodes.

Parameters:
index - Zero-based index of the DocumentProperty to retrieve.

Method Detail

iterator

→ inherited from DocumentProperties
public java.util.Iterator iterator()
Returns an iterator object that can be used to iterate over all items in the collection.

contains

→ inherited from DocumentProperties
public boolean contains(java.lang.String name)
Returns true if a property with the specified name exists in the collection.
Parameters:
name - The case-insensitive name of the property.
Returns:
True if the property exists in the collection; false otherwise.

indexOf

→ inherited from DocumentProperties
public int indexOf(java.lang.String name)
Gets the index of a property by name.

Note: In Java this method is slow because iterates over all nodes.

Parameters:
name - The case-insensitive name of the property.
Returns:
The zero based index. Negative value if not found.

remove

→ inherited from DocumentProperties
public void remove(java.lang.String name)
Removes a property with the specified name from the collection.
Parameters:
name - The case-insensitive name of the property.

removeAt

→ inherited from DocumentProperties
public void removeAt(int index)
Removes a property at the specified index.

Note: In Java this method is slow because iterates over all nodes.

Parameters:
index - The zero based index.

clear

→ inherited from DocumentProperties
public void clear()
Removes all properties from the collection.

See Also:
          Wiki - the home page for the Aspose.Words Product Documentation that includes Programmer's Guide, Knowledge Base and other articles.
          Aspose.Words Support Forum - our preferred method of support.
          Aspose.Words Team - contact Aspose.Words Team.


ASPOSE home