TxtSaveOptionsBase
遗产: java.lang.Object, com.aspose.words.SaveOptions
public abstract class TxtSaveOptionsBase extends SaveOptions
将文档保存为基于文本的格式时指定附加选项的基类。
要了解更多信息,请访问Specify Save Options文档文章。
构造器
构造函数 | 描述 |
---|---|
TxtSaveOptionsBase() |
方法
TxtSaveOptionsBase()
public TxtSaveOptionsBase()
createSaveOptions(int saveFormat)
public static SaveOptions createSaveOptions(int saveFormat)
参数:
范围 | 类型 | 描述 |
---|---|---|
saveFormat | int |
退货: SaveOptions
createSaveOptions(String fileName)
public static SaveOptions createSaveOptions(String fileName)
创建适合给定文件名中指定的文件扩展名的类的保存选项对象。
参数:
范围 | 类型 | 描述 |
---|---|---|
fileName | java.lang.String | 此文件名的扩展名决定了要创建的保存选项对象的类。 |
退货: SaveOptions - 派生自的类的对象SaveOptions.
equals(Object arg0)
public boolean equals(Object arg0)
参数:
范围 | 类型 | 描述 |
---|---|---|
arg0 | java.lang.Object |
退货: 布尔值
getAllowEmbeddingPostScriptFonts()
public boolean getAllowEmbeddingPostScriptFonts()
获取一个布尔值,指示在保存文档时在文档中嵌入 TrueType 字体时是否允许嵌入带有 PostScript 轮廓的字体。默认值为false.
请注意,Word 不嵌入 PostScript 字体,但可以打开带有此类嵌入字体的文档。
此选项仅在FontInfoCollection.getEmbedTrueTypeFonts() / FontInfoCollection.setEmbedTrueTypeFonts(boolean)的DocumentBase.getFontInfos()属性设置为 true 。
退货: boolean - 一个布尔值,指示在保存文档时是否允许在文档中嵌入 TrueType 字体时嵌入具有 PostScript 轮廓的字体。
getClass()
public final native Class<?> getClass()
退货: java.lang.Class
getDefaultTemplate()
public String getDefaultTemplate()
获取默认模板的路径(包括文件名)。此属性的默认值为empty string.如果指定,此路径用于加载模板时Document.getAutomaticallyUpdateStyles() / Document.setAutomaticallyUpdateStyles(boolean)是真的,但是Document.getAttachedTemplate() / Document.setAttachedTemplate(java.lang.String)是空的。
退货: java.lang.String - 默认模板的路径(包括文件名)。
getDml3DEffectsRenderingMode()
public int getDml3DEffectsRenderingMode()
获取确定如何呈现 3D 效果的值。默认值为Dml3DEffectsRenderingMode.BASIC.
退货: int - 决定如何呈现 3D 效果的值。返回值是其中之一Dml3DEffectsRenderingMode常数。
getDmlEffectsRenderingMode()
public int getDmlEffectsRenderingMode()
获取确定如何呈现 DrawingML 效果的值。默认值为DmlEffectsRenderingMode.SIMPLIFIED.
当文档导出为固定页面格式时使用此属性。
退货: int - 确定如何呈现 DrawingML 效果的值。返回值是其中之一DmlEffectsRenderingMode常数。
getDmlRenderingMode()
public int getDmlRenderingMode()
获取确定如何呈现 DrawingML 形状的值。默认值为DmlRenderingMode.FALLBACK.
当文档导出为固定页面格式时使用此属性。
退货: int - 确定 DrawingML 形状如何呈现的值。返回值是其中之一DmlRenderingMode常数。
getEncoding()
public Charset getEncoding()
退货: java.nio.charset.字符集
getExportGeneratorName()
public boolean getExportGeneratorName()
当为真时,导致 Aspose.Words 的名称和版本被嵌入到生成的文件中。默认值为true.
退货: boolean - 相应的布尔值。
getExportHeadersFootersMode()
public int getExportHeadersFootersMode()
指定将页眉和页脚导出为文本格式的方式。默认值为TxtExportHeadersFootersMode.PRIMARY_ONLY.
退货: int - 相应的 int 值。返回值是其中之一TxtExportHeadersFootersMode常数。
getForcePageBreaks()
public boolean getForcePageBreaks()
允许指定在导出期间是否应保留分页符。
默认值为false.
该属性仅影响显式插入文档的分页符。它与 MS Word 在每页末尾自动插入的分页符无关。
退货: boolean - 相应的布尔值。
getImlRenderingMode()
public int getImlRenderingMode()
获取确定如何呈现墨迹 (InkML) 对象的值。默认值为ImlRenderingMode.INK_ML.
当文档导出为固定页面格式时使用此属性。
退货: int - 确定如何呈现墨迹 (InkML) 对象的值。返回值是其中之一ImlRenderingMode常数。
getMemoryOptimization()
public boolean getMemoryOptimization()
获取确定在保存文档之前是否应执行内存优化的值。此属性的默认值为false.将此选项设置为 true 可以显着减少内存消耗,同时以较慢的保存时间为代价保存大型文档。
退货: 布尔值 - 确定在保存文档之前是否应执行内存优化的值。
getParagraphBreak()
public String getParagraphBreak()
指定在以文本格式导出时用作分段符的字符串。
默认值为ControlChar.CR_LF.
退货: java.lang.String - 相应的 java.lang.String 值。
getPrettyFormat()
public boolean getPrettyFormat()
当 true 时,漂亮的格式输出适用。默认值为false.
调成true使 HTML、MHTML、EPUB、WordML、RTF、DOCX 和 ODT 输出人类可读。用于测试或调试。
退货: boolean - 相应的布尔值。
getProgressCallback()
public IDocumentSavingCallback getProgressCallback()
在保存文档期间调用并接受有关保存进度的数据。
保存到时报告进度SaveFormat.DOCX, SaveFormat.FLAT_OPC, SaveFormat.DOCM, SaveFormat.DOTM, SaveFormat.DOTX, SaveFormat.HTML, SaveFormat.MHTML, SaveFormat.EPUB, SaveFormat.XAML_FLOW, 或者SaveFormat.XAML_FLOW_PACK.
退货: IDocumentSavingCallback - 相应的IDocumentSavingCallback价值。
getSaveFormat()
public abstract int getSaveFormat()
如果使用此保存选项对象,则指定保存文档的格式。
退货: int - 相应的 int 值。返回值是其中之一SaveFormat常数。
getTempFolder()
public String getTempFolder()
指定保存到 DOC 或 DOCX 文件时使用的临时文件的文件夹。默认情况下,此属性为 null 且不使用临时文件。
当Aspose.Words 保存文档时,它需要创建临时的内部结构。默认情况下,这些内部结构是在内存中创建的,并且在保存文档时内存使用会在短时间内出现峰值。保存完成后,内存将被垃圾收集器释放和回收。
如果您正在保存非常大的文档(数千页)和/或同时处理许多文档,那么保存期间的内存峰值可能会非常大,足以导致系统抛出 java.lang.IndexOutOfBoundsException。使用指定临时文件夹getTempFolder() / setTempFolder(java.lang.String)将导致 Aspose.Words 将内部结构保存在临时文件而不是内存中。它会减少保存期间的内存使用量,但会降低保存性能。
该文件夹必须存在且可写,否则会抛出异常。
保存完成后,Aspose.Words 会自动删除所有临时文件。
退货: java.lang.String - 相应的 java.lang.String 值。
getUpdateCreatedTimeProperty()
public boolean getUpdateCreatedTimeProperty()
获取一个值,确定是否BuiltInDocumentProperties.getCreatedTime() / BuiltInDocumentProperties.setCreatedTime(java.util.Date)属性在保存前更新。默认值为假;
退货: boolean - 确定是否BuiltInDocumentProperties.getCreatedTime() / BuiltInDocumentProperties.setCreatedTime(java.util.Date)属性在保存前更新。
getUpdateFields()
public boolean getUpdateFields()
获取一个值,该值确定在将文档保存为固定页面格式之前是否应更新某些类型的字段。此属性的默认值为true.允许指定是否模仿 MS Word 行为。
退货: boolean - 确定在将文档保存为固定页面格式之前是否应更新某些类型的字段的值。
getUpdateLastPrintedProperty()
public boolean getUpdateLastPrintedProperty()
获取一个值,确定是否BuiltInDocumentProperties.getLastPrinted() / BuiltInDocumentProperties.setLastPrinted(java.util.Date)属性在保存前更新。
退货: boolean - 确定是否BuiltInDocumentProperties.getLastPrinted() / BuiltInDocumentProperties.setLastPrinted(java.util.Date)属性在保存前更新。
getUpdateLastSavedTimeProperty()
public boolean getUpdateLastSavedTimeProperty()
获取一个值,确定是否BuiltInDocumentProperties.getLastSavedTime() / BuiltInDocumentProperties.setLastSavedTime(java.util.Date)属性在保存前更新。
退货: boolean - 确定是否BuiltInDocumentProperties.getLastSavedTime() / BuiltInDocumentProperties.setLastSavedTime(java.util.Date)属性在保存前更新。
getUpdateSdtContent()
public boolean getUpdateSdtContent()
获取确定内容是否为StructuredDocumentTag在保存之前更新。默认值为 false 。
退货: boolean - 确定内容是否为StructuredDocumentTag在保存之前更新。
getUseAntiAliasing()
public boolean getUseAntiAliasing()
获取一个值,该值确定是否对渲染使用抗锯齿。
默认值为 false 。当此值设置为 true 时,将使用抗锯齿进行渲染。
当文档导出为以下格式时使用此属性:SaveFormat.TIFF, SaveFormat.PNG, SaveFormat.BMP, SaveFormat.JPEG, SaveFormat.EMF .当文档导出到SaveFormat.HTML, SaveFormat.MHTML, SaveFormat.EPUB和SaveFormat.AZW_3格式 此选项用于光栅图像。
退货: 布尔值 - 确定是否使用抗锯齿进行渲染的值。
getUseHighQualityRendering()
public boolean getUseHighQualityRendering()
获取一个值,该值确定是否使用高质量(即慢速)渲染算法。默认值为 false 。
当文档导出为图像格式时使用此属性:SaveFormat.TIFF, SaveFormat.PNG, SaveFormat.BMP, SaveFormat.JPEG, SaveFormat.EMF.
退货: 布尔值 - 确定是否使用高质量的值(即
hashCode()
public native int hashCode()
退货: 整数
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
setAllowEmbeddingPostScriptFonts(boolean value)
public void setAllowEmbeddingPostScriptFonts(boolean value)
设置一个布尔值,指示在保存文档时在文档中嵌入 TrueType 字体时是否允许嵌入带有 PostScript 轮廓的字体。默认值为false.
请注意,Word 不嵌入 PostScript 字体,但可以打开带有此类嵌入字体的文档。
此选项仅在FontInfoCollection.getEmbedTrueTypeFonts() / FontInfoCollection.setEmbedTrueTypeFonts(boolean)的DocumentBase.getFontInfos()属性设置为 true 。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | boolean | 保存一个布尔值,指示在文档中嵌入 TrueType 字体时是否允许嵌入带有 PostScript 轮廓的字体。 |
setDefaultTemplate(String value)
public void setDefaultTemplate(String value)
将路径设置为默认模板(包括文件名)。此属性的默认值为empty string.如果指定,此路径用于加载模板时Document.getAutomaticallyUpdateStyles() / Document.setAutomaticallyUpdateStyles(boolean)是真的,但是Document.getAttachedTemplate() / Document.setAttachedTemplate(java.lang.String)是空的。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | java.lang.String | 默认模板的路径(包括文件名)。 |
setDml3DEffectsRenderingMode(int value)
public void setDml3DEffectsRenderingMode(int value)
设置确定 3D 效果呈现方式的值。默认值为Dml3DEffectsRenderingMode.BASIC.
参数:
范围 | 类型 | 描述 |
---|---|---|
value | int | 确定如何呈现 3D 效果的值。该值必须是其中之一Dml3DEffectsRenderingMode常数。 |
setDmlEffectsRenderingMode(int value)
public void setDmlEffectsRenderingMode(int value)
设置一个值,确定如何呈现 DrawingML 效果。默认值为DmlEffectsRenderingMode.SIMPLIFIED.
当文档导出为固定页面格式时使用此属性。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | int | 确定如何呈现 DrawingML 效果的值。该值必须是其中之一DmlEffectsRenderingMode常数。 |
setDmlRenderingMode(int value)
public void setDmlRenderingMode(int value)
设置一个值,确定如何呈现 DrawingML 形状。默认值为DmlRenderingMode.FALLBACK.
当文档导出为固定页面格式时使用此属性。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | int | 确定如何呈现 DrawingML 形状的值。该值必须是其中之一DmlRenderingMode常数。 |
setEncoding(Charset value)
public void setEncoding(Charset value)
参数:
范围 | 类型 | 描述 |
---|---|---|
value | java.nio.charset.Charset |
setExportGeneratorName(boolean value)
public void setExportGeneratorName(boolean value)
当为真时,导致 Aspose.Words 的名称和版本被嵌入到生成的文件中。默认值为true.
参数:
范围 | 类型 | 描述 |
---|---|---|
value | boolean | 对应的布尔值。 |
setExportHeadersFootersMode(int value)
public void setExportHeadersFootersMode(int value)
指定将页眉和页脚导出为文本格式的方式。默认值为TxtExportHeadersFootersMode.PRIMARY_ONLY.
参数:
范围 | 类型 | 描述 |
---|---|---|
value | int | 对应的int值。该值必须是其中之一TxtExportHeadersFootersMode常数。 |
setForcePageBreaks(boolean value)
public void setForcePageBreaks(boolean value)
允许指定在导出期间是否应保留分页符。
默认值为false.
该属性仅影响显式插入文档的分页符。它与 MS Word 在每页末尾自动插入的分页符无关。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | boolean | 对应的布尔值。 |
setImlRenderingMode(int value)
public void setImlRenderingMode(int value)
设置一个值,确定如何呈现墨迹 (InkML) 对象。默认值为ImlRenderingMode.INK_ML.
当文档导出为固定页面格式时使用此属性。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | int | 确定如何呈现墨迹 (InkML) 对象的值。该值必须是其中之一ImlRenderingMode常数。 |
setMemoryOptimization(boolean value)
public void setMemoryOptimization(boolean value)
设置确定在保存文档之前是否应执行内存优化的值。此属性的默认值为false.将此选项设置为 true 可以显着减少内存消耗,同时以较慢的保存时间为代价保存大型文档。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | boolean | 确定在保存文档之前是否应执行内存优化的值。 |
setParagraphBreak(String value)
public void setParagraphBreak(String value)
指定在以文本格式导出时用作分段符的字符串。
默认值为ControlChar.CR_LF.
参数:
范围 | 类型 | 描述 |
---|---|---|
value | java.lang.String | 对应的java.lang.String值。 |
setPrettyFormat(boolean value)
public void setPrettyFormat(boolean value)
当 true 时,漂亮的格式输出适用。默认值为false.
调成true使 HTML、MHTML、EPUB、WordML、RTF、DOCX 和 ODT 输出人类可读。用于测试或调试。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | boolean | 对应的布尔值。 |
setProgressCallback(IDocumentSavingCallback value)
public void setProgressCallback(IDocumentSavingCallback value)
在保存文档期间调用并接受有关保存进度的数据。
保存到时报告进度SaveFormat.DOCX, SaveFormat.FLAT_OPC, SaveFormat.DOCM, SaveFormat.DOTM, SaveFormat.DOTX, SaveFormat.HTML, SaveFormat.MHTML, SaveFormat.EPUB, SaveFormat.XAML_FLOW, 或者SaveFormat.XAML_FLOW_PACK.
参数:
范围 | 类型 | 描述 |
---|---|---|
value | IDocumentSavingCallback | 相应的IDocumentSavingCallback价值。 |
setSaveFormat(int value)
public abstract void setSaveFormat(int value)
如果使用此保存选项对象,则指定保存文档的格式。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | int | 对应的int值。该值必须是其中之一SaveFormat常数。 |
setTempFolder(String value)
public void setTempFolder(String value)
指定保存到 DOC 或 DOCX 文件时使用的临时文件的文件夹。默认情况下,此属性为 null 且不使用临时文件。
当Aspose.Words 保存文档时,它需要创建临时的内部结构。默认情况下,这些内部结构是在内存中创建的,并且在保存文档时内存使用会在短时间内出现峰值。保存完成后,内存将被垃圾收集器释放和回收。
如果您正在保存非常大的文档(数千页)和/或同时处理许多文档,那么保存期间的内存峰值可能会非常大,足以导致系统抛出 java.lang.IndexOutOfBoundsException。使用指定临时文件夹getTempFolder() / setTempFolder(java.lang.String)将导致 Aspose.Words 将内部结构保存在临时文件而不是内存中。它会减少保存期间的内存使用量,但会降低保存性能。
该文件夹必须存在且可写,否则会抛出异常。
保存完成后,Aspose.Words 会自动删除所有临时文件。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | java.lang.String | 对应的java.lang.String值。 |
setUpdateCreatedTimeProperty(boolean value)
public void setUpdateCreatedTimeProperty(boolean value)
设置一个值,确定是否BuiltInDocumentProperties.getCreatedTime() / BuiltInDocumentProperties.setCreatedTime(java.util.Date)属性在保存前更新。默认值为假;
参数:
范围 | 类型 | 描述 |
---|---|---|
value | boolean | 一个值决定是否BuiltInDocumentProperties.getCreatedTime() / BuiltInDocumentProperties.setCreatedTime(java.util.Date)属性在保存前更新。 |
setUpdateFields(boolean value)
public void setUpdateFields(boolean value)
设置一个值,确定在将文档保存为固定页面格式之前是否应更新某些类型的字段。此属性的默认值为true.允许指定是否模仿 MS Word 行为。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | boolean | 确定在将文档保存为固定页面格式之前是否应更新某些类型的字段的值。 |
setUpdateLastPrintedProperty(boolean value)
public void setUpdateLastPrintedProperty(boolean value)
设置一个值,确定是否BuiltInDocumentProperties.getLastPrinted() / BuiltInDocumentProperties.setLastPrinted(java.util.Date)属性在保存前更新。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | boolean | 一个值决定是否BuiltInDocumentProperties.getLastPrinted() / BuiltInDocumentProperties.setLastPrinted(java.util.Date)属性在保存前更新。 |
setUpdateLastSavedTimeProperty(boolean value)
public void setUpdateLastSavedTimeProperty(boolean value)
设置一个值,确定是否BuiltInDocumentProperties.getLastSavedTime() / BuiltInDocumentProperties.setLastSavedTime(java.util.Date)属性在保存前更新。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | boolean | 一个值决定是否BuiltInDocumentProperties.getLastSavedTime() / BuiltInDocumentProperties.setLastSavedTime(java.util.Date)属性在保存前更新。 |
setUpdateSdtContent(boolean value)
public void setUpdateSdtContent(boolean value)
设置值确定内容是否StructuredDocumentTag在保存之前更新。默认值为 false 。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | boolean | 值决定是否内容StructuredDocumentTag在保存之前更新。 |
setUseAntiAliasing(boolean value)
public void setUseAntiAliasing(boolean value)
设置一个值,确定是否使用抗锯齿进行渲染。
默认值为 false 。当此值设置为 true 时,将使用抗锯齿进行渲染。
当文档导出为以下格式时使用此属性:SaveFormat.TIFF, SaveFormat.PNG, SaveFormat.BMP, SaveFormat.JPEG, SaveFormat.EMF .当文档导出到SaveFormat.HTML, SaveFormat.MHTML, SaveFormat.EPUB和SaveFormat.AZW_3格式 此选项用于光栅图像。
参数:
范围 | 类型 | 描述 |
---|---|---|
value | boolean | 确定是否使用抗锯齿进行渲染的值。 |
setUseHighQualityRendering(boolean value)
public void setUseHighQualityRendering(boolean value)
设置一个值以确定是否使用高质量(即慢速)渲染算法。默认值为 false 。
当文档导出为图像格式时使用此属性:SaveFormat.TIFF, SaveFormat.PNG, SaveFormat.BMP, SaveFormat.JPEG, SaveFormat.EMF.
参数:
范围 | 类型 | 描述 |
---|---|---|
value | boolean | 确定是否使用高质量的值(即 |
toString()
public String toString()
退货: java.lang.字符串
wait()
public final void wait()
wait(long arg0)
public final native void wait(long arg0)
参数:
范围 | 类型 | 描述 |
---|---|---|
arg0 | long |
wait(long arg0, int arg1)
public final void wait(long arg0, int arg1)
参数:
范围 | 类型 | 描述 |
---|---|---|
arg0 | long | |
arg1 | int |