Converts and reconstructs PDF files to editable Microsoft Word documents More...

Inheritance diagram for SolidFramework.Converters.PdfToWordConverter:

Public Member Functions
override void	Dispose ()

	PdfToWordConverter ()
	Initializes a new instance of the PdfToWordConverter class.

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

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)
	Converts the specified source file. If the destination file exists then the conversion will fail with `ConversionStatus.IOFileLocked`. Always check the value of the returned ConversionResult to verify that conversion was successful. More...

static SolidFramework.Converters.Plumbing.ConversionStatus	Convert (string sourceFileName, string destinationFileName, bool overwrite)
	Converts the selected or specified source file. Always check the value of the returned ConversionResult to verify that conversion was successful. 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	WordInstalled `[get]`
	Gets a value indicating whether [word installed]. More...

bool	DetectToc `[getset]`
	Gets or sets whether Table of Contents should be detected from the document content. The default is `true`.

bool	DetectLists `[getset]`
	Gets or sets whether lists should be detected from the document content. The default is `true`.

bool	DetectTables `[getset]`
	Gets or sets whether tables should be detected as tables, rather than being treated as plain text. The default is `true`. More...

bool	DetectTaggedTables `[getset]`
	Gets or sets whether text that is tagged as being a table in the PDF should be always be considered to be a table, rather than being considered as a table only if it "looks" like one. The default is `true`. More...

bool	DetectTiledPages `[getset]`
	Attempt to automatically detect tables tiled across multiple pages.

bool	DetectStyles `[getset]`
	Gets or sets whether styles should be detected from the document content. The default is `true`.

bool	DetectLanguage `[getset]`
	Gets or sets whether the document language should be detected from the document content. The default is `true`.

bool	KeepCharacterSpacing `[getset]`
	Get or sets whether to keep character spacing. Default is `true`.

bool	AverageCharacterScaling `[getset]`
	Get or sets whether the spacing between characters should be set as to their average size. This is required because fonts in PDF and docx are different and therefore the same Unicode characters have different character widths in PDF and docx. This value must be set to true if the generated docx file is to look the same as the PDF file. Setting the value to true will also result in the creation of fewer, but larger "Run" objects. The default is `true`.

bool	MergeParagraphIndents `[getset]`

bool	SupportRightToLeftWritingDirection `[getset]`
	Get whether to support right-to-left writing direction. Default is `true`.

SolidFramework.Converters.Plumbing.WordDocumentType	OutputType `[getset]`
	Gets or sets the type of the output to be created by the converter. Default is `WordDocumentType.DocX`

SolidFramework.Converters.Plumbing.ImageAnchoringMode	ImageAnchoringMode `[getset]`
	Get or sets a E:ImageAnchoringMode that specifies the header and footer mode. Default is `ImageAnchoringMode.Automatic`.

SolidFramework.Converters.Plumbing.ReconstructionMode	ReconstructionMode `[getset]`
	Gets or sets the E:ReconstructionMode reconstruction mode. Default is `ReconstructionMode.Flowing`.

SolidFramework.Converters.Plumbing.HeaderAndFooterMode	HeaderAndFooterMode `[getset]`
	Get or sets a E:HeaderAndFooterMode that specifies the header and footer mode. Default is `HeaderAndFooterMode.Detect`.

SolidFramework.Converters.Plumbing.FootnotesMode	FootnotesMode `[getset]`
	Get or sets a E:FootnotesMode that specifies the header and footer mode. Default is `FootnotesMode.Ignore`.

SolidFramework.Converters.Plumbing.MarkupAnnotConversionType	MarkupAnnotConversionType `[getset]`
	Get or sets a E:MarkupAnnotConversionType that specifies how Markup Annotations should be converted. Default is `MarkupAnnotConversionType.TextBox`.

SolidFramework.Converters.Plumbing.TargetWordFormat	TargetWordFormat `[getset]`
	Get a E:TargetWordFormat that specifies Target MS Word File Format Version. Default is `TargetWordFormat.Automatic`.

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.

Detailed Description

Converts and reconstructs PDF files to editable Microsoft Word documents

Member Function Documentation

◆ AddSourceFile() [1/2]

override void SolidFramework.Converters.PdfToWordConverter.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.PdfToOfficeDocumentConverter.

◆ AddSourceFile() [2/2]

override void SolidFramework.Converters.PdfToWordConverter.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.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

paths ReadOnlyCollection(String) collection of PDF source file paths.

◆ Convert() [1/3]

override void SolidFramework.Converters.PdfToWordConverter.Convert ( )

virtual

Converts files

Reimplemented from SolidFramework.Converters.PdfToOfficeDocumentConverter.

◆ Convert() [2/3]

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

static

Converts the specified source file. If the destination file exists then the conversion will fail with ConversionStatus.IOFileLocked. Always check the value of the returned ConversionResult to verify that conversion was successful.

Parameters

sourceFileName	Name of the source file.
destinationFileName	Name of the destination file.

Returns: A ConversionStatus that indicates whether the conversion succeeded.

◆ Convert() [3/3]

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

static

Converts the selected or specified source file. Always check the value of the returned ConversionResult to verify that conversion was successful.

Parameters

sourceFileName	Name of the source file.
destinationFileName	Name of the destination file.
overwrite	Specifies whether or not to verwrite an existing destination file. If `false` and the destination file exists then the conversion will fail with `ConversionStatus.IOFileLocked`.

Returns: A ConversionStatus that indicates whether the conversion succeeded.

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

◆ Dispose()

override void SolidFramework.Converters.PdfToWordConverter.Dispose ( )

virtual

Reimplemented from SolidFramework.Converters.PdfToOfficeDocumentConverter.

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

◆ DetectTables

bool SolidFramework.Converters.PdfToWordConverter.DetectTables

getset

Gets or sets whether tables should be detected as tables, rather than being treated as plain text. The default is true.

The Table Detection option will be used as default when converting PDF files unless you specify otherwise. This option is only used when ReconstructionMode is Flowing or Continuous.

◆ DetectTaggedTables

bool SolidFramework.Converters.PdfToWordConverter.DetectTaggedTables

getset

Gets or sets whether text that is tagged as being a table in the PDF should be always be considered to be a table, rather than being considered as a table only if it "looks" like one. The default is true.

remarks> Note that the default value generally gives results that are closer to the structure of the PDF. However, when comparing two similar documents where one is tagged and one is not, the results can be quite different. In that case it may be useful to set this value to false. If the PDF is not tagged then this value has no effect. See also RemoveStructTreeRoot which can be used to remove tagging from the PDF.

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

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

◆ WordInstalled

bool SolidFramework.Converters.PdfToWordConverter.WordInstalled

get

Gets a value indicating whether [word installed].

true if [word installed]; otherwise, false.

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() [1/3]

◆ Convert() [2/3]

◆ Convert() [3/3]

◆ ConvertTo() [1/2]

◆ ConvertTo() [2/2]

◆ Dispose()

◆ GetResultAsStream()

Property Documentation

◆ AutoRotate

◆ DetectTables

◆ DetectTaggedTables

◆ GraphicsAsImages

◆ ImageWatermark

◆ KeepBackgroundColorText

◆ KeepInvisibleText

◆ OutputDirectory

◆ OverwriteMode

◆ PageRange

◆ Password

◆ SelectedAreas

◆ SourceDirectory

◆ TextRecoveryAutomaticGNse

◆ TextRecoveryEngine

◆ TextRecoveryEngineNse

◆ TextRecoveryLanguage

◆ TextRecoveryNseType

◆ TextRecoveryType

◆ UserProperties

◆ WordInstalled

Event Documentation

◆ Progress