Converts PDF to PDF/A 1b or 2b compliant document.
This class is used to convert from PDF to PDF/A. If you wish to convert to a PDF that is non-PDF/A then use the PdfToPdfConverter instead. More...

Inheritance diagram for SolidFramework.Converters.PdfToPdfAConverter:

Public Member Functions
override void	Dispose ()

	PdfToPdfAConverter ()
	Initializes a new instance of the PdfToPdfAConverter class. This class is used to convert from PDF to PDF/A. If you wish to convert to a PDF that is non-PDF/A then use the PdfToPdfConverter instead.

void	Validate ()
	Check whether the PDF file passes PDF/A validation for the current validation mode.

void	Validate (SolidFramework.Plumbing.ValidationMode mode)
	Check whether the PDF file passes PDF/A validation for the specified mode. More...

void	Verify ()
	Verify that the PDF file passes PDF/A validation with the ValidationMode that it claims to be.

override void	Convert ()
	Starts the conversion of a PDF file to a PDF/A 1b or 2b file. More...

override void	AddSourceFile (string fullpath)
	Add a PDF file to be converted to the source collection. More...

override void	AddSourceFile (SolidFramework.Plumbing.Document document)
	Add a PDF file to be converted to the source collection from a loaded `Document` object. More...

override SolidFramework.Converters.Plumbing.ConversionStatus	ConvertTo (string fullpath, bool overwrite)
	Converts single file to specified path. More...

void	Cancel ()
	Cancels the conversion.

bool	IsCanceled ()

void	AddSourceFiles (SolidFramework.StringsArray paths)
	Add a collection of PDF file paths to be converted to the source collection. More...

SolidFramework.Converters.Plumbing.ConversionStatus	ConvertTo (string fullpath)
	Converts single file to specified path More...

void	ClearSourceFiles ()
	Clear the current source files collection.

virtual void	OnProgress (SolidFramework.ProgressEventArgs args)

virtual void	OnWarning (SolidFramework.WarningEventArgs args)

bool	Equals (SolidFramework.Converters.Converter other)

override bool	Equals (object obj)

override int	GetHashCode ()

Static Public Member Functions
static bool	operator== (SolidFramework.Converters.Converter obj1, SolidFramework.Converters.Converter obj2)

static bool	operator!= (SolidFramework.Converters.Converter obj1, SolidFramework.Converters.Converter obj2)

Properties
string	OcrLanguage `[getset]`
	Gets or sets the OCR language to to be used. More...

string	ExportLogPath `[getset]`
	Gets or sets the directory path to validation log.

string	ReportLanguage `[getset]`
	Gets or sets the language for validation log.

SolidFramework.Pdf.Reports.PdfAReport	Report `[get]`
	Gets the Report that shows the validation steps, errors, passes etc. of the conversion.

SolidFramework.Converters.Plumbing.TextWatermark	TextWatermark `[getset]`
	Gets or sets the Text Watermark to be used in the converted file. More...

string	LogPath `[getset]`
	Gets or sets the path where the error log is located.

bool	OcrAlways `[getset]`
	Gets or sets whether OCR should be performed on every single character. Setting this to true can result in slow conversions.

bool	ShowWarnings `[getset]`
	Gets or sets whether warnings should be shown.

bool	OcrAutoRotate `[getset]`
	Gets or sets whether to automatically detect and rotate pages that require rotatation on conversion.

SolidFramework.Converters.Plumbing.OcrType	OcrType `[getset]`
	Gets or sets the type of OCR to be performed. More...

SolidFramework.Converters.Plumbing.TextRecoveryEngine	OcrEngine `[getset]`
	Gets or sets the TextRecoveryEngine that should be used for OCR.

SolidFramework.Plumbing.ValidationMode	ValidationMode `[getset]`
	Sets the PDF/A Validation Mode. Setting this to PDF will cause an exception to be thrown if an attempt is made to convert the file.

SolidFramework.Imaging.Plumbing.ImageCompression	OcrImageCompression `[getset]`
	Gets or sets the compression method to be used for images. This will affect file size and image quality. More...

System.Object	CustomData `[getset]`
	Custom data to provide during Progress events

SolidFramework.Converters.Plumbing.IConversionResultsCollection	Results `[get]`
	Gets the results of conversion

string	SourceDirectory `[getset]`
	Gets the source directory. More...

string	OutputDirectory `[getset]`
	Gets or sets the directory where converted files will be placed when created using `Convert`. More...

SolidFramework.Plumbing.OverwriteMode	OverwriteMode `[getset]`
	Get whether to overwrite an existing output file. More...

Events
global::System.EventHandler< SolidFramework.ProgressEventArgs >	Progress
	Triggered when progress occurs during PDF conversion. More...

global::System.EventHandler< SolidFramework.WarningEventArgs >	Warning
	Triggered when a warning is raised during PDF conversion.

Detailed Description

Converts PDF to PDF/A 1b or 2b compliant document.
This class is used to convert from PDF to PDF/A. If you wish to convert to a PDF that is non-PDF/A then use the PdfToPdfConverter instead.

Member Function Documentation

◆ AddSourceFile() [1/2]

override void SolidFramework.Converters.PdfToPdfAConverter.AddSourceFile ( SolidFramework.Plumbing.Document document )

virtual

Add a PDF file to be converted to the source collection from a loaded Document object.

Parameters

document Document object loaded with a PDF file.

Exceptions

System.ArgumentNullException Thrown when Document object is null.

Reimplemented from SolidFramework.Converters.Converter.

◆ AddSourceFile() [2/2]

override void SolidFramework.Converters.PdfToPdfAConverter.AddSourceFile ( string fullpath )

virtual

Add a PDF file to be converted to the source collection.

Parameters

fullpath String of the full path to the PDF file.

Exceptions

System.IO.FileNotFoundException Thrown when path is invalid.

Reimplemented from SolidFramework.Converters.Converter.

◆ AddSourceFiles()

void SolidFramework.Converters.Converter.AddSourceFiles ( SolidFramework.StringsArray paths )

inherited

Add a collection of PDF file paths to be converted to the source collection.

Parameters

paths ReadOnlyCollection(String) collection of PDF source file paths.

◆ Convert()

override void SolidFramework.Converters.PdfToPdfAConverter.Convert ( )

virtual

Starts the conversion of a PDF file to a PDF/A 1b or 2b file.

Reimplemented from SolidFramework.Converters.Converter.

◆ ConvertTo() [1/2]

SolidFramework.Converters.Plumbing.ConversionStatus SolidFramework.Converters.Converter.ConvertTo ( string fullpath )

inherited

Converts single file to specified path

Parameters

fullpath The fullpath.

Returns

◆ ConvertTo() [2/2]

override SolidFramework.Converters.Plumbing.ConversionStatus SolidFramework.Converters.PdfToPdfAConverter.ConvertTo	(	string	fullpath,
		bool	overwrite
	)

virtual

Converts single file to specified path.

Parameters

fullpath	The fullpath.
overwrite	if set to `true` [overwrite].

Returns

Reimplemented from SolidFramework.Converters.Converter.

◆ Dispose()

override void SolidFramework.Converters.PdfToPdfAConverter.Dispose ( )

virtual

Reimplemented from SolidFramework.Converters.Converter.

◆ Validate()

void SolidFramework.Converters.PdfToPdfAConverter.Validate ( SolidFramework.Plumbing.ValidationMode mode )

Check whether the PDF file passes PDF/A validation for the specified mode.

Parameters

mode	The PDF/A mode to validate as.

Property Documentation

◆ OcrImageCompression

SolidFramework.Imaging.Plumbing.ImageCompression SolidFramework.Converters.PdfToPdfAConverter.OcrImageCompression

getset

Gets or sets the compression method to be used for images. This will affect file size and image quality.

Choose from ColourOrBetter, FakeMono, GrayOrBetter, Mono, FakeMone, RealGrayOrBetter, Lossless, PreserveOriginal or Unknown. SolidFramework.Imaging.Plumbing.ImageCompression.ColorOrBetter;

◆ OcrLanguage

string SolidFramework.Converters.PdfToPdfAConverter.OcrLanguage

getset

Gets or sets the OCR language to to be used.

The format used is typically the first two letters of the language as spelt in that language. "en" for English, "es" for Spanish, "de" for German etc. If Chinese, Korean, Japanese or Greek is selected then the tesseract "traineddata" files will also be required. Please see documentation for details.

◆ OcrType

SolidFramework.Converters.Plumbing.OcrType SolidFramework.Converters.PdfToPdfAConverter.OcrType

getset

Gets or sets the type of OCR to be performed.

None - No OCR, Full - OCR everything - CreateSearchableTextLayer - Enable the converted file to be searchable.

◆ OutputDirectory

string SolidFramework.Converters.Converter.OutputDirectory

getsetinherited

Gets or sets the directory where converted files will be placed when created using Convert.

The output directory.

◆ OverwriteMode

SolidFramework.Plumbing.OverwriteMode SolidFramework.Converters.Converter.OverwriteMode

getsetinherited

Get whether to overwrite an existing output file.

Set the desired action when the output file already exists. Default is FailIfExists.

◆ SourceDirectory

string SolidFramework.Converters.Converter.SourceDirectory

getsetinherited

Gets the source directory.

The source directory.

◆ TextWatermark

SolidFramework.Converters.Plumbing.TextWatermark SolidFramework.Converters.PdfToPdfAConverter.TextWatermark

getset

Gets or sets the Text Watermark to be used in the converted file.

A watermark is an impression that displays on top of or below the content of a PDF page. Watermarks can be useful for identifying drafts and confidential documents or placing a logo on each page.

Event Documentation

◆ Progress

global.System.EventHandler<SolidFramework.ProgressEventArgs> SolidFramework.Converters.Converter.Progress

inherited

Triggered when progress occurs during PDF conversion.

ProgressEventArgs contains the amount of progress, the maximum amount of progress, a status code, a description, plus optional custom data.

Public Member Functions

Static Public Member Functions

Properties

Events

Detailed Description

Member Function Documentation

◆ AddSourceFile() [1/2]

◆ AddSourceFile() [2/2]

◆ AddSourceFiles()

◆ Convert()

◆ ConvertTo() [1/2]

◆ ConvertTo() [2/2]

◆ Dispose()

◆ Validate()

Property Documentation

◆ OcrImageCompression

◆ OcrLanguage

◆ OcrType

◆ OutputDirectory

◆ OverwriteMode

◆ SourceDirectory

◆ TextWatermark

Event Documentation

◆ Progress