Class Index

Classes


Class PDFNet.PDFDocInfo

PDFNet.PDFDocInfo

Class Summary
Constructor Attributes Constructor Name and Description
 
PDFDocInfo is a high-level utility class that can be used to read and modify document's metadata.
Method Summary
Method Attributes Method Name and Description
 
copy()
Copy Constructor
<static>  
PDFNet.PDFDocInfo.create(tr)
PdFDocInfo constructor.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
setAuthor(author)
Set the author of the document.
 
setCreationDate(creation_date)
Set document's creation date.
 
setCreator(creator)
Set document's creator.
 
setKeywords(Keywords)
Set keywords associated with the document.
 
setModDate(mod_date)
Set document's modification date.
 
setProducer(producer)
Set document's producer.
 
setSubject(subject)
Set the subject of the document
 
setTitle(title)
Set document's title.
Class Detail
PDFNet.PDFDocInfo(id)
PDFDocInfo is a high-level utility class that can be used to read and modify document's metadata.
Parameters:
id
Method Detail
{PDFDocInfo} copy()
Copy Constructor
Returns:
{PDFDocInfo} A promise that resolves to an object of type: "PDFDocInfo" (generated documentation)

<static> {PDFDocInfo} PDFNet.PDFDocInfo.create(tr)
PdFDocInfo constructor. Typically this constructor is never used since it is easier to obtain DocInfo using PDFDoc.GetDocInfo()
Parameters:
{Obj} tr
(generated documentation)
Returns:
{PDFDocInfo} A promise that resolves to an object of type: "PDFDocInfo" (generated documentation)

{string} getAuthor()
Returns:
{string} A promise that resolves to the name of the person who created the document.

{Obj} getAuthorObj()
Returns:
{Obj} A promise that resolves to sDF/Cos string object representing document's author.

{date} getCreationDate()
Returns:
{date} A promise that resolves to the date and time the document was created, in human-readable form.

{string} getCreator()
Returns:
{string} 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.

{Obj} getCreatorObj()
Returns:
{Obj} A promise that resolves to sDF/Cos string object representing document's creator.

{string} getKeywords()
Returns:
{string} A promise that resolves to keywords associated with the document.

{Obj} getKeywordsObj()
Returns:
{Obj} A promise that resolves to sDF/Cos string object representing document's keywords.

{date} getModDate()
Returns:
{date} A promise that resolves to the date and time the document was most recently modified, in human-readable form.

{string} getProducer()
Returns:
{string} 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.

{Obj} getProducerObj()
Returns:
{Obj} A promise that resolves to sDF/Cos string object representing document's producer.

{Obj} getSDFObj()
Returns:
{Obj} A promise that resolves to document's SDF/Cos 'Info' dictionary or NULL if the info dictionary is not available.

{string} getSubject()
Returns:
{string} A promise that resolves to the subject of the document.

{Obj} getSubjectObj()
Returns:
{Obj} A promise that resolves to sDF/Cos string object representing document's subject.

{string} getTitle()
Returns:
{string} A promise that resolves to the document's title.

{Obj} getTitleObj()
Returns:
{Obj} A promise that resolves to sDF/Cos string object representing document's title.

setAuthor(author)
Set the author of the document.
Parameters:
{string} author
The name of the person who created the document.

setCreationDate(creation_date)
Set document's creation date.
Parameters:
{date} creation_date
The date and time the document was created.

setCreator(creator)
Set document's creator.
Parameters:
{string} creator
The name of the application that created the original document.

setKeywords(Keywords)
Set keywords associated with the document.
Parameters:
{string} Keywords
Keywords associated with the document.

setModDate(mod_date)
Set document's modification date.
Parameters:
{date} mod_date
The date and time the document was most recently modified.

setProducer(producer)
Set document's producer.
Parameters:
{string} producer
The name of the application that generated PDF.

setSubject(subject)
Set the subject of the document
Parameters:
{string} subject
The subject of the document.

setTitle(title)
Set document's title.
Parameters:
{string} title
New title of the document.

Documentation generated by JsDoc Toolkit 2.4.0 on Fri Sep 09 2016 14:32:41 GMT-0700 (PDT)