pdftron::PDF::PDFDocInfo Class Reference

PDFDocInfo is a high-level utility class that can be used to read and modify document's metadata. More...

#include <PDFDocInfo.h>

List of all members.

Public Member Functions
UString	GetTitle ()
	Returns: The document’s title.
SDF::Obj	GetTitleObj ()
	Returns: SDF/Cos string object representing document's title.
void	SetTitle (const UString &title)
	Set document’s title.
UString	GetAuthor ()
	Returns: The name of the person who created the document.
SDF::Obj	GetAuthorObj ()
	Returns: SDF/Cos string object representing document's author.
void	SetAuthor (const UString &author)
	Set the author of the document.
UString	GetSubject ()
	Returns: The subject of the document.
SDF::Obj	GetSubjectObj ()
	Returns: SDF/Cos string object representing document's subject.
void	SetSubject (const UString &subject)
	Set the subject of the document.
UString	GetKeywords ()
	Returns: Keywords associated with the document.
SDF::Obj	GetKeywordsObj ()
	Returns: SDF/Cos string object representing document's keywords.
void	SetKeywords (const UString &keywords)
	Set keywords associated with the document.
UString	GetCreator ()
	Returns: 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.
SDF::Obj	GetCreatorObj ()
	Returns: SDF/Cos string object representing document's creator.
void	SetCreator (const UString &creator)
	Set document’s creator.
UString	GetProducer ()
	Returns: If the document was converted to PDF from another format, the name of the application (for example, Distiller) that converted it to PDF.
SDF::Obj	GetProducerObj ()
	Returns: SDF/Cos string object representing document's producer.
void	SetProducer (const UString &producer)
	Set document’s producer.
Date	GetCreationDate ()
	Returns: The date and time the document was created, in human-readable form.
void	SetCreationDate (const Date &creation_date)
	Set document’s creation date.
Date	GetModDate ()
	Returns: The date and time the document was most recently modified, in human-readable form.
void	SetModDate (const Date &mod_date)
	Set document’s modification date.
SDF::Obj	GetSDFObj ()
	Returns: document’s SDF/Cos 'Info' dictionary or NULL if the info dictionary is not available.
	PDFDocInfo (SDF::Obj tr)
	PDFDocInfo constructor.
	PDFDocInfo (const PDFDocInfo &)
PDFDocInfo &	operator= (const PDFDocInfo &)

---

Detailed Description

PDFDocInfo is a high-level utility class that can be used to read and modify document's metadata.

---

Constructor & Destructor Documentation

pdftron::PDF::PDFDocInfo::PDFDocInfo

(

SDF::Obj

tr

)

PDFDocInfo constructor.

Typically this constructor is never used since it is easier to obtain DocInfo using PDFDoc.GetDocInfo()

pdftron::PDF::PDFDocInfo::PDFDocInfo

(

const PDFDocInfo &

)

---

Member Function Documentation

UString pdftron::PDF::PDFDocInfo::GetTitle

(

)

Returns:

The document’s title.

SDF::Obj pdftron::PDF::PDFDocInfo::GetTitleObj

(

)

Returns:

SDF/Cos string object representing document's title.

void pdftron::PDF::PDFDocInfo::SetTitle

(

const UString &

title

)

Set document’s title.

Parameters:

title

New title of the document.

UString pdftron::PDF::PDFDocInfo::GetAuthor

(

)

Returns:

The name of the person who created the document.

SDF::Obj pdftron::PDF::PDFDocInfo::GetAuthorObj

(

)

Returns:

SDF/Cos string object representing document's author.

void pdftron::PDF::PDFDocInfo::SetAuthor

(

const UString &

author

)

Set the author of the document.

Parameters:

The

name of the person who created the document.

UString pdftron::PDF::PDFDocInfo::GetSubject

(

)

Returns:

The subject of the document.

SDF::Obj pdftron::PDF::PDFDocInfo::GetSubjectObj

(

)

Returns:

SDF/Cos string object representing document's subject.

void pdftron::PDF::PDFDocInfo::SetSubject

(

const UString &

subject

)

Set the subject of the document.

Parameters:

subject

The subject of the document.

UString pdftron::PDF::PDFDocInfo::GetKeywords

(

)

Returns:

Keywords associated with the document.

SDF::Obj pdftron::PDF::PDFDocInfo::GetKeywordsObj

(

)

Returns:

SDF/Cos string object representing document's keywords.

void pdftron::PDF::PDFDocInfo::SetKeywords

(

const UString &

keywords

)

Set keywords associated with the document.

Parameters:

Keywords

Keywords associated with the document.

UString pdftron::PDF::PDFDocInfo::GetCreator

(

)

Returns:

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.

SDF::Obj pdftron::PDF::PDFDocInfo::GetCreatorObj

(

)

Returns:

SDF/Cos string object representing document's creator.

void pdftron::PDF::PDFDocInfo::SetCreator

(

const UString &

creator

)

Set document’s creator.

Parameters:

creator

The name of the application that created the original document.

UString pdftron::PDF::PDFDocInfo::GetProducer

(

)

Returns:

If the document was converted to PDF from another format, the name of the application (for example, Distiller) that converted it to PDF.

SDF::Obj pdftron::PDF::PDFDocInfo::GetProducerObj

(

)

Returns:

SDF/Cos string object representing document's producer.

void pdftron::PDF::PDFDocInfo::SetProducer

(

const UString &

producer

)

Set document’s producer.

Parameters:

producer

The name of the application that generated PDF.

Date pdftron::PDF::PDFDocInfo::GetCreationDate

(

)

Returns:

The date and time the document was created, in human-readable form.

void pdftron::PDF::PDFDocInfo::SetCreationDate

(

const Date &

creation_date

)

Set document’s creation date.

Parameters:

creation_date

The date and time the document was created.

Date pdftron::PDF::PDFDocInfo::GetModDate

(

)

Returns:

The date and time the document was most recently modified, in human-readable form.

void pdftron::PDF::PDFDocInfo::SetModDate

(

const Date &

mod_date

)

Set document’s modification date.

Parameters:

mod_date

The date and time the document was most recently modified.

SDF::Obj pdftron::PDF::PDFDocInfo::GetSDFObj

(

)

Returns:

document’s SDF/Cos 'Info' dictionary or NULL if the info dictionary is not available.

PDFDocInfo& pdftron::PDF::PDFDocInfo::operator=

(

const PDFDocInfo &

)

---

© 2002-2008 PDFTron Systems Inc.