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_none.

Declaration

public void SetBookmarkConversionMethod(Convert.WordOutputOptions.BookmarkConversionMethod method)

Parameters

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

SetConnectHyphens(Boolean)

Specifies whether hyphens in the PDF should be connected. This only works with English words. 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.

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.

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.

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.

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.

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.

SetPages(Int32, Int32)

Declaration

public void SetPages(int pageFrom, int pageTo)

Parameters

Type	Name	Description
System.Int32	pageFrom
System.Int32	pageTo

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.

SetSearchableImageSetting(Convert.WordOutputOptions.SearchableImageSetting)

Specifies how image + hidden text pages should be converted. Default is e_ocr_image_text. Note: this feature does not perform OCR.

Declaration

public void SetSearchableImageSetting(Convert.WordOutputOptions.SearchableImageSetting setting)

Parameters

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

SetShrinkCharacterSpacingToPreventWrap(Boolean)

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

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.

SetWordOutputFormat(Convert.WordOutputOptions.WordOutputFormat)

Specifies the output document format (DOCX, DOC, RTF). It is the most useful when the output file extension is not .docx, .doc or .rtf.

Declaration

public void SetWordOutputFormat(Convert.WordOutputOptions.WordOutputFormat format)

Parameters

Type	Name	Description
Convert.WordOutputOptions.WordOutputFormat	format	the output document format (DOCX, DOC, RTF).