TxtSaveOptions

TxtSaveOptions

Overview

TxtSaveOptions is a class in Aspose.Words FOSS for Java. Inherits from: TxtSaveOptionsBase.

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

Edition status of its 93 listed members (a property and its accessor methods are listed separately, overloads once): 93 not yet exercised by a verified example.

This class declares 63 methods for TxtSaveOptions objects in Java programs. Available methods include: createSaveOptions, getAddBidiMarks, getAllowEmbeddingPostScriptFonts, getCustomTimeZoneInfo, getDefaultTemplate, getDml3DEffectsRenderingMode, getDmlEffectsRenderingMode, getDmlRenderingMode, getEncoding, getExportGeneratorName, getExportHeadersFootersMode, getForcePageBreaks, and 50 additional methods. Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package. Properties: addBidiMarks, allowEmbeddingPostScriptFonts, customTimeZoneInfo, defaultTemplate, dml3DEffectsRenderingMode, dmlEffectsRenderingMode, and 25 more.

Properties

NameTypeAccessDescription
saveFormatintRead/WriteSpecifies the format in which the document will be saved if this save options object is used.
simplifyListLabelsbooleanRead/WriteSpecifies whether the program should simplify list labels in case of complex label formatting not being adequately represented by plain text.
addBidiMarksbooleanRead/WriteSpecifies whether to add bi-directional marks before each BiDi run when exporting in plain text format.
listIndentationTxtListIndentationReadGets a TxtListIndentation object that specifies how many and which character to use for indentation of list levels.
preserveTableLayoutbooleanRead/WriteSpecifies whether the program should attempt to preserve layout of tables when saving in the plain text format.
maxCharactersPerLineintRead/WriteGets or sets an integer value that specifies the maximum number of characters per one line.
officeMathExportModeintRead/WriteSpecifies how OfficeMath will be written to the output file.
encodingjava.nio.charset.CharsetRead/WriteGets or sets the encoding.
paragraphBreakStringRead/WriteSpecifies the string to use as a paragraph break when exporting in text formats.
forcePageBreaksbooleanRead/WriteAllows to specify whether the page breaks should be preserved during export.
exportHeadersFootersModeintRead/WriteSpecifies the way headers and footers are exported to the text formats.
exportGeneratorNamebooleanRead/WriteWhen true, causes the name and version of Aspose.Words to be embedded into produced files.
tempFolderStringRead/WriteSpecifies the folder for temporary files used when saving to a DOC or DOCX file.
updateOleControlImagesbooleanRead/WriteGets or sets a value determining whether OLE controls presentation image will be updated.
prettyFormatbooleanRead/WriteWhen true, pretty formats output where applicable.
useAntiAliasingbooleanRead/WriteGets or sets a value determining whether or not to use anti-aliasing for rendering.
useHighQualityRenderingbooleanRead/WriteGets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms.
dmlRenderingModeintRead/WriteGets or sets a value determining how DrawingML shapes are rendered.
dmlEffectsRenderingModeintRead/WriteGets or sets a value determining how DrawingML effects are rendered.
imlRenderingModeintRead/WriteGets or sets a value determining how ink (InkML) objects are rendered.
defaultTemplateStringRead/WriteGets or sets path to default template (including filename).
updateFieldsbooleanRead/WriteGets or sets a value determining if fields of certain types should be updated before saving the document to a fixed page format.
updateLastSavedTimePropertybooleanRead/WriteGets or sets a value determining whether the BuiltInDocumentProperties.getLastSavedTime() property is updated before saving.
updateLastPrintedPropertybooleanRead/WriteGets or sets a value determining whether the BuiltInDocumentProperties.getLastPrinted() property is updated before saving.
updateCreatedTimePropertybooleanRead/WriteGets or sets a value determining whether the BuiltInDocumentProperties.getCreatedTime() property is updated before saving.
memoryOptimizationbooleanRead/WriteGets or sets value determining if memory optimization should be performed before saving the document.
updateAmbiguousTextFontbooleanRead/WriteDetermines whether the font attributes will be changed according to the character code being used.
dml3DEffectsRenderingModeintRead/WriteGets or sets a value determining how 3D effects are rendered.
progressCallbackIDocumentSavingCallbackRead/WriteCalled during saving a document and accepts data about saving progress.
allowEmbeddingPostScriptFontsbooleanRead/WriteGets or sets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved.
customTimeZoneInfoTimeZoneRead/WriteGets or sets custom local time zone used for date/time fields.

Methods

SignatureDescription
getSaveFormat() → intSpecifies the format in which the document will be saved if this save options object is used.
setSaveFormat(value: int)Sets the save format value.
getSimplifyListLabels() → booleanSpecifies whether the program should simplify list labels in case of complex label formatting not being adequately represented by plain text.
setSimplifyListLabels(value: boolean)Sets the simplify list labels value.
getAddBidiMarks() → booleanSpecifies whether to add bi-directional marks before each BiDi run when exporting in plain text format.
setAddBidiMarks(value: boolean)Sets the add bidi marks value.
getListIndentation() → TxtListIndentationGets a TxtListIndentation object that specifies how many and which character to use for indentation of list levels.
getPreserveTableLayout() → booleanSpecifies whether the program should attempt to preserve layout of tables when saving in the plain text format.
setPreserveTableLayout(value: boolean)Sets the preserve table layout value.
getMaxCharactersPerLine() → intGets or sets an integer value that specifies the maximum number of characters per one line.
setMaxCharactersPerLine(value: int)Sets the max characters per line value.
getOfficeMathExportMode() → intSpecifies how OfficeMath will be written to the output file.
setOfficeMathExportMode(value: int)Sets the office math export mode value.
getEncoding() → java.nio.charset.CharsetReturns the encoding.
setEncoding(value: java.nio.charset.Charset)Sets the encoding value.
getParagraphBreak() → StringSpecifies the string to use as a paragraph break when exporting in text formats.
setParagraphBreak(value: String)Sets the paragraph break value.
getForcePageBreaks() → booleanAllows to specify whether the page breaks should be preserved during export.
setForcePageBreaks(value: boolean)Sets the force page breaks value.
getExportHeadersFootersMode() → intSpecifies the way headers and footers are exported to the text formats.
setExportHeadersFootersMode(value: int)Sets the export headers footers mode value.
getExportGeneratorName() → booleanWhen true, causes the name and version of Aspose.Words to be embedded into produced files.
setExportGeneratorName(value: boolean)Sets the export generator name value.
getTempFolder() → StringSpecifies the folder for temporary files used when saving to a DOC or DOCX file.
setTempFolder(value: String)Sets the temp folder value.
getUpdateOleControlImages() → booleanGets or sets a value determining whether OLE controls presentation image will be updated.
setUpdateOleControlImages(value: boolean)Sets the update ole control images value.
getPrettyFormat() → booleanWhen true, pretty formats output where applicable.
setPrettyFormat(value: boolean)Sets the pretty format value.
getUseAntiAliasing() → booleanGets or sets a value determining whether or not to use anti-aliasing for rendering.
setUseAntiAliasing(value: boolean)Sets the use anti aliasing value.
getUseHighQualityRendering() → booleanGets or sets a value determining whether or not to use high quality (i.e. slow) rendering algorithms.
setUseHighQualityRendering(value: boolean)Sets the use high quality rendering value.
getDmlRenderingMode() → intGets or sets a value determining how DrawingML shapes are rendered.
setDmlRenderingMode(value: int)Sets the dml rendering mode value.
getDmlEffectsRenderingMode() → intGets or sets a value determining how DrawingML effects are rendered.
setDmlEffectsRenderingMode(value: int)Sets the dml effects rendering mode value.
getImlRenderingMode() → intGets or sets a value determining how ink (InkML) objects are rendered.
setImlRenderingMode(value: int)Sets the iml rendering mode value.
getDefaultTemplate() → StringGets or sets path to default template (including filename).
setDefaultTemplate(value: String)Sets the default template value.
getUpdateFields() → booleanGets or sets a value determining if fields of certain types should be updated before saving the document to a fixed page format.
setUpdateFields(value: boolean)Sets the update fields value.
getUpdateLastSavedTimeProperty() → booleanGets or sets a value determining whether the BuiltInDocumentProperties.getLastSavedTime() property is updated before saving.
setUpdateLastSavedTimeProperty(value: boolean)Sets the update last saved time property value.
getUpdateLastPrintedProperty() → booleanGets or sets a value determining whether the BuiltInDocumentProperties.getLastPrinted() property is updated before saving.
setUpdateLastPrintedProperty(value: boolean)Sets the update last printed property value.
getUpdateCreatedTimeProperty() → booleanGets or sets a value determining whether the BuiltInDocumentProperties.getCreatedTime() property is updated before saving.
setUpdateCreatedTimeProperty(value: boolean)Sets the update created time property value.
getMemoryOptimization() → booleanGets or sets value determining if memory optimization should be performed before saving the document.
setMemoryOptimization(value: boolean)Sets the memory optimization value.
getUpdateAmbiguousTextFont() → booleanDetermines whether the font attributes will be changed according to the character code being used.
setUpdateAmbiguousTextFont(value: boolean)Sets the update ambiguous text font value.
createSaveOptions(saveFormat: int) → SaveOptionsCreates a save options object of a class suitable for the specified save format.
createSaveOptions(fileName: String) → SaveOptionsCreates a save options object of a class suitable for the file extension specified in the given file name.
getDml3DEffectsRenderingMode() → intGets or sets a value determining how 3D effects are rendered.
setDml3DEffectsRenderingMode(value: int)Sets the dml3 d effects rendering mode value.
getProgressCallback() → IDocumentSavingCallbackCalled during saving a document and accepts data about saving progress.
setProgressCallback(value: IDocumentSavingCallback)Sets the progress callback value.
getAllowEmbeddingPostScriptFonts() → booleanGets or sets a boolean value indicating whether to allow embedding fonts with PostScript outlines when embedding TrueType fonts in a document upon it is saved.
setAllowEmbeddingPostScriptFonts(value: boolean)Sets the allow embedding post script fonts value.
getCustomTimeZoneInfo() → TimeZoneGets or sets custom local time zone used for date/time fields.
setCustomTimeZoneInfo(value: TimeZone)Sets the custom time zone info value.

See Also