Class Convert.WordOutputOptions

A class containing options common to ToWord functions

Inheritance

System.Object

Convert.WordOutputOptions

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.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: pdftron.PDF

Assembly: PDFTronDotNet.dll

Syntax

public class WordOutputOptions

Constructors

| Improve this Doc View Source

WordOutputOptions()

Creates a WordOutputOptions object with default settings

Declaration

public WordOutputOptions()

Methods

| Improve this Doc View Source

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.

| Improve this Doc View Source

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.

| Improve this Doc View Source

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.

| Improve this Doc View Source

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.

| Improve this Doc View Source

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.

| Improve this Doc View Source

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.

| Improve this Doc View Source

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.