Class Convert.WordOutputOptions

A class containing options common to ToWord functions

Inheritance

System.Object

Convert.WordOutputOptions

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

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

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

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: pdftron.PDF

Assembly: PDFNet.dll

Syntax

public class WordOutputOptions

Constructors

WordOutputOptions()

Creates a WordOutputOptions object with default settings

Declaration

public WordOutputOptions()

Methods

SetBookmarkConversionMethod(Convert.WordOutputOptions.BookmarkConversionMethod)

Specifies if and how PDF bookmarks should be converted into Word. Default is e_bm_extract.

Declaration

public void SetBookmarkConversionMethod(Convert.WordOutputOptions.BookmarkConversionMethod method)

Parameters

Type	Name	Description
Convert.WordOutputOptions.BookmarkConversionMethod	method	the bookmark conversion method

Remarks

This method is deprecated. PDF bookmarks are now automatically converted to Word bookmarks.

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.

SetDisableVerticalSplit(Boolean)

Specifies whether to disable the detection of section columns. Default is false. Enable this if your tables are coming out as section columns.

Declaration

public void SetDisableVerticalSplit(bool disable)

Parameters

Type	Name	Description
System.Boolean	disable	if true, the detection of section columns are disabled.

Remarks

This method is deprecated. Columns are now detected automatically.

SetDoNotAdjustFonts(Boolean)

Specifies whether to disable font adjustments during conversion. Default is false.

Declaration

public void SetDoNotAdjustFonts(bool do_not_adjust)

Parameters

Type	Name	Description
System.Boolean	do_not_adjust	if true, font adjustments are disabled during conversion.

Remarks

This method is deprecated. Font sizes are now detected automatically.

SetFileConversionTimeoutSeconds(Int32)

Specifies the amount of time in seconds after which the conversion fails. Default is 300. Very long files need more time to convert.

Declaration

public void SetFileConversionTimeoutSeconds(int seconds)

Parameters

Type	Name	Description
System.Int32	seconds	the timeout in seconds.

Remarks

This method is deprecated. The timeout feature is no longer necessary.

SetImageDPI(UInt32)

Specifies the output image resolution, from 8 to 600, in Pixels Per Inch (PPI). The higher the PPI, the larger the image. Default 192.

Declaration

public void SetImageDPI(uint dpi)

Parameters

Type	Name	Description
System.UInt32	dpi	the resolution in Pixels Per Inch.

Remarks

This method is deprecated. The optimal image resolution is now chosen automatically for best balance between size and quality.

SetJPGQuality(UInt32)

Specifies the compression quality to use when generating JPEG images.

Declaration

public void SetJPGQuality(uint quality)

Parameters

Type	Name	Description
System.UInt32	quality	the JPEG compression quality, from 0 (highest compression) to 100 (best quality). Default is 75.

Remarks

This method is deprecated. The optimal JPEG quality is now chosen automatically for best balance between size and quality.

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.

SetMatchPDFLineBreaks(Boolean)

Specifies whether PDF line breaks should come out as line breaks in the Word output. This causes each line of text to become a separate paragraph. Default is false.

Declaration

public void SetMatchPDFLineBreaks(bool match)

Parameters

Type	Name	Description
System.Boolean	match	if true, line breaks will come out as line breaks in the Word output.

Remarks

This method is deprecated. Line breaks are now detected automatically.

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.

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.

SetShrinkCharacterSpacingToPreventWrap(Boolean)

Specifies whether to shrink character spaces in order to prevent word wraps. Default is true.

Declaration

public void SetShrinkCharacterSpacingToPreventWrap(bool shrink)

Parameters

Type	Name	Description
System.Boolean	shrink	if true, character spaces are shrunk in order to prevent word wraps.

Remarks

This method is deprecated. Character spacing is now detected automatically.

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.