Class Convert.ExcelOutputOptions

A class containing options common to ToExcel functions

Inheritance

System.Object

Convert.ExcelOutputOptions

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ToString()

System.Object.ReferenceEquals(System.Object, System.Object)

Namespace: pdftron.PDF

Assembly: PDFNetiOS.dll

Syntax

public class ExcelOutputOptions

Constructors

ExcelOutputOptions()

Creates a ExcelOutputOptions object with default settings

Declaration

public ExcelOutputOptions()

Methods

GetFootnotesSetting()

Get the setting for footnotes from this options object.

Declaration

public Convert.StructuredOutputOptions.SectionConversionSetting GetFootnotesSetting()

Returns

Type	Description
Convert.StructuredOutputOptions.SectionConversionSetting	The current footnote setting.

GetHeadersAndFootersSetting()

Get the setting for headers and footers from this options object.

Declaration

public Convert.StructuredOutputOptions.SectionConversionSetting GetHeadersAndFootersSetting()

Returns

Type	Description
Convert.StructuredOutputOptions.SectionConversionSetting	The current header and footer setting.

SetCustomOCRLanguage(String)

Specifies the custom OCR languages to use. Use 3-letter ISO 639-2 language codes, separated by spaces. Example: "eng deu spa fra". The default is English.

Declaration

public void SetCustomOCRLanguage(string ocrlang)

Parameters

Type	Name	Description
System.String	ocrlang	the OCR language(s).

SetFootnotesSetting(Convert.StructuredOutputOptions.SectionConversionSetting)

Specifies how footnotes should be converted. Default is e_Recover, which will include them as footnotes.

Declaration

public void SetFootnotesSetting(Convert.StructuredOutputOptions.SectionConversionSetting option)

Parameters

Type	Name	Description
Convert.StructuredOutputOptions.SectionConversionSetting	option	The footnotes setting.

SetHeadersAndFootersSetting(Convert.StructuredOutputOptions.SectionConversionSetting)

Specifies how header and footers should be converted. Default is e_Recover, which will include them as headers and footers.

Declaration

public void SetHeadersAndFootersSetting(Convert.StructuredOutputOptions.SectionConversionSetting option)

Parameters

Type	Name	Description
Convert.StructuredOutputOptions.SectionConversionSetting	option	The header and footer setting.

SetLanguage(Convert.OutputOptionsOCR.LanguageChoice)

Specifies the OCR language. Default is automatic language detection.

Declaration

public void SetLanguage(Convert.OutputOptionsOCR.LanguageChoice language)

Parameters

Type	Name	Description
Convert.OutputOptionsOCR.LanguageChoice	language	the OCR language.

SetNonTableContent(Boolean)

Specifies whether to convert non-tabular content. Default is false.

Declaration

public void SetNonTableContent(bool non_tables)

Parameters

Type	Name	Description
System.Boolean	non_tables	If false, only tabular content is converted to Excel. If true, all textual content is converted to Excel.

SetPages(Int32, Int32)

Specifies a range of pages to be converted. By default all pages are converted. The first page has the page number of 1.

Declaration

public void SetPages(int page_from, int page_to)

Parameters

Type	Name	Description
System.Int32	page_from	the first page to be converted.
System.Int32	page_to	the last page to be converted (inclusive). Use a negative value to specify the last page in the PDF.

SetPageSingleSheet(Boolean)

Specifies whether to combine all tables on a page into a single sheet. Default is false.

Declaration

public void SetPageSingleSheet(bool page_single)

Parameters

Type	Name	Description
System.Boolean	page_single	If false, each logical table on a page goes to a separate Excel sheet. If true, all logical tables for a page are combined into a single Excel sheet.

SetPDFPassword(String)

Specifies the password if the PDF requires one.

Declaration

public void SetPDFPassword(string password)

Parameters

Type	Name	Description
System.String	password	the PDF password, if required; an empty string otherwise.

SetPreferredOCREngine(Convert.OutputOptionsOCR.PreferredOCREngine)

Specifies the preferred OCR engine.

Declaration

public void SetPreferredOCREngine(Convert.OutputOptionsOCR.PreferredOCREngine engine)

Parameters

Type	Name	Description
Convert.OutputOptionsOCR.PreferredOCREngine	engine	the preferred OCR engine.

SetSearchableImageSetting(Convert.ExcelOutputOptions.SearchableImageSetting)

Specifies how scanned image pages should be converted. Default is e_ocr_text.

Declaration

public void SetSearchableImageSetting(Convert.ExcelOutputOptions.SearchableImageSetting setting)

Parameters

Type	Name	Description
Convert.ExcelOutputOptions.SearchableImageSetting	setting	the searchable image setting.

Remarks

Pre-existing OCRed content is ignored and a new OCR is performed from scratch.

SetSingleSheet(Boolean)

Specifies whether to combine all tables into a single sheet. Default is false.

Declaration

public void SetSingleSheet(bool single_sheet)

Parameters

Type	Name	Description
System.Boolean	single_sheet	If false, each logical table goes to a separate Excel sheet. If true, all logical tables are combined into a single Excel sheet.