new PDFDocInfo()
PDFDocInfo is a high-level utility class that can be used
to read and modify document's metadata.
Methods
-
<static> create(tr)
-
PDFDocInfo constructor. Typically this constructor is never used since it is easier to obtain DocInfo using PDFDoc.GetDocInfo()
Parameters:
Name Type Description tr
PDFNet.Obj Returns:
A promise that resolves to an object of type: "PDFNet.PDFDocInfo"- Type
- Promise.<PDFNet.PDFDocInfo>
-
copy()
-
Copy Constructor
Returns:
A promise that resolves to an object of type: "PDFNet.PDFDocInfo"- Type
- Promise.<PDFNet.PDFDocInfo>
-
getAuthor()
-
Returns:
A promise that resolves to the name of the person who created the document.- Type
- Promise.<string>
-
getAuthorObj()
-
Returns:
A promise that resolves to sDF/Cos string object representing document's author.- Type
- Promise.<PDFNet.Obj>
-
getCreationDate()
-
Returns:
A promise that resolves to the date and time the document was created, in human-readable form.- Type
- Promise.<PDFNet.Date>
-
getCreator()
-
Returns:
A promise that resolves to if the document was converted to PDF from another format, the name of the application that created the original document from which it was converted.- Type
- Promise.<string>
-
getCreatorObj()
-
Returns:
A promise that resolves to sDF/Cos string object representing document's creator.- Type
- Promise.<PDFNet.Obj>
-
getKeywords()
-
Returns:
A promise that resolves to keywords associated with the document.- Type
- Promise.<string>
-
getKeywordsObj()
-
Returns:
A promise that resolves to sDF/Cos string object representing document's keywords.- Type
- Promise.<PDFNet.Obj>
-
getModDate()
-
Returns:
A promise that resolves to the date and time the document was most recently modified, in human-readable form.- Type
- Promise.<PDFNet.Date>
-
getProducer()
-
Returns:
A promise that resolves to if the document was converted to PDF from another format, the name of the application (for example, Distiller) that converted it to PDF.- Type
- Promise.<string>
-
getProducerObj()
-
Returns:
A promise that resolves to sDF/Cos string object representing document's producer.- Type
- Promise.<PDFNet.Obj>
-
getSDFObj()
-
Returns:
A promise that resolves to document's SDF/Cos 'Info' dictionary or NULL if the info dictionary is not available.- Type
- Promise.<PDFNet.Obj>
-
getSubject()
-
Returns:
A promise that resolves to the subject of the document.- Type
- Promise.<string>
-
getSubjectObj()
-
Returns:
A promise that resolves to sDF/Cos string object representing document's subject.- Type
- Promise.<PDFNet.Obj>
-
getTitle()
-
Returns:
A promise that resolves to the document's title.- Type
- Promise.<string>
-
getTitleObj()
-
Returns:
A promise that resolves to sDF/Cos string object representing document's title.- Type
- Promise.<PDFNet.Obj>
-
setAuthor(author)
-
Set the author of the document.
Parameters:
Name Type Description author
string The name of the person who created the document. Returns:
- Type
- Promise.<void>
-
setCreationDate(creation_date)
-
Set document's creation date.
Parameters:
Name Type Description creation_date
PDFNet.Date The date and time the document was created. Returns:
- Type
- Promise.<void>
-
setCreator(creator)
-
Set document's creator.
Parameters:
Name Type Description creator
string The name of the application that created the original document. Returns:
- Type
- Promise.<void>
-
setKeywords(keywords)
-
Set keywords associated with the document.
Parameters:
Name Type Description keywords
string Keywords associated with the document. Returns:
- Type
- Promise.<void>
-
setModDate(mod_date)
-
Set document's modification date.
Parameters:
Name Type Description mod_date
PDFNet.Date The date and time the document was most recently modified. Returns:
- Type
- Promise.<void>
-
setProducer(producer)
-
Set document's producer.
Parameters:
Name Type Description producer
string The name of the application that generated PDF. Returns:
- Type
- Promise.<void>
-
setSubject(subject)
-
Set the subject of the document
Parameters:
Name Type Description subject
string The subject of the document. Returns:
- Type
- Promise.<void>
-
setTitle(title)
-
Set document's title.
Parameters:
Name Type Description title
string New title of the document. Returns:
- Type
- Promise.<void>