Solid Framework SDK 10.0.12602
SDK for converting and extracting value from PDFs
Public Member Functions | Static Public Member Functions | Properties | Events | List of all members
SolidFramework.Converters.PdfToPowerPointConverter Class Reference

Converts a PDF file to a PowerPoint Presentation. More...

Inheritance diagram for SolidFramework.Converters.PdfToPowerPointConverter:
SolidFramework.Converters.PdfToOfficeDocumentConverter SolidFramework.Converters.SolidConverterPdf SolidFramework.Converters.Converter

Public Member Functions

override void Dispose ()
 
 PdfToPowerPointConverter ()
 Initializes a new instance of the PdfToPowerPointConverter class. More...
 
override void Convert ()
 Starts the conversion of a PDF file to a PowerPoint Presentation.
More...
 
override void AddSourceFile (string fullpath)
 Adds a PDF file to the collection to be converted. More...
 
override void AddSourceFile (SolidFramework.Plumbing.Document document)
 Adds a PDF file to the collection to be converted from a loaded Document object. More...
 
override SolidFramework.Converters.Plumbing.ConversionStatus ConvertTo (string fullpath, bool overwrite)
 Converts a single file to specified path. More...
 
global::System.IO.Stream GetResultAsStream ()
 Gets the result as stream. More...
 
SolidFramework.Converters.Plumbing.ConversionStatus ConvertTo (string fullpath)
 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...
 
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)
 Convert the specified source file into the specified PowerPoint document. More...
 
static SolidFramework.Converters.Plumbing.ConversionStatus Convert (string sourceFileName, string destinationFileName, bool overwrite)
 Convert the specified source file into the specified PowerPoint document. More...
 
static bool operator== (SolidFramework.Converters.Converter obj1, SolidFramework.Converters.Converter obj2)
 
static bool operator!= (SolidFramework.Converters.Converter obj1, SolidFramework.Converters.Converter obj2)
 

Properties

bool DetectLists [getset]
 Get or sets whether lists within the PDF file should be reconstructed as lists within the PowerPoint Document.
 
bool TextAnnotationsAsSpeakerNotes [getset]
 Gets or sets whether text annotations should be converted into speaker notes. More...
 
SolidFramework.Converters.Plumbing.EmbedFontsMode EmbedFontsMode [getset]
 Gets a E:EmbedFontsMode that specifies embed ot not font programs to output document. Default is EmbedFontsMode.NoFontEmbedding.
 
SolidFramework.Converters.Plumbing.MarkupAnnotConversionType MarkupAnnotConversionType [getset]
 This method is deprecated. Use the property TextAnnotationsAsSpeakerNotes instead.
 
SolidFramework.Converters.Plumbing.SelectedAreas SelectedAreas [getset]
 Gets or sets the selected areas. The default is null. More...
 
string UserProperties [getset]
 Gets or sets the user properties. The default is an empty string. More...
 
string TextRecoveryLanguage [getset]
 Gets or sets the text recovery language. Default is an empty string. More...
 
bool AutoRotate [getset]
 Gets or sets whether to automatically rotate pages based on the orientation of the text on the pages. Default is true. More...
 
bool TextRecoverySuspects [getset]
 Gets or sets a value indicating whether to highlight low confidence words (any word with SolidFramework.Imaging.OcrWord.Confidence less than 100) in the OCR output in yellow. This property has no effect if OCR has not occurred. Default is false.
 
SolidFramework.Converters.Plumbing.TextRecovery TextRecoveryType [getset]
 Gets or sets the text recovery type. The default value is automatic. More...
 
SolidFramework.Converters.Plumbing.TextRecoveryNSE TextRecoveryNseType [getset]
 Gets os sets the text recovery NSE type. The default value is automatic. More...
 
SolidFramework.Converters.Plumbing.TextRecoveryEngine TextRecoveryEngine [getset]
 Gets or sets the text recovery engine. The default value is automatic. More...
 
SolidFramework.Converters.Plumbing.TextRecoveryEngineNse TextRecoveryEngineNse [getset]
 Gets or sets the non-standard encoding recovery engine. The default value is automatic. More...
 
SolidFramework.Converters.Plumbing.TextRecoveryAutomaticGNse TextRecoveryAutomaticGNse [getset]
 Gets the automatic GNSE options. More...
 
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.ProgressEventArgsProgress
 Triggered when progress occurs during PDF conversion. More...
 
global::System.EventHandler< SolidFramework.WarningEventArgsWarning
 Triggered when a warning is raised during PDF conversion.
 

Detailed Description

Converts a PDF file to a PowerPoint Presentation.

Constructor & Destructor Documentation

◆ PdfToPowerPointConverter()

SolidFramework.Converters.PdfToPowerPointConverter.PdfToPowerPointConverter ( )

Initializes a new instance of the PdfToPowerPointConverter class.

Defaults to LineTerminator.Platform and Encoding = UTF-8.

Member Function Documentation

◆ AddSourceFile() [1/2]

override void SolidFramework.Converters.PdfToPowerPointConverter.AddSourceFile ( SolidFramework.Plumbing.Document  document)
virtual

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

Parameters
documentDocument object loaded with a PDF file.
Exceptions
System.ArgumentNullExceptionOccurs when Document object is null.

Reimplemented from SolidFramework.Converters.PdfToOfficeDocumentConverter.

◆ AddSourceFile() [2/2]

override void SolidFramework.Converters.PdfToPowerPointConverter.AddSourceFile ( string  fullpath)
virtual

Adds a PDF file to the collection to be converted.

Parameters
fullpathThe full path to the PDF file.
Exceptions
System.IO.FileNotFoundExceptionOccurs when path can not be found.

Reimplemented from SolidFramework.Converters.PdfToOfficeDocumentConverter.

◆ 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
pathsReadOnlyCollection(String) collection of PDF source file paths.

◆ Convert() [1/3]

override void SolidFramework.Converters.PdfToPowerPointConverter.Convert ( )
virtual

Starts the conversion of a PDF file to a PowerPoint Presentation.

Source and target files must be set before calling Convert().

Reimplemented from SolidFramework.Converters.PdfToOfficeDocumentConverter.

◆ Convert() [2/3]

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

Convert the specified source file into the specified PowerPoint document.

Parameters
sourceFileNameString of the full path to the PDF file.
destinationFileNameString of the full path to the destination PowerPoint document.
Returns
ConversionStatus of the resulting conversion.

◆ Convert() [3/3]

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

Convert the specified source file into the specified PowerPoint document.

Parameters
sourceFileNameString of the full path to the PDF file.
destinationFileNameString of the full path to the destination PowerPoint document.
overwriteIf true, then overwrite the destination file if it exists; otherwise do not.
Returns
ConversionStatus of the resulting conversion.

◆ ConvertTo() [1/2]

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

Converts single file to specified path

Parameters
fullpathThe fullpath.
Returns

◆ ConvertTo() [2/2]

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

Converts a single file to specified path.

Parameters
fullpathThe fullpath.
overwriteif set to true [overwrite].
Returns

Reimplemented from SolidFramework.Converters.PdfToOfficeDocumentConverter.

◆ Dispose()

override void SolidFramework.Converters.PdfToPowerPointConverter.Dispose ( )
virtual

◆ GetResultAsStream()

global.System.IO.Stream SolidFramework.Converters.PdfToOfficeDocumentConverter.GetResultAsStream ( )
inherited

Gets the result as stream.

Returns
The result as stream.

Property Documentation

◆ AutoRotate

bool SolidFramework.Converters.PdfToOfficeDocumentConverter.AutoRotate
getsetinherited

Gets or sets whether to automatically rotate pages based on the orientation of the text on the pages. Default is true.

If a page in the PDF file is set to landscape, and all text is flowing up and down, automatically rotate the page to portrait.

◆ GraphicsAsImages

bool SolidFramework.Converters.SolidConverterPdf.GraphicsAsImages
getsetinherited

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
getsetinherited

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
getsetinherited

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
getsetinherited

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
getsetinherited

Gets the page range.

The page range.

◆ Password

string SolidFramework.Converters.SolidConverterPdf.Password
getsetinherited

Gets the password.

The password.

◆ SelectedAreas

SolidFramework.Converters.Plumbing.SelectedAreas SolidFramework.Converters.PdfToOfficeDocumentConverter.SelectedAreas
getsetinherited

Gets or sets the selected areas. The default is null.

The selected areas.

◆ SourceDirectory

string SolidFramework.Converters.Converter.SourceDirectory
getsetinherited

Gets the source directory.

The source directory.

◆ TextAnnotationsAsSpeakerNotes

bool SolidFramework.Converters.PdfToPowerPointConverter.TextAnnotationsAsSpeakerNotes
getset

Gets or sets whether text annotations should be converted into speaker notes.


This property replaces the deprecated MarkupAnnotConversionType.

◆ TextRecoveryAutomaticGNse

SolidFramework.Converters.Plumbing.TextRecoveryAutomaticGNse SolidFramework.Converters.PdfToOfficeDocumentConverter.TextRecoveryAutomaticGNse
getsetinherited

Gets the automatic GNSE options.

The automatic GNSE options.

◆ TextRecoveryEngine

SolidFramework.Converters.Plumbing.TextRecoveryEngine SolidFramework.Converters.PdfToOfficeDocumentConverter.TextRecoveryEngine
getsetinherited

Gets or sets the text recovery engine. The default value is automatic.

The text recovery engine.

◆ TextRecoveryEngineNse

SolidFramework.Converters.Plumbing.TextRecoveryEngineNse SolidFramework.Converters.PdfToOfficeDocumentConverter.TextRecoveryEngineNse
getsetinherited

Gets or sets the non-standard encoding recovery engine. The default value is automatic.

The NSE recovery engine.

◆ TextRecoveryLanguage

string SolidFramework.Converters.PdfToOfficeDocumentConverter.TextRecoveryLanguage
getsetinherited

Gets or sets the text recovery language. Default is an empty string.

The text recovery language.

Format for each language is as follows: "es" for Spanish "de" for German "it" for Italian "pl" for Polish "pt" for Portugeuse "ru" for Russian "fr" for French "nl" for Dutch "en" for English

◆ TextRecoveryNseType

SolidFramework.Converters.Plumbing.TextRecoveryNSE SolidFramework.Converters.PdfToOfficeDocumentConverter.TextRecoveryNseType
getsetinherited

Gets os sets the text recovery NSE type. The default value is automatic.

The type of the text recovering NSE.

◆ TextRecoveryType

SolidFramework.Converters.Plumbing.TextRecovery SolidFramework.Converters.PdfToOfficeDocumentConverter.TextRecoveryType
getsetinherited

Gets or sets the text recovery type. The default value is automatic.

The type of the text recovery.

◆ UserProperties

string SolidFramework.Converters.PdfToOfficeDocumentConverter.UserProperties
getsetinherited

Gets or sets the user properties. The default is an empty string.

The user properties.

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.