com.aspose.words

Class RtfSaveOptions

java.lang.Object

com.aspose.words.SaveOptions

com.aspose.words.RtfSaveOptions

public class RtfSaveOptions
extends SaveOptions

Can be used to specify additional options when saving a document into the SaveFormat.RTF format.

To learn more, visit the Specify Save Options documentation article.

Method Summary

Modifier and Type	Method and Description
boolean	getExportCompactSize() Allows to make output RTF documents smaller in size, but if they contain RTL (right-to-left) text, it will not be displayed correctly.
boolean	getExportImagesForOldReaders() Specifies whether the keywords for "old readers" are written to RTF or not.
int	getSaveFormat() Specifies the format in which the document will be saved if this save options object is used.
boolean	getSaveImagesAsWmf() When true all images will be saved as WMF.
void	setExportCompactSize(boolean value) Allows to make output RTF documents smaller in size, but if they contain RTL (right-to-left) text, it will not be displayed correctly.
void	setExportImagesForOldReaders(boolean value) Specifies whether the keywords for "old readers" are written to RTF or not.
void	setSaveFormat(int value) Specifies the format in which the document will be saved if this save options object is used.
void	setSaveImagesAsWmf(boolean value) When true all images will be saved as WMF.

Methods inherited from class com.aspose.words.SaveOptions

createSaveOptions, createSaveOptions, getAllowEmbeddingPostScriptFonts, getDefaultTemplate, getDml3DEffectsRenderingMode, getDmlEffectsRenderingMode, getDmlRenderingMode, getExportGeneratorName, getImlRenderingMode, getMemoryOptimization, getPrettyFormat, getProgressCallback, getTempFolder, getUpdateCreatedTimeProperty, getUpdateFields, getUpdateLastPrintedProperty, getUpdateLastSavedTimeProperty, getUpdateSdtContent, getUseAntiAliasing, getUseHighQualityRendering, setAllowEmbeddingPostScriptFonts, setDefaultTemplate, setDml3DEffectsRenderingMode, setDmlEffectsRenderingMode, setDmlRenderingMode, setExportGeneratorName, setImlRenderingMode, setMemoryOptimization, setPrettyFormat, setProgressCallback, setTempFolder, setUpdateCreatedTimeProperty, setUpdateFields, setUpdateLastPrintedProperty, setUpdateLastSavedTimeProperty, setUpdateSdtContent, setUseAntiAliasing, setUseHighQualityRendering

Methods inherited from class java.lang.Object

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

Method Detail

getSaveFormat

public int getSaveFormat()

Specifies the format in which the document will be saved if this save options object is used. Can only be SaveFormat.RTF.

Specified by:

getSaveFormat in class SaveOptions

Returns:

The corresponding int value. The returned value is one of SaveFormat constants.

setSaveFormat

public void setSaveFormat(int value)

Specifies the format in which the document will be saved if this save options object is used. Can only be SaveFormat.RTF.

Specified by:

setSaveFormat in class SaveOptions

Parameters:

value - The corresponding int value. The value must be one of SaveFormat constants.

getExportCompactSize

public boolean getExportCompactSize()

Allows to make output RTF documents smaller in size, but if they contain RTL (right-to-left) text, it will not be displayed correctly. Default value is false.

If the document that you want to convert to RTF using Aspose.Words does not contain right-to-left text in languages like Arabic, then you can set this option to true to reduce the size of the resulting RTF.

Returns:

The corresponding boolean value.

setExportCompactSize

public void setExportCompactSize(boolean value)

Allows to make output RTF documents smaller in size, but if they contain RTL (right-to-left) text, it will not be displayed correctly. Default value is false.

If the document that you want to convert to RTF using Aspose.Words does not contain right-to-left text in languages like Arabic, then you can set this option to true to reduce the size of the resulting RTF.

Parameters:

value - The corresponding boolean value.

getExportImagesForOldReaders

public boolean getExportImagesForOldReaders()

Specifies whether the keywords for "old readers" are written to RTF or not. This can significantly affect the size of the RTF document. Default value is true.

"Old readers" are pre-Microsoft Word 97 applications and also WordPad. When this option is true Aspose.Words writes additional RTF keywords. These keywords allow the document to be displayed correctly when opened in an "old reader" application, but can significantly increase the size of the document.

If you set this option to false, then only images in WMF, EMF and BMP formats will be displayed in "old readers".

Returns:

The corresponding boolean value.

setExportImagesForOldReaders

public void setExportImagesForOldReaders(boolean value)

Specifies whether the keywords for "old readers" are written to RTF or not. This can significantly affect the size of the RTF document. Default value is true.

"Old readers" are pre-Microsoft Word 97 applications and also WordPad. When this option is true Aspose.Words writes additional RTF keywords. These keywords allow the document to be displayed correctly when opened in an "old reader" application, but can significantly increase the size of the document.

If you set this option to false, then only images in WMF, EMF and BMP formats will be displayed in "old readers".

Parameters:

value - The corresponding boolean value.

getSaveImagesAsWmf

public boolean getSaveImagesAsWmf()

When true all images will be saved as WMF. This option might help to avoid WordPad warning messages.

Returns:

The corresponding boolean value.

setSaveImagesAsWmf

public void setSaveImagesAsWmf(boolean value)

When true all images will be saved as WMF. This option might help to avoid WordPad warning messages.

Parameters:

value - The corresponding boolean value.