Class MetadataManager
java.lang.Object
com.ironsoftware.ironpdf.metadata.MetadataManager
Class used to read and edit MetaData in a
PdfDocument
.
-
Constructor Summary
ConstructorDescriptionMetadataManager
(InternalPdfDocument internalPdfDocument) Please get MetadataManager byPdfDocument.getMetadata()
instead. -
Method Summary
Modifier and TypeMethodDescriptiongetAnyMetadata
(String key) Gets any metadata value of the document form given key.Gets the Author of the document.Gets the PDF file creation DateTime.Gets the Creator of the document.Gets Keywords of the document.Gets the Producer of the document.Gets Subject of the document.getTitle()
Gets the Title of the document.void
removeMetadata
(String key) Method for removing Metadata property by its name.void
setAnyMetadata
(String key, String value) Sets any metadata value of the document form given key.void
Sets the Author of the document.void
setCreationDate
(String value) Sets the PDF file creation DateTime.void
setCreator
(String value) Sets the Creator of the document.void
setKeywords
(String value) Sets Keywords of the document.Gets the PDF file last-modified DateTime.void
setModifiedDate
(String value) Sets the PDF file last-modified DateTime.void
setProducer
(String value) Sets the Producer of the document.void
setSubject
(String value) Sets the Subject of the document.void
Sets the Title of the document.
-
Constructor Details
-
MetadataManager
Please get MetadataManager byPdfDocument.getMetadata()
instead.- Parameters:
internalPdfDocument
- the internal pdf document
-
-
Method Details
-
getAuthor
Gets the Author of the document.- Returns:
- the author
-
getAnyMetadata
Gets any metadata value of the document form given key.- Parameters:
key
- the key- Returns:
- the metadata value
-
setAuthor
Sets the Author of the document.- Parameters:
value
- the value
-
setAnyMetadata
Sets any metadata value of the document form given key.- Parameters:
key
- the keyvalue
- the value
-
getCreationDate
Gets the PDF file creation DateTime.- Returns:
- the creation date
-
setCreationDate
Sets the PDF file creation DateTime.- Parameters:
value
- the value
-
setModifiedDate
Gets the PDF file last-modified DateTime.- Returns:
- the modified date
-
setModifiedDate
Sets the PDF file last-modified DateTime.- Parameters:
value
- the value
-
getCreator
Gets the Creator of the document.- Returns:
- the creator
-
setCreator
Sets the Creator of the document.- Parameters:
value
- the value
-
getKeywords
Gets Keywords of the document. This helps search indexes and operating systems correctly index the PDF.- Returns:
- the keywords
-
setKeywords
Sets Keywords of the document. This helps search indexes and operating systems correctly index the PDF.- Parameters:
value
- the value
-
getProducer
Gets the Producer of the document.- Returns:
- the producer
-
setProducer
Sets the Producer of the document.- Parameters:
value
- the value
-
getSubject
Gets Subject of the document. This helps search indexes and operating systems correctly index the PDF, and may appear in PDF viewer software.- Returns:
- the subject
-
setSubject
Sets the Subject of the document. This helps search indexes and operating systems correctly index the PDF, and may appear in PDF viewer software.- Parameters:
value
- the value
-
getTitle
Gets the Title of the document. This helps search indexes and operating systems correctly index the PDF, and may appear in PDF viewer software.- Returns:
- the title
-
setTitle
Sets the Title of the document. This helps search indexes and operating systems correctly index the PDF, and may appear in PDF viewer software.- Parameters:
value
- the value
-
removeMetadata
Method for removing Metadata property by its name.- Parameters:
key
- The name of the property.
-