com.groupdocs.conversion.options.convert

Class WordProcessingConvertOptions

java.lang.Object

com.groupdocs.conversion.contracts.ValueObject

com.groupdocs.conversion.options.convert.ConvertOptions<TFileType>

com.groupdocs.conversion.options.convert.CommonConvertOptions<WordProcessingFileType>

com.groupdocs.conversion.options.convert.WordProcessingConvertOptions

All Implemented Interfaces:

com.aspose.ms.System.IEquatable<ValueObject>, IConvertOptions, IPagedConvertOptions, IPageMarginConvertOptions, IPageOrientationConvertOptions, IPageRangedConvertOptions, IPageSizeConvertOptions, IPdfRecognitionModeOptions, IWatermarkedConvertOptions, Serializable, Cloneable

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

Options for conversion to WordProcessing file type.

See Also:

Serialized Form

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
int	getDpi() Desired page DPI after conversion.
protected List<Object>	getEqualityComponents() Gets equality components.
int	getHeight() Deprecated.
int	getMarginBottom() Desired page bottom margin in pixels after conversion.
int	getMarginLeft() Desired page left margin in pixels after conversion.
int	getMarginRight() Desired page right margin in pixels after conversion.
int	getMarginTop() Desired page top margin in pixels after conversion.
float	getPageHeight() Specified page height in points if is set to PageSize.Custom
PageOrientation	getPageOrientation() Gets page orientation after conversion
PageSize	getPageSize() Gets desired page size after conversion
float	getPageWidth() Specified page width in points if is set to PageSize.Custom
String	getPassword() Set this property if you want to protect the converted document with a password.
PdfRecognitionMode	getPdfRecognitionMode() Gets recognition mode when converting from pdf
RtfOptions	getRtfOptions() RTF specific convert options
int	getWidth() Deprecated.
int	getZoom() Specifies the zoom level in percentage.
void	setDpi(int value) Desired page DPI after conversion.
void	setHeight(int value) Deprecated.
void	setMarginBottom(int value) Desired page bottom margin in pixels after conversion.
void	setMarginLeft(int value) Desired page left margin in pixels after conversion.
void	setMarginRight(int value) Desired page right margin in pixels after conversion.
void	setMarginTop(int value) Desired page top margin in pixels after conversion.
void	setPageHeight(float pageHeight) Set desired page height
void	setPageOrientation(PageOrientation pageOrientation) Sets desired page orientation after conversion
void	setPageSize(PageSize pageSize) Set desired page size after conversion
void	setPageWidth(float pageWidth) Set desired page width
void	setPassword(String value) Set this property if you want to protect the converted document with a password.
void	setPdfRecognitionMode(PdfRecognitionMode pdfRecognitionMode) Sets recognition mode when converting from pdf
void	setRtfOptions(RtfOptions value) RTF specific convert options
void	setWidth(int value) Deprecated.
void	setZoom(int value) Specifies the zoom level in percentage.

Methods inherited from class com.groupdocs.conversion.options.convert.CommonConvertOptions

getPageNumber, getPages, getPagesCount, getWatermark, setPageNumber, setPages, setPagesCount, setWatermark

Methods inherited from class com.groupdocs.conversion.options.convert.ConvertOptions

deepClone, getFormat_ConvertOptions_New, getFormat, memberwiseClone, setFormat_ConvertOptions_New, setFormat

Methods inherited from class com.groupdocs.conversion.contracts.ValueObject

equals, equals, hashCode, op_Equality, op_Inequality

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.groupdocs.conversion.options.convert.IConvertOptions

getFormat, setFormat

Constructor Detail

WordProcessingConvertOptions

public WordProcessingConvertOptions()

Initializes new instance of WordProcessingConvertOptions class.

Method Detail

getDpi

public final int getDpi()

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

getEqualityComponents

protected List<Object> getEqualityComponents()

Description copied from class: ValueObject

Gets equality components.

Specified by:

getEqualityComponents in class ValueObject

Returns:

Collection of objects.

getHeight

@Deprecated
public final int getHeight()

Deprecated.

Desired page height after conversion.

getMarginBottom

public final int getMarginBottom()

Desired page bottom margin in pixels after conversion.

Specified by:

getMarginBottom in interface IPageMarginConvertOptions

getMarginLeft

public final int getMarginLeft()

Desired page left margin in pixels after conversion.

Specified by:

getMarginLeft in interface IPageMarginConvertOptions

getMarginRight

public final int getMarginRight()

Desired page right margin in pixels after conversion.

Specified by:

getMarginRight in interface IPageMarginConvertOptions

getMarginTop

public final int getMarginTop()

Desired page top margin in pixels after conversion.

Specified by:

getMarginTop in interface IPageMarginConvertOptions

getPageHeight

public float getPageHeight()

Description copied from interface: IPageSizeConvertOptions

Specified page height in points if is set to PageSize.Custom

Specified by:

getPageHeight in interface IPageSizeConvertOptions

getPageOrientation

public PageOrientation getPageOrientation()

Description copied from interface: IPageOrientationConvertOptions

Gets page orientation after conversion

Specified by:

getPageOrientation in interface IPageOrientationConvertOptions

getPageSize

public PageSize getPageSize()

Description copied from interface: IPageSizeConvertOptions

Gets desired page size after conversion

Specified by:

getPageSize in interface IPageSizeConvertOptions

getPageWidth

public float getPageWidth()

Description copied from interface: IPageSizeConvertOptions

Specified page width in points if is set to PageSize.Custom

Specified by:

getPageWidth in interface IPageSizeConvertOptions

getPassword

public final String getPassword()

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

getPdfRecognitionMode

public PdfRecognitionMode getPdfRecognitionMode()

Description copied from interface: IPdfRecognitionModeOptions

Gets recognition mode when converting from pdf

Specified by:

getPdfRecognitionMode in interface IPdfRecognitionModeOptions

getRtfOptions

public final RtfOptions getRtfOptions()

RTF specific convert options

getWidth

@Deprecated
public final int getWidth()

Deprecated.

Desired page width after conversion.

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.

setDpi

public final void setDpi(int value)

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

setHeight

@Deprecated
public final void setHeight(int value)

Deprecated.

Desired page height after conversion.

setMarginBottom

public final void setMarginBottom(int value)

Desired page bottom margin in pixels after conversion.

Specified by:

setMarginBottom in interface IPageMarginConvertOptions

setMarginLeft

public final void setMarginLeft(int value)

Desired page left margin in pixels after conversion.

Specified by:

setMarginLeft in interface IPageMarginConvertOptions

setMarginRight

public final void setMarginRight(int value)

Desired page right margin in pixels after conversion.

Specified by:

setMarginRight in interface IPageMarginConvertOptions

setMarginTop

public final void setMarginTop(int value)

Desired page top margin in pixels after conversion.

Specified by:

setMarginTop in interface IPageMarginConvertOptions

setPageHeight

public void setPageHeight(float pageHeight)

Description copied from interface: IPageSizeConvertOptions

Set desired page height

Specified by:

setPageHeight in interface IPageSizeConvertOptions

setPageOrientation

public void setPageOrientation(PageOrientation pageOrientation)

Description copied from interface: IPageOrientationConvertOptions

Sets desired page orientation after conversion

Specified by:

setPageOrientation in interface IPageOrientationConvertOptions

setPageSize

public void setPageSize(PageSize pageSize)

Description copied from interface: IPageSizeConvertOptions

Set desired page size after conversion

Specified by:

setPageSize in interface IPageSizeConvertOptions

setPageWidth

public void setPageWidth(float pageWidth)

Description copied from interface: IPageSizeConvertOptions

Set desired page width

Specified by:

setPageWidth in interface IPageSizeConvertOptions

setPassword

public final void setPassword(String value)

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

setPdfRecognitionMode

public void setPdfRecognitionMode(PdfRecognitionMode pdfRecognitionMode)

Description copied from interface: IPdfRecognitionModeOptions

Sets recognition mode when converting from pdf

Specified by:

setPdfRecognitionMode in interface IPdfRecognitionModeOptions

setRtfOptions

public final void setRtfOptions(RtfOptions value)

RTF specific convert options

setWidth

@Deprecated
public final void setWidth(int value)

Deprecated.

Desired page width after conversion.

setZoom

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.