This class is used internally by SolidFramework. It should not be used directly. More...

Inheritance diagram for SolidFramework.Converters.SolidConverterPdf:

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 bool	operator== (SolidFramework.Converters.Converter obj1, SolidFramework.Converters.Converter obj2)

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

Properties
SolidFramework.Converters.Plumbing.ImageWatermark	ImageWatermark `[getset]`
	Gets or sets an image as a watermark in the converted file More...

string	Password `[getset]`
	Gets the password. More...

SolidFramework.PageRange	PageRange `[getset]`
	Gets the page range. More...

bool	DetectSoftHyphens `[getset]`
	Gets or sets a value indicating whether soft-hyphens should be detected. The default is `false`.

bool	NoRepairing `[getset]`
	In the event of a damaged PDF (InternalError) do not attempt to repair the PDF before conversion.

bool	GraphicsAsImages `[getset]`
	Gets or sets whether vector images should be converted to bitmap images. Default is `false`. More...

bool	KeepInvisibleText `[getset]`
	Gets or sets whether text that is invisible because it has no stroke or fill (PDF rendering mode 3 is typically used for a searchable layer in scanned pages) should be recovered. Default is `false`. More...

bool	KeepBackgroundColorText `[getset]`
	Gets or sets whether text that is invisible because it is the same colour as the background should be recovered. Default is `false`. 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

This class is used internally by SolidFramework. It should not be used directly.

Member Function Documentation

◆ AddSourceFile() [1/2]

override void SolidFramework.Converters.SolidConverterPdf.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.SolidConverterPdf.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.SolidConverterPdf.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.SolidConverterPdf.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.SolidConverterPdf.Dispose ( )

virtual

Reimplemented from SolidFramework.Converters.Converter.

Property Documentation

◆ GraphicsAsImages

bool SolidFramework.Converters.SolidConverterPdf.GraphicsAsImages

getset

Gets or sets whether vector images should be converted to bitmap images. Default is false.

If true then vector images will be converted to bitmap images; otherwise they will be retained as vector images.

◆ ImageWatermark

SolidFramework.Converters.Plumbing.ImageWatermark SolidFramework.Converters.SolidConverterPdf.ImageWatermark

getset

Gets or sets an image as a watermark in the converted file

A watermark is an impression that displays on top of or below the content of a PDF page. Image watermarks can be useful for placing a logo on each page. To set an ImageWatermark, assign the path to the Image, ImageWatermark.Path = "C:\\MyDocuments\\MyWatermark.jpg"; Alternatively watermarks can be text. TextWatermark watermark = new TextWatermark(); watermark.Text = "DRAFT";

◆ KeepBackgroundColorText

bool SolidFramework.Converters.SolidConverterPdf.KeepBackgroundColorText

getset

Gets or sets whether text that is invisible because it is the same colour as the background should be recovered. Default is false.

If true then text that is the same colour as the background will be recovered, else it will be discarded.

◆ KeepInvisibleText

bool SolidFramework.Converters.SolidConverterPdf.KeepInvisibleText

getset

Gets or sets whether text that is invisible because it has no stroke or fill (PDF rendering mode 3 is typically used for a searchable layer in scanned pages) should be recovered. Default is false.

If true then invisible text that has no stroke or fill will be recovered, else it will be discarded.

◆ 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.

◆ PageRange

SolidFramework.PageRange SolidFramework.Converters.SolidConverterPdf.PageRange

getset

Gets the page range.

The page range.

◆ Password

string SolidFramework.Converters.SolidConverterPdf.Password

getset

Gets the password.

The password.

◆ 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

◆ GraphicsAsImages

◆ ImageWatermark

◆ KeepBackgroundColorText

◆ KeepInvisibleText

◆ OutputDirectory

◆ OverwriteMode

◆ PageRange

◆ Password

◆ SourceDirectory

Event Documentation

◆ Progress