SolidFramework.Converters.Converter Class Reference

This class is used internally by SolidFramework. It should not be used directly. Base class for all converters. More...

Inheritance diagram for SolidFramework.Converters.Converter:

Classes
class	SourceFile

Public Member Functions
virtual void	Dispose ()
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	Convert ()
	Converts files More...
virtual void	AddSourceFile (string fullpath)
	Add a PDF file to be converted to the source collection. More...
virtual void	AddSourceFile (SolidFramework.Plumbing.Document document)
	Add a PDF file to be converted to the source collection from a loaded Document object. More...
virtual SolidFramework.Converters.Plumbing.ConversionStatus	ConvertTo (string fullpath, bool overwrite)
	Converts single file to specified path More...
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
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. Base class for all converters.

Member Function Documentation

AddSourceFile() [1/2]

virtual void SolidFramework.Converters.Converter.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 in SolidFramework.Converters.PdfToDataConverter, SolidFramework.Converters.PdfToExcelConverter, SolidFramework.Converters.PdfToHtmlConverter, SolidFramework.Converters.PdfToImageConverter, SolidFramework.Converters.PdfToOfficeDocumentConverter, SolidFramework.Converters.PdfToPdfAConverter, SolidFramework.Converters.PdfToPdfConverter, SolidFramework.Converters.PdfToPowerPointConverter, SolidFramework.Converters.PdfToTextConverter, SolidFramework.Converters.PdfToWordConverter, and SolidFramework.Converters.SolidConverterPdf.

AddSourceFile() [2/2]

virtual void SolidFramework.Converters.Converter.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 in SolidFramework.Converters.PdfToDataConverter, SolidFramework.Converters.PdfToExcelConverter, SolidFramework.Converters.PdfToHtmlConverter, SolidFramework.Converters.PdfToImageConverter, SolidFramework.Converters.PdfToOfficeDocumentConverter, SolidFramework.Converters.PdfToPdfAConverter, SolidFramework.Converters.PdfToPdfConverter, SolidFramework.Converters.PdfToPowerPointConverter, SolidFramework.Converters.PdfToTextConverter, SolidFramework.Converters.PdfToWordConverter, and SolidFramework.Converters.SolidConverterPdf.

AddSourceFiles()

void SolidFramework.Converters.Converter.AddSourceFiles

(

SolidFramework.StringsArray

paths

)

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

virtual void SolidFramework.Converters.Converter.Convert ( )

virtual

Converts files

Reimplemented in SolidFramework.Converters.PdfToDataConverter, SolidFramework.Converters.PdfToExcelConverter, SolidFramework.Converters.PdfToHtmlConverter, SolidFramework.Converters.PdfToImageConverter, SolidFramework.Converters.PdfToOfficeDocumentConverter, SolidFramework.Converters.PdfToPdfAConverter, SolidFramework.Converters.PdfToPdfConverter, SolidFramework.Converters.PdfToPowerPointConverter, SolidFramework.Converters.PdfToTextConverter, SolidFramework.Converters.PdfToWordConverter, and SolidFramework.Converters.SolidConverterPdf.

ConvertTo() [1/2]

SolidFramework.Converters.Plumbing.ConversionStatus SolidFramework.Converters.Converter.ConvertTo

(

string

fullpath

)

Converts single file to specified path

Parameters

fullpath

The fullpath.

Returns

ConvertTo() [2/2]

virtual SolidFramework.Converters.Plumbing.ConversionStatus SolidFramework.Converters.Converter.ConvertTo ( string  fullpath, bool  overwrite  )

virtual

Converts single file to specified path

Parameters

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

Reimplemented in SolidFramework.Converters.PdfToDataConverter, SolidFramework.Converters.PdfToExcelConverter, SolidFramework.Converters.PdfToHtmlConverter, SolidFramework.Converters.PdfToImageConverter, SolidFramework.Converters.PdfToOfficeDocumentConverter, SolidFramework.Converters.PdfToPdfAConverter, SolidFramework.Converters.PdfToPdfConverter, SolidFramework.Converters.PdfToPowerPointConverter, SolidFramework.Converters.PdfToTextConverter, SolidFramework.Converters.PdfToWordConverter, and SolidFramework.Converters.SolidConverterPdf.

Property Documentation

OutputDirectory

string SolidFramework.Converters.Converter.OutputDirectory

getset

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

getset

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

getset

Gets the source directory.

The source directory.

Event Documentation

Progress

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

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.