Class PDFDocInfo

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

Inheritance

object

PDFDocInfo

Implements

IDisposable

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: pdftron.PDF

Assembly: PDFNet.dll

Syntax

public class PDFDocInfo : IDisposable

Methods

Dispose()

Releases all resources used by the PDFDocInfo

Declaration

public override sealed void Dispose()

Dispose(bool)

Declaration

[HandleProcessCorruptedStateExceptions]
protected virtual void Dispose(bool A_0)

Parameters

Type	Name	Description
bool	A_0

~PDFDocInfo()

Allows a PDFDocInfo to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

Declaration

protected ~PDFDocInfo()

GetAuthor()

Gets the author.

Declaration

public string GetAuthor()

Returns

Type	Description
string	The name of the person who created the document.

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

GetAuthorObj()

Gets the author obj.

Declaration

public Obj GetAuthorObj()

Returns

Type	Description
Obj	SDF/Cos string object representing document's author.

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

GetCreationDate()

Gets the creation date.

Declaration

public Date GetCreationDate()

Returns

Type	Description
Date	date and time the document was created, in human-readable form.

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

GetCreator()

Gets the creator.

Declaration

public string GetCreator()

Returns

Type	Description
string	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.

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

GetCreatorObj()

Gets the creator obj.

Declaration

public Obj GetCreatorObj()

Returns

Type	Description
Obj	SDF/Cos string object representing document's creator.

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

GetKeywords()

Gets the keywords.

Declaration

public string GetKeywords()

Returns

Type	Description
string	Keywords associated with the document.

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

GetKeywordsObj()

Gets the keywords obj.

Declaration

public Obj GetKeywordsObj()

Returns

Type	Description
Obj	SDF/Cos string object representing document's keywords.

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

GetModDate()

Gets the mod date.

Declaration

public Date GetModDate()

Returns

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

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

GetProducer()

Gets the producer.

Declaration

public string GetProducer()

Returns

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

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

GetProducerObj()

Gets the producer obj.

Declaration

public Obj GetProducerObj()

Returns

Type	Description
Obj	SDF/Cos string object representing document's producer.

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

GetSDFObj()

Gets the SDFObj.

Declaration

public Obj GetSDFObj()

Returns

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

GetSubject()

Gets the subject.

Declaration

public string GetSubject()

Returns

Type	Description
string	The subject of the document.

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

GetSubjectObj()

Gets the subject obj.

Declaration

public Obj GetSubjectObj()

Returns

Type	Description
Obj	SDF/Cos string object representing document's subject.

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

GetTitle()

Gets the title.

Declaration

public string GetTitle()

Returns

Type	Description
string	The document's title.

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

GetTitleObj()

Gets the title obj.

Declaration

public Obj GetTitleObj()

Returns

Type	Description
Obj	SDF/Cos string object representing document's title.

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

SetAuthor(string)

Set the author of the document.

Declaration

public void SetAuthor(string author)

Parameters

Type	Name	Description
string	author	the new author

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

SetCreationDate(Date)

Declaration

public void SetCreationDate(Date creation_date)

Parameters

Type	Name	Description
Date	creation_date

SetCreator(string)

Set document's creator.

Declaration

public void SetCreator(string creator)

Parameters

Type	Name	Description
string	creator	The name of the application that created the original document.

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

SetKeywords(string)

Set keywords associated with the document.

Declaration

public void SetKeywords(string keywords)

Parameters

Type	Name	Description
string	keywords	the new keywords

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

SetModDate(Date)

Declaration

public void SetModDate(Date mod_date)

Parameters

Type	Name	Description
Date	mod_date

SetProducer(string)

Set document's producer.

Declaration

public void SetProducer(string producer)

Parameters

Type	Name	Description
string	producer	The name of the application that generated PDF.

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

SetSubject(string)

Set the subject of the document.

Declaration

public void SetSubject(string subject)

Parameters

Type	Name	Description
string	subject	The subject of the document.

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

SetTitle(string)

Set document's title.

Declaration

public void SetTitle(string title)

Parameters

Type	Name	Description
string	title	New title of the document.

Exceptions

Type	Condition
PDFNetException	PDFNetException the PDFNet exception

Implements

IDisposable