Solid Framework SDK 10.0.12602
SDK for converting and extracting value from PDFs
Classes | Enumerations
SolidFramework.Converters.Plumbing Namespace Reference

Classes

class  ConversionResult
 Implementation of the IConversionResult More...
 
class  IConversionResult
 Interface for conversion results More...
 
class  IConversionResultsCollection
 
class  ImageWatermark
 Represents Image watermark More...
 
class  PdfAConversionResult
 Represents PDF/A conversion result More...
 
class  SelectedArea
 Represents Selected area More...
 
class  SelectedAreas
 Represents Selected area More...
 
class  SelectedAreasCollection
 
class  TextWatermark
 Represents Text watermark More...
 

Enumerations

enum  ConversionProgressState { None = 0 , EndFileProcessing = -1 }
 Represents types of Conversion progress state More...
 
enum  ConversionResultType { IConversionResult , ConversionResult , PdfAConversionResult }
 
enum  ConversionStatus {
  Success = 0 , Canceled = 1 , InternalError = 2 , Unknown = 200 ,
  Fail = 3 , BadData = 5 , IOError = 6 , IOFileLocked = 7 ,
  NotEnoughMemory = 9 , FileHasCopyProtection = 10 , InvalidPagesRange = 8 , UnsupportedEncryptionHandler = 11 ,
  MissingCertificate = 12 , OCRCanceled = 13 , NoTablesToExtract = 15 , NoImagesToExtract = 16 ,
  NoBppConversion = 150 , NoGrayscale = 151 , PSDUnsupportedMode = 152 , PdfAError = 20 ,
  PdfAFatalError = 21 , CanceledExists = 14 , WrongPassword = 31 , NoUserNoOwner = 32 ,
  NoUserOwner = 33 , UserNoOwner = 34 , UserOwner = 35 , InvalidLicense = 36 ,
  AlreadyLoaded = 30 , UnavailableAction = 4
}
 Enum that describes the result of an attempt to convert PDF files to Data, Excel, HTML, Images, PDFA, PowerPoint, Text and Word in a single line of code. More...
 
enum  ConvertMode { Document = 0 , Images , Tables , Presentation }
 
enum  DataDocumentType { Csv = 0 }
 Data output document types. More...
 
enum  DataExportFormat { Text = 0 , Excel , MySQL , MSSQL }
 The data format to export to. More...
 
enum  DecimalSeparator { Period = 0 , Comma }
 The decimal separator used in numeric reconstruction for Excel files. More...
 
enum  DelimiterOptions { Comma = 0 , Semicolon , Tab }
 The delimiter used in data files. More...
 
enum  EmbedFontsMode { NoFontEmbedding = 0 , EmbedEditableFonts = 2 }
 
enum  ExcelDocumentType { Xls = 0 , XlsX }
 Excel output document types. More...
 
enum  ExcelTablesOnSheet { PlaceEachTableOnOwnSheet = 0 , PlaceAllTablesOnSingleSheet = 1 , PlaceTablesForEachPageOnSingleSheet = 2 }
 
enum  FootnotesMode { Detect = 0 , Ignore , Remove }
 Sets footnotes handling mode when converting PDFs More...
 
enum  HeaderAndFooterMode { Detect = 0 , Ignore , Remove }
 Sets Headers and Footers handling mode when converting PDFs More...
 
enum  HtmlImages { Default = 0 , Link = 0 , Ignore = 1 , Embed = 2 }
 Sets images handling mode when converting to HTML format More...
 
enum  HtmlNavigationType {
  HtmlNavigationNoNavigation = 0 , HtmlNavigationPages , HtmlNavigationHeadings , HtmlNavigationBookmarks ,
  HtmlNavigationPagesHeadings , HtmlNavigationPagesBookmarks , HtmlNavigationHeadingsBookmark , HtmlNavigationPagesHeadingsBookmarks ,
  HtmlNavigationSplitFileByPages , HtmlNavigationSplitFileByHeadings , HtmlNavigationSplitFileByBookmarks
}
 Html navigation types. More...
 
enum  ImageAnchoringMode { Automatic = 0 , Paragraph , Page , RemoveImages }
 Sets images anchoring mode in the output Word file More...
 
enum  ImageConversionType { ExtractImages = 0 , ExtractPages }
 Represents types of Image conversion type More...
 
enum  ImageDocumentType {
  Default = 0 , Bmp , Jpeg , Png ,
  Tiff , Gif
}
 Sets converted images format More...
 
enum  LineTerminator { Platform = 0 , Windows , OSX }
 The line terminator used in text based files. More...
 
enum  MarkupAnnotConversionType { Never = 0 , Textbox , Comment }
 Sets annotations recovering mode when converting to Word format. More...
 
enum  OcrType { FullOcr = 0 , CreateSearchableTextLayer = 1 , None = 2 }
 Represents OCR type for the converted document, i.e. Creating a Searchable Text Layer. More...
 
enum  PdfAConversionStatus {
  Compliant = 0 , Failure = 1 , ErrorsFixed = 2 , ErrorsNotFixed = 3 ,
  ErrorsFatal = 4
}
 Represents types of PDFA conversion status More...
 
enum  ReconstructionMode {
  Flowing = 0 , Exact , Continuous , PlainText ,
  NoColumns
}
 Reconstruction mode when converting to Word format More...
 
enum  TargetWordFormat { Automatic = 0 , Word2007 = 12 , Word2010 = 14 , Word2013 = 15 }
 Target MS Word Compatibility Version (OOXML file format) More...
 
enum  TextRecovery { Automatic = 2 , Always = 1 , Never = 0 , Default = Automatic }
 Represents types of Text recovering More...
 
enum  TextRecoveryAutomaticGNse {
  None = 0 , Logos = 0x01 , Styles = 0x02 , Icons = 0x04 ,
  Symbols = 0x08 , Barcodes = 0x10 , Ligatures = 0x20 , AllCaps = 0x40 ,
  SmallCaps = 0x80 , AlphaNum = 0x100 , ExoticLigatures = 0x200 , All = 0x7FF
}
 Configure Automatic GNSE features More...
 
enum  TextRecoveryNSE { Automatic = 2 , Always = 1 , Never = 0 , Default = Automatic }
 Represents types of Text recovery using Non Standard Encoding (NSE) More...
 
enum  ThousandsSeparator { Comma = 0 , Period , Space }
 The thousands separator used in numeric reconstruction for Excel files. More...
 
enum  WordDocumentType {
  WordML = 0 , Rtf , Txt , Doc ,
  DocX
}
 Word output document types. More...
 

Enumeration Type Documentation

◆ ConversionProgressState

Represents types of Conversion progress state

Enumerator
None 

Conversion progress state is None

EndFileProcessing 

Conversion progress state is End File Processing

◆ ConversionResultType

Enumerator
IConversionResult 
ConversionResult 
PdfAConversionResult 

◆ ConversionStatus

Enum that describes the result of an attempt to convert PDF files to Data, Excel, HTML, Images, PDFA, PowerPoint, Text and Word in a single line of code.

Example of use is aConversionStatus Wordconverter = PdfToWordConverter.Convert(pdfPath, WordFile, true);.
Where pdfPath and Word file are defined before ConversionStatus is called, for example if using an OpenFileDialog to caputure the files string pdfPath = OpFile.FileName string wordFile = Path.ChangeExtension(pdfPath, ".docx");

Enumerator
Success 

Successful conversion.

Canceled 

Conversion was canceled.

InternalError 

An Internal Error occurred.

Unknown 

Unknown conversion status (not set yet).

Fail 

Conversion failed.

BadData 

Bad input data.

IOError 

I/O Error

IOFileLocked 

Output file exists and is locked or readonly.

NotEnoughMemory 

Not enough RAM to perform the task.

FileHasCopyProtection 

PDF file is password protected.

InvalidPagesRange 

Invalid page range was specified.

UnsupportedEncryptionHandler 

Unsupported encryption handler.

MissingCertificate 

Missing security certificate.

OCRCanceled 

Conversion was canceled.

NoTablesToExtract 

No tables were found to extract. This will occur when converting to Excel while ignoring non-table content, if only non-table content exists.

NoImagesToExtract 

No images were found to extract.

NoBppConversion 

No Bpp Conversion.

NoGrayscale 

No Gray Scale.

PSDUnsupportedMode 

Unsupported mode.

PdfAError 

The source document has PDFA Errors, but it was posible to correct these in the reconstructed file. For further details look at the PdfAConversionStatus.

PdfAFatalError 

The source document has fatal PDFA Errors. This prevented conversion from occurring.

CanceledExists 

Conversion was canceled because the output file already exists.

WrongPassword 

Wrong security password specified.

NoUserNoOwner 

Conversion status is No User No Owner.

NoUserOwner 

Conversion status is No User Owner.

UserNoOwner 

Conversion status is User No Owner.

UserOwner 

Conversion status is User Owner.

InvalidLicense 

Invalid License used.

AlreadyLoaded 

Document already loaded.

UnavailableAction 

Unavailable action.

◆ ConvertMode

Enumerator
Document 
Images 
Tables 
Presentation 

◆ DataDocumentType

Data output document types.

Enumerator
Csv 

CSV

◆ DataExportFormat

The data format to export to.

Enumerator
Text 

Export to csv or delimited text file

Excel 

Export to xlsx (without styles)

MySQL 

Export to MySQL compatible SQL statements

MSSQL 

Export to MS SQL Server compatible SQL statements

◆ DecimalSeparator

The decimal separator used in numeric reconstruction for Excel files.

Enumerator
Period 

Sets decimal separator to period

Comma 

Sets decimal separator to comma

◆ DelimiterOptions

The delimiter used in data files.

Enumerator
Comma 

Sets delimiter to comma

Semicolon 

Sets delimiter to semicolon

Tab 

Sets delimiter to tab

◆ EmbedFontsMode

Enumerator
NoFontEmbedding 
EmbedEditableFonts 

◆ ExcelDocumentType

Excel output document types.

Enumerator
Xls 

Sets format to Xls.

XlsX 

Sets format to XlsX.

◆ ExcelTablesOnSheet

Enumerator
PlaceEachTableOnOwnSheet 
PlaceAllTablesOnSingleSheet 
PlaceTablesForEachPageOnSingleSheet 

◆ FootnotesMode

Sets footnotes handling mode when converting PDFs

Enumerator
Detect 

Recover footnotes in the output document

Ignore 

Recognize footnotes but place them in the body of the output document

Remove 

Remove footnotes from the output document

◆ HeaderAndFooterMode

Sets Headers and Footers handling mode when converting PDFs

Enumerator
Detect 

Recover Headers and Footers in the output document

Ignore 

Recognize Headers and Footers but place them in the body of the output document

Remove 

Remove Headers and Footers from the output document

◆ HtmlImages

Sets images handling mode when converting to HTML format

Enumerator
Default 

Default value

Link 

Include linked images into output HTML file

Ignore 

Do not include images into output HTML file

Embed 

Embed images into output HTML file

◆ HtmlNavigationType

Html navigation types.

Enumerator
HtmlNavigationNoNavigation 
HtmlNavigationPages 
HtmlNavigationHeadings 
HtmlNavigationBookmarks 
HtmlNavigationPagesHeadings 
HtmlNavigationPagesBookmarks 
HtmlNavigationHeadingsBookmark 
HtmlNavigationPagesHeadingsBookmarks 
HtmlNavigationSplitFileByPages 
HtmlNavigationSplitFileByHeadings 
HtmlNavigationSplitFileByBookmarks 

◆ ImageAnchoringMode

Sets images anchoring mode in the output Word file

Enumerator
Automatic 

Use automatic anchoring

Paragraph 

Anchor images to paragraph

Page 

Anchor images to page

RemoveImages 

Remove images from the output file

◆ ImageConversionType

Represents types of Image conversion type

Enumerator
ExtractImages 

Extract all images from pdf file

ExtractPages 

Create image pages from pdf pages

◆ ImageDocumentType

Sets converted images format

Enumerator
Default 

Use optimal - the most appropriate format for each image

Bmp 

BMP images

Jpeg 

Jpeg images

Png 

Png images

Tiff 

Tiff images

Gif 

Gif images

◆ LineTerminator

The line terminator used in text based files.

Enumerator
Platform 

Set the terminator based on current platform. Allows .Net to determine and set the terminator based on the platform detected.

Windows 

Set the terminator to 0x0D 0x0A (Windows default).

OSX 

Set the terminator to 0x0A (OSX default).

◆ MarkupAnnotConversionType

Sets annotations recovering mode when converting to Word format.

Enumerator
Never 

Do not recover annotations

Textbox 

Recover annotations to textboxes

Comment 

Recover annotations to Word comments

◆ OcrType

Represents OCR type for the converted document, i.e. Creating a Searchable Text Layer.

Enumerator
FullOcr 

Full OCR

CreateSearchableTextLayer 

Create Searchable Text Layer

None 

None

◆ PdfAConversionStatus

Represents types of PDFA conversion status

Enumerator
Compliant 

Document is PDFA compliant

Failure 

Fail conversion

ErrorsFixed 

All errors could be fixed

ErrorsNotFixed 

Not all errors could be fixed

ErrorsFatal 

Document has fatal PDFA errors

◆ ReconstructionMode

Reconstruction mode when converting to Word format

Enumerator
Flowing 

Use Flowing mode

Exact 

Use Exact mode

Continuous 

Use Continuous mode

PlainText 

Use Plain text

NoColumns 

No columns legacy mode

◆ TargetWordFormat

Target MS Word Compatibility Version (OOXML file format)

Enumerator
Automatic 

Not set

Word2007 

MS Word 2007

Word2010 

MS Word 2010

Word2013 

MS Word 2013, MS Word 2016, MS Word 2019, MS Word 365, MS Word Online

◆ TextRecovery

Represents types of Text recovering

Enumerator
Automatic 

Scanned page only

Always 

Use always

Never 

Never use

Default 

Default value is Never

◆ TextRecoveryAutomaticGNse

Configure Automatic GNSE features

Enumerator
None 

No automatic GNSE features

Logos 

Logo glyphs as vector graphics

Styles 

Use GNSE to correct font styles

Icons 

Icon font glyphs as vector graphics

Symbols 

Fully automatic correction of common symbolic fonts

Barcodes 

Barcode fonts as vector graphics

Ligatures 

Fully automatic correction of ligatures like ff, fl fi, ffi, ti, etc.

AllCaps 

AllCap font detection and correction

SmallCaps 

SmallCap font detection and correction

AlphaNum 

Fully automatic correction of alphanumeric glyphs (including automatic by DQ)

ExoticLigatures 

Fully automatic correction of ligatures like ff, fl fi, ffi, ti, etc.

All 

All automatic GNSE features

◆ TextRecoveryNSE

Represents types of Text recovery using Non Standard Encoding (NSE)

Enumerator
Automatic 

Problem characters only

Always 

Every characters

Never 

Never use NSE

Default 

Default value is Automatic

◆ ThousandsSeparator

The thousands separator used in numeric reconstruction for Excel files.

Enumerator
Comma 

Sets thousands separator to comma

Period 

Sets thousands separator to period

Space 

Sets thousands separator to space

◆ WordDocumentType

Word output document types.

Enumerator
WordML 

Sets format to Microsoft Office XML.

Rtf 

Sets format to RTF.

Txt 

Sets format to TXT.

Doc 

Sets format to Doc.

DocX 

Sets format to DocX.