DocumentInfo

Inheritance: java.lang.Object, com.aspose.ms.System.Collections.Generic.Dictionary

public final class DocumentInfo extends System.Collections.Generic.Dictionary<String,String>

Represents meta information of PDF document.

Constructors

ConstructorDescription
DocumentInfo(IDocument document)Initialize DocumentInfo instance.

Methods

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

DocumentInfo(IDocument document)

public DocumentInfo(IDocument document)

Initialize DocumentInfo instance.

Parameters:

ParameterTypeDescription
documentIDocumentThe info of this document will be used for initialization.

getTitle()

public String getTitle()

Gets document title.

Returns: java.lang.String - String value

setTitle(String value)

public void setTitle(String value)

Sets document title.

Parameters:

ParameterTypeDescription
valuejava.lang.StringString value

getCreator()

public String getCreator()

Gets document creator.

Returns: java.lang.String - String value

setCreator(String value)

public void setCreator(String value)

Sets document creator.

Parameters:

ParameterTypeDescription
valuejava.lang.StringString value

getAuthor()

public String getAuthor()

Gets document author.

Returns: java.lang.String - String value

setAuthor(String value)

public void setAuthor(String value)

Sets document author.

Parameters:

ParameterTypeDescription
valuejava.lang.StringString value

getSubject()

public String getSubject()

Gets the subject of the document.

Returns: java.lang.String - String value

setSubject(String value)

public void setSubject(String value)

Sets the subject of the document.

Parameters:

ParameterTypeDescription
valuejava.lang.StringString value

getKeywords()

public String getKeywords()

Gets the keywords of the document.

Returns: java.lang.String - String value

setKeywords(String value)

public void setKeywords(String value)

Set the keywords of the document.

Parameters:

ParameterTypeDescription
valuejava.lang.StringString value

getProducer()

public String getProducer()

Gets the document producer.

Returns: java.lang.String - String value

setProducer(String value)

public void setProducer(String value)

Sets the document producer.

Parameters:

ParameterTypeDescription
valuejava.lang.StringString value

getCreationDate()

public Date getCreationDate()

Gets the date of document creation.

Returns: Date - Date object

setCreationDate(Date value)

public void setCreationDate(Date value)

Sets the date of document creation.

Parameters:

ParameterTypeDescription
valuejava.util.DateDate object

getCreationTimeZone()

public double getCreationTimeZone()

Time zone of creation date in milliseconds.

Returns: double - double value

setCreationTimeZone(double value)

public void setCreationTimeZone(double value)

Time zone of creation date in milliseconds.

Parameters:

ParameterTypeDescription
valuedoublein milliseconds

getModTimeZone()

public double getModTimeZone()

Time zone of modification date.

Returns: double - double value

setModTimeZone(double value)

public void setModTimeZone(double value)

Time zone of modification date.

Parameters:

ParameterTypeDescription
valuedoubledouble value

getModDate()

public Date getModDate()

Gets the date of document modification.

Returns: Date - Date object

setModDate(Date value)

public void setModDate(Date value)

Sets the date of document modification.

Parameters:

ParameterTypeDescription
valuejava.util.DateDate object

getTrapped()

public String getTrapped()

Gets the trapped flag.

Returns: java.lang.String - String value

setTrapped(String value)

public void setTrapped(String value)

Sets the trapped flag.

Parameters:

ParameterTypeDescription
valuejava.lang.StringString value

clear()

public void clear()

Clears the document info.

addItem(String key, String value)

public void addItem(String key, String value)

Adds an element with the specified key and value into the collection.

Parameters:

ParameterTypeDescription
keyjava.lang.StringThe key of the element to add.
valuejava.lang.StringThe value of the element to add. The value can be null.

remove(String key)

public void remove(String key)

Removes the element with the specified key from the collection.

Parameters:

ParameterTypeDescription
keyjava.lang.StringThe key of the element to remove.

get_Item(String key)

public String get_Item(String key)

Gets the value associated with the specified key.

Parameters:

ParameterTypeDescription
keyjava.lang.StringThe key whose value to get or set.

Returns: java.lang.String - Value Object

set_Item(String key, String value)

public void set_Item(String key, String value)

Sets the value associated with the specified key.

Parameters:

ParameterTypeDescription
keyjava.lang.StringString Object
valuejava.lang.StringObject

clearCustomData()

public void clearCustomData()

Clears custom data only, leaves all other predefined values (Title, Author, etc.).

isPredefinedKey(String key)

public static boolean isPredefinedKey(String key)

Determines if the key is predefined (Title, Author, etc.), not custom.

Parameters:

ParameterTypeDescription
keyjava.lang.StringSelected key

Returns: boolean - True in case the key is predefined.