Opait PDF Library
Public Member Functions | Properties | List of all members
Opait.Pdf.PdfInfo Class Reference

Class represents a dictionary of common metadata for the PDF document. Any entry whose value is not known should be omitted from the dictionary, rather than included with an empty string as its value. More...

Public Member Functions

string GetField (PdfInfoField field)
 Gets the value of a standard info field. More...
 
void SetField (PdfInfoField field, string value)
 Sets the value of the specified standard field. More...
 
string GetField (string name)
 Gets the current value of a standard or custom field. More...
 
void SetField (string name, string value)
 Sets the value of the specified standard or custom field. More...
 

Properties

string Producer [get, set]
 Gets or sets the producer name for use in the XMP metadata.
 
string RedactData [get, set]
 Gets or sets the encrypted redaction data for the document.
 
DateTime? CreateDate [get]
 Gets the document creation date from the info dictionary.
 
DateTime? ModifyDate [get]
 Gets the document modification date from the info dictionary.
 

Detailed Description

Class represents a dictionary of common metadata for the PDF document. Any entry whose value is not known should be omitted from the dictionary, rather than included with an empty string as its value.

Member Function Documentation

◆ GetField() [1/2]

string Opait.Pdf.PdfInfo.GetField ( PdfInfoField  field)

Gets the value of a standard info field.

Parameters
fieldThe standard field identifier.
Returns
The value of the field, or null if the field does not exist.

◆ GetField() [2/2]

string Opait.Pdf.PdfInfo.GetField ( string  name)

Gets the current value of a standard or custom field.

Parameters
nameThe name of the field.
Returns
The value of the field, or null if the field does not exist.

◆ SetField() [1/2]

void Opait.Pdf.PdfInfo.SetField ( PdfInfoField  field,
string  value 
)

Sets the value of the specified standard field.

Parameters
fieldThe standard field identifier.
valueThe new value of the field, or null if the field is to be deleted.

◆ SetField() [2/2]

void Opait.Pdf.PdfInfo.SetField ( string  name,
string  value 
)

Sets the value of the specified standard or custom field.

Parameters
nameThe name of the field.
valueThe new value of the field, or null if the field is to be deleted.