Solid Framework SDK 10.0.12602
SDK for converting and extracting value from PDFs
|
Convert PDF to CSV, SQL or unformatted Excel. More...
Public Member Functions | |
override void | Dispose () |
PdfToDataConverter () | |
Initializes a new instance of the PdfToDataConverter class. More... | |
override void | Convert () |
Starts the conversion of a PDF file to a text document. 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... | |
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 bool | operator== (SolidFramework.Converters.Converter obj1, SolidFramework.Converters.Converter obj2) |
static bool | operator!= (SolidFramework.Converters.Converter obj1, SolidFramework.Converters.Converter obj2) |
Properties | |
global::System.Text.Encoding | Encoding [getset] |
bool | AutoDetectSeparators [getset] |
Gets or sets whether to attempt to automatically detect decimal and thousands separators, based on the content of the PDF being converted. Default is true . | |
bool | DetectTiledPages [getset] |
Attempt to automatically detect tables tiled across multiple pages. | |
SolidFramework.Converters.Plumbing.DecimalSeparator | DecimalSeparator [getset] |
Gets the decimal separator. More... | |
SolidFramework.Converters.Plumbing.DataExportFormat | ExportFormat [getset] |
Gets the export format to use. More... | |
SolidFramework.Converters.Plumbing.ThousandsSeparator | ThousandsSeparator [getset] |
Gets the thousands separator. More... | |
SolidFramework.Converters.Plumbing.ExcelTablesOnSheet | SingleTable [getset] |
Get whether to join all output information into a single file. | |
SolidFramework.Converters.Plumbing.LineTerminator | LineTerminator [getset] |
Gets what characters terminate the line, ie Platform, Windows or Mac | |
SolidFramework.Converters.Plumbing.DataDocumentType | OutputType [getset] |
Gets the data document format. | |
SolidFramework.Converters.Plumbing.DelimiterOptions | DelimiterOption [getset] |
Gets the character that will be used to separate each field in the data file. ie. comma, tab or semicolon | |
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.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. | |
Convert PDF to CSV, SQL or unformatted Excel.
SolidFramework.Converters.PdfToDataConverter.PdfToDataConverter | ( | ) |
Initializes a new instance of the PdfToDataConverter class.
Defaults to LineTerminator.Platform
and Encoding = UTF-8
.
|
virtual |
Add a PDF file to be converted to the source collection from a loaded Document
object.
document | Document object loaded with a PDF file. |
System.ArgumentNullException | Thrown when Document object is null. |
Reimplemented from SolidFramework.Converters.Converter.
|
virtual |
Add a PDF file to be converted to the source collection.
fullpath | String of the full path to the PDF file. |
System.IO.FileNotFoundException | Thrown when path is invalid. |
Reimplemented from SolidFramework.Converters.Converter.
|
inherited |
Add a collection of PDF file paths to be converted to the source collection.
paths | ReadOnlyCollection(String) collection of PDF source file paths. |
|
virtual |
Starts the conversion of a PDF file to a text document.
Source and target files must be set before calling Convert()
.
Reimplemented from SolidFramework.Converters.Converter.
|
inherited |
Converts single file to specified path
fullpath | The fullpath. |
|
virtual |
Converts single file to specified path
fullpath | The fullpath. |
overwrite | if set to true [overwrite]. |
Reimplemented from SolidFramework.Converters.Converter.
|
virtual |
Reimplemented from SolidFramework.Converters.Converter.
|
inherited |
Gets the result as stream.
|
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.
|
getset |
Gets the decimal separator.
The decimal separator.
|
getset |
Gets the export format to use.
The export format.
|
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.
|
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";
|
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.
|
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.
|
getsetinherited |
Gets or sets the directory where converted files will be placed when created using Convert
.
The output directory.
|
getsetinherited |
Get whether to overwrite an existing output file.
Set the desired action when the output file already exists. Default is FailIfExists.
|
getsetinherited |
Gets the page range.
The page range.
|
getsetinherited |
Gets the password.
The password.
|
getsetinherited |
Gets or sets the selected areas. The default is null
.
The selected areas.
|
getsetinherited |
Gets the source directory.
The source directory.
|
getsetinherited |
Gets the automatic GNSE options.
The automatic GNSE options.
|
getsetinherited |
Gets or sets the text recovery engine. The default value is automatic
.
The text recovery engine.
|
getsetinherited |
Gets or sets the non-standard encoding recovery engine. The default value is automatic
.
The NSE recovery engine.
|
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
|
getsetinherited |
Gets os sets the text recovery NSE type. The default value is automatic
.
The type of the text recovering NSE.
|
getsetinherited |
Gets or sets the text recovery type. The default value is automatic
.
The type of the text recovery.
|
getset |
Gets the thousands separator.
The thousands separator.
|
getsetinherited |
Gets or sets the user properties. The default is an empty string.
The user properties.
|
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.