Class Convert.WordOutputOptions
A class containing options common to ToWord functions
Inheritance
Inherited Members
Namespace: pdftron.PDF
Assembly: PDFNetAndroid.dll
Syntax
public class WordOutputOptions
Constructors
WordOutputOptions()
Creates a WordOutputOptions object with default settings
Declaration
public WordOutputOptions()
Methods
SetConnectHyphens(Boolean)
Specifies whether hyphens in the PDF should be connected. Default is false.
Declaration
public void SetConnectHyphens(bool connect)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | connect | if true, hyphens in the PDF will be connected. |
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). |
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. |
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. |
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. |
SetPrioritizeVisualAppearance(Boolean)
Specifies whether to prefer an exact visual replica of the PDF at the expense of preventing reflow of document paragraphs. Default is false.
Declaration
public void SetPrioritizeVisualAppearance(bool replica)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | replica | False is preferred for most documents that contain paragraphs. Consider using true for documents that don't flow, such as CAD drawings, Illustrator-generated files. |
SetSearchableImageSetting(Convert.WordOutputOptions.SearchableImageSetting)
Specifies how scanned image pages should be converted. Default is e_ocr_text.
Declaration
public void SetSearchableImageSetting(Convert.WordOutputOptions.SearchableImageSetting setting)
Parameters
Type | Name | Description |
---|---|---|
Convert.WordOutputOptions.SearchableImageSetting | setting | the searchable image setting. |
Remarks
Pre-existing OCRed content is ignored and a new OCR is performed from scratch.
SetWordOutputFormat(Convert.WordOutputOptions.WordOutputFormat)
Specifies the output document format (DOCX, RTF, TXT). It is the most useful when the output file extension is not .docx, .rtf or .txt.
Declaration
public void SetWordOutputFormat(Convert.WordOutputOptions.WordOutputFormat format)
Parameters
Type | Name | Description |
---|---|---|
Convert.WordOutputOptions.WordOutputFormat | format | the output document format (DOCX, RTF, TXT). |
Remarks
The DOC file format is now deprecated, DOCX is used automatically instead.