SolidFramework.Model.PdfOptions Class Reference

Specifies values to be used when importing a Pdf file. /summary> More...

Inheritance diagram for SolidFramework.Model.PdfOptions:

Public Member Functions
override void	Dispose ()
virtual void	OnProgress (SolidFramework.ProgressEventArgs args)
virtual void	OnWarning (SolidFramework.WarningEventArgs args)
bool	Equals (SolidFramework.Model.Plumbing.Options other)
override bool	Equals (object obj)
override int	GetHashCode ()

Static Public Member Functions
static bool	operator== (SolidFramework.Model.Plumbing.Options obj1, SolidFramework.Model.Plumbing.Options obj2)
static bool	operator!= (SolidFramework.Model.Plumbing.Options obj1, SolidFramework.Model.Plumbing.Options obj2)

Properties
System.Object	CustomData [getset]
	Custom data to provide during Progress events
string	Password [getset]
	Gets or sets the password for the Pdf file.
string	TextRecoveryLanguage [getset]
	Gets or sets the text recovery language. Default is an empty string. More...
SolidFramework.PageRange	PageRange [getset]
	Gets or sets a PageRange that defines which pages are to be converted. Null means convert all pages.
SolidFramework.Converters.Plumbing.SelectedAreas	SelectedAreas [getset]
	Gets or sets the selected areas. The default is null. More...
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. More...
bool	DetectTiledPages [getset]
	Attempt to automatically detect tables tiled across multiple pages.
bool	TablesFromContent [getset]
	Deprecated alias for KeepNonTableContent.
bool	KeepNonTableContent [getset]
	Gets or sets whether to include non-table content such as images or text when using ConvertMode.Tables.
bool	PreserveColumnsInNonTableContent [getset]
	Gets or sets whether to place non-table content that is detected within columns in the PDF into separate columns when using ConvertMode.Tables. If true then non-table content that is detected will be placed into separate columns. If false then such content will all be placed into the first column. If KeepNonTableContent is false then no non-table content will be included in the reconstructed file and this option will have no meaning.
SolidFramework.Converters.Plumbing.ReconstructionMode	ReconstructionMode [getset]
	Get or sets a E:SolidFramework::Converters::Plumbing::ReconstructionMode that specifies the file reconstruction mode. The default is ReconstructionMode.Flowing.
SolidFramework.Converters.Plumbing.ExcelTablesOnSheet	ExcelTablesOnSheet [getset]
	Get or sets a E:ExcelTablesOnSheet that specifies how tables should be handled when exporting to Excel. Default is ExcelTablesOnSheet.PlaceEachTableOnOwnSheet.
SolidFramework.Converters.Plumbing.TextRecovery	TextRecovery [getset]
	Get or sets a E:TextRecovery that specifies when OCR is used. Default is TextRecovery.Automatic. Warning: setting this value to TextRecovery.Always will casue OCR to occur even on non-scanned Pdf files.
SolidFramework.Converters.Plumbing.TextRecoveryNSE	TextRecoveryNSE [getset]
	Get or sets a E:TextRecoveryNSE that specifies whether OCR is used for characters with non-standard encoding. Default is TextRecoveryNSE.Automatic.
SolidFramework.Converters.Plumbing.ConvertMode	ConvertMode [getset]
	Get or sets a E:ConvertMode that specifies whether the document, or just images, or just tables should be converted . Default is ConvertMode.Document.
SolidFramework.Converters.Plumbing.TextRecoveryEngine	TextRecoveryEngine [getset]
	Get or sets a E:TextRecoveryEngine that specifies the text recovery engine to be used for OCR. Default is TextRecoveryEngine.Automatic.
SolidFramework.Converters.Plumbing.TextRecoveryEngineNse	TextRecoveryEngineNse [getset]
	Get or sets a E:TextRecoveryEngineNse that specifies the text recovery engine to be used for OCR when dealing with non-standard encoding. Default is TextRecoveryEngineNse.Automatic.
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 footnotes mode. Default is FootnotesMode.Ignore.
SolidFramework.Converters.Plumbing.DecimalSeparator	DecimalSeparator [getset]
	Gets the decimal separator. More...
SolidFramework.Converters.Plumbing.ThousandsSeparator	ThousandsSeparator [getset]
	Gets the thousands separator. More...
SolidFramework.Converters.Plumbing.MarkupAnnotConversionType	MarkupAnnotConversionType [getset]
	Gets or sets a E:MarkupAnnotConversionType that specifies the markup annotation mode. Default is MarkupAnnotConversionType.TextBox.
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	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	GraphicsAsImages [getset]
	Gets or sets whether vector images should be converted to bitmap images. Default is false. More...
bool	KeepBackgroundColorText [getset]
	Gets or sets whether the background color of text should be retained. The default is false.
bool	KeepInvisibleText [getset]
	Gets or sets whether invisible text should be kept. The default is false.
bool	DetectLanguage [getset]
	Gets or sets whether the document language 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	KeepLineBreaks [getset]
	Gets or sets whether line breaks should be preserved in the content. The default is false.
bool	DetectTables [getset]
bool	DetectTaggedTables [getset]
bool	DetectToc [getset]
	Gets or sets whether Table of Contents should be detected from the document content. The default is true.
bool	DetectSoftHyphens [getset]
	Gets or sets whether soft-hyphens should be detected. The default is false.
bool	ExposeTargetDocumentPagination [getset]
	Gets or sets a value indicating whether document pagination should be exposed. The default is false.
bool	ExposeSourceDocumentPagination [getset]
	Gets or sets a value indicating whether source document pagination should be exposed. The default is false.
bool	TransformPrivateUnicode [getset]
	Gets or sets a value indicating whether to transform characters in Unicode Private Use area to true Unicode equivalents. Default is false.

Events
global::System.EventHandler< SolidFramework.ProgressEventArgs >	Progress
	Triggered when progress occurs during CoreModel creation or while exporting. More...
global::System.EventHandler< SolidFramework.WarningEventArgs >	Warning
	Triggered when a warning is raised during CoreModel creation or while exporting.

Detailed Description

Specifies values to be used when importing a Pdf file. /summary>

Member Function Documentation

Dispose()

override void SolidFramework.Model.PdfOptions.Dispose ( )

virtual

Reimplemented from SolidFramework.Model.Plumbing.Options.

Property Documentation

AutoDetectSeparators

bool SolidFramework.Model.PdfOptions.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.

Returns

A Boolean that indicates whether separators should be detected.

AutoRotate

bool SolidFramework.Model.PdfOptions.AutoRotate

getset

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.

DecimalSeparator

SolidFramework.Converters.Plumbing.DecimalSeparator SolidFramework.Model.PdfOptions.DecimalSeparator

getset

Gets the decimal separator.

The decimal separator.

GraphicsAsImages

bool SolidFramework.Model.PdfOptions.GraphicsAsImages

getset

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.

SelectedAreas

SolidFramework.Converters.Plumbing.SelectedAreas SolidFramework.Model.PdfOptions.SelectedAreas

getset

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

The selected areas.

TextRecoveryLanguage

string SolidFramework.Model.PdfOptions.TextRecoveryLanguage

getset

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

ThousandsSeparator

SolidFramework.Converters.Plumbing.ThousandsSeparator SolidFramework.Model.PdfOptions.ThousandsSeparator

getset

Gets the thousands separator.

The thousands separator.

Event Documentation

Progress

global.System.EventHandler<SolidFramework.ProgressEventArgs> SolidFramework.Model.PdfOptions.Progress

Triggered when progress occurs during CoreModel creation or while exporting.

ProgressEventArgs contains the amount of progress, the maximum amount of progress, a status code, a description, plus optional custom data.