Packages

com.aspose.pdf

Interfaces

Classes

Enums

Exceptions

InvalidFormTypeOperationException

Skip navigation links

java.lang.Object
- com.aspose.ms.System.Collections.Generic.Dictionary<String,String>
- - com.aspose.pdf.DocumentInfo

All Implemented Interfaces:

com.aspose.ms.System.Collections.Generic.IGenericCollection<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,String>>, com.aspose.ms.System.Collections.Generic.IGenericDictionary<String,String>, com.aspose.ms.System.Collections.Generic.IGenericEnumerable<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,String>>, com.aspose.ms.System.Collections.IEnumerable<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,String>>, Iterable<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,String>>
```
public final class DocumentInfo
extends com.aspose.ms.System.Collections.Generic.Dictionary<String,String>
```
Represents meta information of PDF document.

Nested Class Summary
- Nested classes/interfaces inherited from class com.aspose.ms.System.Collections.Generic.Dictionary
  com.aspose.ms.System.Collections.Generic.Dictionary.Enumerator<TKey,TValue>, com.aspose.ms.System.Collections.Generic.Dictionary.KeyCollection<TKey,TValue>, com.aspose.ms.System.Collections.Generic.Dictionary.Link, com.aspose.ms.System.Collections.Generic.Dictionary.ValueCollection<TKey,TValue>

Constructor Summary

Constructors
Constructor and Description

DocumentInfo(IDocument document)
Initialize DocumentInfo instance.

Constructors
Constructor and Description
`DocumentInfo(IDocument document)` Initialize DocumentInfo instance.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addItem(String key, String value)` Adds an element with the specified key and value into the collection.
`void`	`clear()` Clears the document info.
`void`	`clearCustomData()` Clears custom data only, leaves all other predefined values (Title, Author, etc.).
`String`	`get_Item(String key)` Gets the value associated with the specified key.
`String`	`getAuthor()` Gets document author.
`Date`	`getCreationDate()` Gets the date of document creation.
`double`	`getCreationTimeZone()` Time zone of creation date in milliseconds.
`String`	`getCreator()` Gets document creator.
`String`	`getKeywords()` Gets the keywords of the document.
`Date`	`getModDate()` Gets the date of document modification.
`double`	`getModTimeZone()` Time zone of modification date.
`String`	`getProducer()` Gets the document producer.
`String`	`getSubject()` Gets the subject of the document.
`String`	`getTitle()` Gets document title.
`String`	`getTrapped()` Gets the trapped flag.
`static boolean`	`isPredefinedKey(String key)` Determines if the key is predefined (Title, Author, etc.), not custom.
`void`	`remove(String key)` Removes the element with the specified key from the collection.
`void`	`set_Item(String key, String value)` Sets the value associated with the specified key.
`void`	`setAuthor(String value)` Sets document author.
`void`	`setCreationDate(Date value)` Sets the date of document creation.
`void`	`setCreationTimeZone(double value)` Time zone of creation date in milliseconds.
`void`	`setKeywords(String value)` Set the keywords of the document.
`void`	`setModDate(Date value)` Sets the date of document modification.
`void`	`setModTimeZone(double value)` Time zone of modification date.
`void`	`setSubject(String value)` Sets the subject of the document.
`void`	`setTitle(String value)` Sets document title.
`void`	`setTrapped(String value)` Sets the trapped flag.

Methods inherited from class com.aspose.ms.System.Collections.Generic.Dictionary
addItem, containsItem, containsKey, containsValue, copyTo, copyToTArray, getComparer, getDictionaryEntryEnumerator, getKeys, getSyncRoot, getValues, isFixedSize, isReadOnly, isSynchronized, iterator, removeItem, removeItemByKey, size, tryGetValue

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

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

- Constructor Detail
  - DocumentInfo
```
public DocumentInfo(IDocument document)
```
    Initialize DocumentInfo instance.
    
    Parameters:
    
    document - The info of this document will be used for initialization.
- Method Detail
  - getTitle
```
public String getTitle()
```
    Gets document title.
    
    Returns:
    
    String value
  - setTitle
```
public void setTitle(String value)
```
    Sets document title.
    
    Parameters:
    
    value - String value
  - getCreator
```
public String getCreator()
```
    Gets document creator.
    
    Returns:
    
    String value
  - getAuthor
```
public String getAuthor()
```
    Gets document author.
    
    Returns:
    
    String value
  - setAuthor
```
public void setAuthor(String value)
```
    Sets document author.
    
    Parameters:
    
    value - String value
  - getSubject
```
public String getSubject()
```
    Gets the subject of the document.
    
    Returns:
    
    String value
  - setSubject
```
public void setSubject(String value)
```
    Sets the subject of the document.
    
    Parameters:
    
    value - String value
  - getKeywords
```
public String getKeywords()
```
    Gets the keywords of the document.
    
    Returns:
    
    String value
  - setKeywords
```
public void setKeywords(String value)
```
    Set the keywords of the document.
    
    Parameters:
    
    value - String value
  - getProducer
```
public String getProducer()
```
    Gets the document producer.
    
    Returns:
    
    String value
  - getCreationDate
```
public Date getCreationDate()
```
    Gets the date of document creation.
    
    Returns:
    
    Date object
  - setCreationDate
```
public void setCreationDate(Date value)
```
    Sets the date of document creation.
    
    Parameters:
    
    value - Date object
  - getCreationTimeZone
```
public double getCreationTimeZone()
```
    Time zone of creation date in milliseconds.
    
    Returns:
    
    double value
  - setCreationTimeZone
```
public void setCreationTimeZone(double value)
```
    Time zone of creation date in milliseconds.
    
    Parameters:
    
    value - in milliseconds
  - getModTimeZone
```
public double getModTimeZone()
```
    Time zone of modification date.
    
    Returns:
    
    double value
  - setModTimeZone
```
public void setModTimeZone(double value)
```
    Time zone of modification date.
    
    Parameters:
    
    value - double value
  - getModDate
```
public Date getModDate()
```
    Gets the date of document modification.
    
    Returns:
    
    Date object
  - setModDate
```
public void setModDate(Date value)
```
    Sets the date of document modification.
    
    Parameters:
    
    value - Date object
  - getTrapped
```
public String getTrapped()
```
    Gets the trapped flag.
    
    Returns:
    
    String value
  - setTrapped
```
public void setTrapped(String value)
```
    Sets the trapped flag.
    
    Parameters:
    
    value - String value
  - clear
```
public void clear()
```
    Clears the document info.
    
    Specified by:
    
    clear in interface com.aspose.ms.System.Collections.Generic.IGenericCollection<com.aspose.ms.System.Collections.Generic.KeyValuePair<String,String>>
    
    Overrides:
    
    clear in class com.aspose.ms.System.Collections.Generic.Dictionary<String,String>
  - addItem
```
public void addItem(String key,
                    String value)
```
    Adds an element with the specified key and value into the collection.
    
    Specified by:
    
    addItem in interface com.aspose.ms.System.Collections.Generic.IGenericDictionary<String,String>
    
    Overrides:
    
    addItem in class com.aspose.ms.System.Collections.Generic.Dictionary<String,String>
    
    Parameters:
    
    key - The key of the element to add.
    
    value - The value of the element to add. The value can be null.
  - remove
```
public void remove(String key)
```
    Removes the element with the specified key from the collection.
    
    Parameters:
    
    key - The key of the element to remove.
  - get_Item
```
public String get_Item(String key)
```
    Gets the value associated with the specified key.
    
    Specified by:
    
    get_Item in interface com.aspose.ms.System.Collections.Generic.IGenericDictionary<String,String>
    
    Overrides:
    
    get_Item in class com.aspose.ms.System.Collections.Generic.Dictionary<String,String>
    
    Parameters:
    
    key - The key whose value to get or set.
    
    Returns:
    
    Value Object
  - set_Item
```
public void set_Item(String key,
                     String value)
```
    Sets the value associated with the specified key.
    
    Specified by:
    
    set_Item in interface com.aspose.ms.System.Collections.Generic.IGenericDictionary<String,String>
    
    Overrides:
    
    set_Item in class com.aspose.ms.System.Collections.Generic.Dictionary<String,String>
    
    Parameters:
    
    key - String Object
    
    value - Object
  - clearCustomData
```
public void clearCustomData()
```
    Clears custom data only, leaves all other predefined values (Title, Author, etc.).
  - isPredefinedKey
```
public static boolean isPredefinedKey(String key)
```
    Determines if the key is predefined (Title, Author, etc.), not custom.
    
    Parameters:
    
    key - Selected key
    
    Returns:
    
    True in case the key is predefined.

Packages

com.aspose.pdf

Interfaces

Classes

Enums

Exceptions

Class DocumentInfo

Nested Class Summary

Nested classes/interfaces inherited from class com.aspose.ms.System.Collections.Generic.Dictionary

Constructor Summary

Method Summary

Methods inherited from class com.aspose.ms.System.Collections.Generic.Dictionary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

DocumentInfo

Method Detail

getTitle

setTitle

getCreator

getAuthor

setAuthor

getSubject

setSubject

getKeywords

setKeywords

getProducer

getCreationDate

setCreationDate

getCreationTimeZone

setCreationTimeZone

getModTimeZone

setModTimeZone

getModDate

setModDate

getTrapped

setTrapped

clear

addItem

remove

get_Item

set_Item

clearCustomData

isPredefinedKey