WordProcessingConvertOptions

Inheritance: java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.convert.ConvertOptions, com.groupdocs.conversion.options.convert.CommonConvertOptions

All Implemented Interfaces: java.io.Serializable, com.groupdocs.conversion.options.convert.IPageMarginConvertOptions, com.groupdocs.conversion.options.convert.IPageSizeConvertOptions, com.groupdocs.conversion.options.convert.IPageOrientationConvertOptions, com.groupdocs.conversion.options.convert.IPdfRecognitionModeOptions

public class WordProcessingConvertOptions extends CommonConvertOptions<WordProcessingFileType> implements Serializable, IPageMarginConvertOptions, IPageSizeConvertOptions, IPageOrientationConvertOptions, IPdfRecognitionModeOptions

Options for conversion to WordProcessing file type.

Constructors

Constructor Description
WordProcessingConvertOptions() Initializes new instance of WordProcessingConvertOptions class.

Methods

Method Description
getWidth() Desired page width after conversion.
setWidth(int value) Desired page width after conversion.
getHeight() Desired page height after conversion.
setHeight(int value) Desired page height after conversion.
getDpi() Desired page DPI after conversion.
setDpi(double value) Desired page DPI after conversion.
getPassword() Set this property if you want to protect the converted document with a password.
setPassword(String value) Set this property if you want to protect the converted document with a password.
getRtfOptions() RTF specific convert options
setRtfOptions(RtfOptions value) RTF specific convert options
getZoom() Specifies the zoom level in percentage.
setZoom(int value) Specifies the zoom level in percentage.
getMarginTop() Desired page top margin in pixels after conversion.
setMarginTop(int value) Desired page top margin in pixels after conversion.
getMarginBottom() Desired page bottom margin in pixels after conversion.
setMarginBottom(int value) Desired page bottom margin in pixels after conversion.
getMarginLeft() Desired page left margin in pixels after conversion.
setMarginLeft(int value) Desired page left margin in pixels after conversion.
getMarginRight() Desired page right margin in pixels after conversion.
setMarginRight(int value) Desired page right margin in pixels after conversion.
getPageOrientation()
setPageOrientation(PageOrientation pageOrientation)
getPageSize()
setPageSize(PageSize pageSize)
getPdfRecognitionMode()
setPdfRecognitionMode(PdfRecognitionMode pdfRecognitionMode)

WordProcessingConvertOptions()

public WordProcessingConvertOptions()

Initializes new instance of WordProcessingConvertOptions class.

getWidth()

public final int getWidth()

Desired page width after conversion.

Returns: int

setWidth(int value)

public final void setWidth(int value)

Desired page width after conversion.

Parameters:

Parameter Type Description
value int

getHeight()

public final int getHeight()

Desired page height after conversion.

Returns: int

setHeight(int value)

public final void setHeight(int value)

Desired page height after conversion.

Parameters:

Parameter Type Description
value int

getDpi()

public final double getDpi()

Desired page DPI after conversion. The default resolution is: 96 dpi.

Returns: double

setDpi(double value)

public final void setDpi(double value)

Desired page DPI after conversion. The default resolution is: 96 dpi.

Parameters:

Parameter Type Description
value double

getPassword()

public final String getPassword()

Set this property if you want to protect the converted document with a password.

Returns: java.lang.String

setPassword(String value)

public final void setPassword(String value)

Set this property if you want to protect the converted document with a password.

Parameters:

Parameter Type Description
value java.lang.String

getRtfOptions()

public final RtfOptions getRtfOptions()

RTF specific convert options

Returns: RtfOptions

setRtfOptions(RtfOptions value)

public final void setRtfOptions(RtfOptions value)

RTF specific convert options

Parameters:

Parameter Type Description
value RtfOptions

getZoom()

public final int getZoom()

Specifies the zoom level in percentage. Default is 100. Default zoom is supported till Microsoft Word 2010. Starting from Microsoft Word 2013 default zoom is no longer set to document, instead it appears to use the zoom factor of the last document that was opened.

Returns: int

setZoom(int value)

public final void setZoom(int value)

Specifies the zoom level in percentage. Default is 100. Default zoom is supported till Microsoft Word 2010. Starting from Microsoft Word 2013 default zoom is no longer set to document, instead it appears to use the zoom factor of the last document that was opened.

Parameters:

Parameter Type Description
value int

getMarginTop()

public final int getMarginTop()

Desired page top margin in pixels after conversion.

Returns: int

setMarginTop(int value)

public final void setMarginTop(int value)

Desired page top margin in pixels after conversion.

Parameters:

Parameter Type Description
value int

getMarginBottom()

public final int getMarginBottom()

Desired page bottom margin in pixels after conversion.

Returns: int

setMarginBottom(int value)

public final void setMarginBottom(int value)

Desired page bottom margin in pixels after conversion.

Parameters:

Parameter Type Description
value int

getMarginLeft()

public final int getMarginLeft()

Desired page left margin in pixels after conversion.

Returns: int

setMarginLeft(int value)

public final void setMarginLeft(int value)

Desired page left margin in pixels after conversion.

Parameters:

Parameter Type Description
value int

getMarginRight()

public final int getMarginRight()

Desired page right margin in pixels after conversion.

Returns: int

setMarginRight(int value)

public final void setMarginRight(int value)

Desired page right margin in pixels after conversion.

Parameters:

Parameter Type Description
value int

getPageOrientation()

public PageOrientation getPageOrientation()

Gets page orientation after conversion

Returns: PageOrientation

setPageOrientation(PageOrientation pageOrientation)

public void setPageOrientation(PageOrientation pageOrientation)

Sets desired page orientation after conversion

Parameters:

Parameter Type Description
pageOrientation PageOrientation

getPageSize()

public PageSize getPageSize()

Gets desired page size after conversion

Returns: PageSize

setPageSize(PageSize pageSize)

public void setPageSize(PageSize pageSize)

Set desired page size after conversion

Parameters:

Parameter Type Description
pageSize PageSize

getPdfRecognitionMode()

public PdfRecognitionMode getPdfRecognitionMode()

Gets recognition mode when converting from pdf

Returns: PdfRecognitionMode

setPdfRecognitionMode(PdfRecognitionMode pdfRecognitionMode)

public void setPdfRecognitionMode(PdfRecognitionMode pdfRecognitionMode)

Sets recognition mode when converting from pdf

Parameters:

Parameter Type Description
pdfRecognitionMode PdfRecognitionMode