Converts a PDF file into another PDF file More...

Inheritance diagram for SolidFramework.Converters.PdfToPdfConverter:

Public Member Functions
override void	Dispose ()

override void	Convert ()
	Converts files 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 SolidFramework.Converters.Plumbing.ConversionStatus	Convert (string sourceFileName, string destinationFileName)

static SolidFramework.Converters.Plumbing.ConversionStatus	Convert (string sourceFileName, string destinationFileName, bool overwrite)

static SolidFramework.Converters.Plumbing.ConversionStatus	Convert (string sourceFileName, string destinationFileName, bool overwrite, string ocrLanguage)

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]`
	Set the OCR language to that of the original document. More...

string	Password `[getset]`

SolidFramework.Converters.Plumbing.TextWatermark	TextWatermark `[getset]`

bool	OcrAlways `[getset]`
	Gets an OCR flag More...

bool	OcrAutoRotate `[getset]`
	Set to true of false to automatically detect if pages require rotatation on conversion. More...

bool	CreateTags `[getset]`
	Gets a Create Tags flag More...

SolidFramework.Converters.Plumbing.OcrType	OcrType `[getset]`
	Choose the type of OCR you want to apply More...

SolidFramework.Converters.Plumbing.TextRecoveryEngine	OcrEngine `[getset]`
	Gets a value indicating whether [OCR always]. More...

SolidFramework.Imaging.Plumbing.ImageCompression	OcrImageCompression `[getset]`
	Set this to compress or change image properties to manage the size of the converted file. 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 a PDF file into another PDF file

Member Function Documentation

◆ AddSourceFile() [1/2]

override void SolidFramework.Converters.PdfToPdfConverter.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.PdfToPdfConverter.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.PdfToPdfConverter.Convert ( )

virtual

Converts files

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.PdfToPdfConverter.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.PdfToPdfConverter.Dispose ( )

virtual

Reimplemented from SolidFramework.Converters.Converter.

Property Documentation

◆ CreateTags

bool SolidFramework.Converters.PdfToPdfConverter.CreateTags

getset

Gets a Create Tags flag

true if [Tags create]; otherwise, false.

◆ OcrAlways

bool SolidFramework.Converters.PdfToPdfConverter.OcrAlways

getset

Gets an OCR flag

true if [OCR always]; otherwise, false.

◆ OcrAutoRotate

bool SolidFramework.Converters.PdfToPdfConverter.OcrAutoRotate

getset

Set to true of false to automatically detect if pages require rotatation on conversion.

true if [ocr auto rotate]; otherwise, false.

◆ OcrEngine

SolidFramework.Converters.Plumbing.TextRecoveryEngine SolidFramework.Converters.PdfToPdfConverter.OcrEngine

getset

Gets a value indicating whether [OCR always].

true if [OCR always]; otherwise, false.

◆ OcrImageCompression

SolidFramework.Imaging.Plumbing.ImageCompression SolidFramework.Converters.PdfToPdfConverter.OcrImageCompression

getset

Set this to compress or change image properties to manage the size of the converted file.

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

◆ OcrLanguage

string SolidFramework.Converters.PdfToPdfConverter.OcrLanguage

getset

Set the OCR language to that of the original document.

Format used is the first two letters of the language as spelt in that language. "en" for English, "es" for Spanish, "de" for German etc.

◆ OcrType

SolidFramework.Converters.Plumbing.OcrType SolidFramework.Converters.PdfToPdfConverter.OcrType

getset

Choose the type of OCR you want to apply

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.

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()

Property Documentation

◆ CreateTags

◆ OcrAlways

◆ OcrAutoRotate

◆ OcrEngine

◆ OcrImageCompression

◆ OcrLanguage

◆ OcrType

◆ OutputDirectory

◆ OverwriteMode

◆ SourceDirectory

Event Documentation

◆ Progress