LoadOptions

遗产: java.lang.Object

public class LoadOptions

允许在将文档加载到Document目的。

要了解更多信息,请访问Specify Load Options文档文章。

构造器

构造函数描述
LoadOptions()使用默认值初始化此类的新实例。
LoadOptions(String password)使用指定密码初始化此类的新实例以加载加密文档的快捷方式。
LoadOptions(int loadFormat, String password, String baseUri)初始化此类的新实例。

方法

方法描述
equals(Object arg0)
getBaseUri()获取将用于在需要时将文档中找到的相对 URI 解析为绝对 URI 的字符串。
getClass()
getConvertMetafilesToPng()获取是否转换图元文件(F:Aspose.FileFormat.Wmf或者F:Aspose.FileFormat.Emf ) 图片到F:Aspose.FileFormat.Png图像格式。
getConvertShapeToOfficeMath()获取是否将带有 EquationXML 的形状转换为 Office Math 对象。
getEncoding()如果文档中未指定编码,则获取将用于加载 HTML、TXT 或 CHM 文档的编码。
getFontSettings()允许指定文档字体设置。
getLanguagePreferences()获取将在加载文档时使用的语言首选项。
getLoadFormat()指定要加载的文档的格式。
getMswVersion()允许指定文档加载过程应匹配特定的 MS Word 版本。
getPassword()获取打开加密文档的密码。
getPreserveIncludePictureField()获取在阅读 Microsoft Word 格式时是否保留 INCLUDEPICTURE 字段。
getProgressCallback()在加载文档期间调用并接受有关加载进度的数据。
getResourceLoadingCallback()允许控制从 HTML、MHTML 导入文档时如何加载外部资源(图像、样式表)。
getTempFolder()允许在阅读文档时使用临时文件。
getUpdateDirtyFields()指定是否更新具有脏属性的字段。
getWarningCallback()在加载操作期间调用,当检测到可能导致数据或格式保真度丢失的问题时调用。
hashCode()
notify()
notifyAll()
setBaseUri(String value)设置将用于在需要时将文档中找到的相对 URI 解析为绝对 URI 的字符串。
setConvertMetafilesToPng(boolean value)设置是否转换图元文件(F:Aspose.FileFormat.Wmf或者F:Aspose.FileFormat.Emf ) 图片到F:Aspose.FileFormat.Png图像格式。
setConvertShapeToOfficeMath(boolean value)设置是否将带有 EquationXML 的形状转换为 Office Math 对象。
setEncoding(Charset value)如果文档中未指定编码,则设置将用于加载 HTML、TXT 或 CHM 文档的编码。
setFontSettings(FontSettings value)允许指定文档字体设置。
setLoadFormat(int value)指定要加载的文档的格式。
setMswVersion(int value)允许指定文档加载过程应匹配特定的 MS Word 版本。
setPassword(String value)设置打开加密文档的密码。
setPreserveIncludePictureField(boolean value)设置在阅读 Microsoft Word 格式时是否保留 INCLUDEPICTURE 字段。
setProgressCallback(IDocumentLoadingCallback value)在加载文档期间调用并接受有关加载进度的数据。
setResourceLoadingCallback(IResourceLoadingCallback value)允许控制从 HTML、MHTML 导入文档时如何加载外部资源(图像、样式表)。
setTempFolder(String value)允许在阅读文档时使用临时文件。
setUpdateDirtyFields(boolean value)指定是否更新具有脏属性的字段。
setWarningCallback(IWarningCallback value)在加载操作期间调用,当检测到可能导致数据或格式保真度丢失的问题时调用。
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

LoadOptions()

public LoadOptions()

使用默认值初始化此类的新实例。

LoadOptions(String password)

public LoadOptions(String password)

使用指定密码初始化此类的新实例以加载加密文档的快捷方式。

参数:

范围类型描述
passwordjava.lang.String打开加密文档的密码。可以为 null 或空字符串。

LoadOptions(int loadFormat, String password, String baseUri)

public LoadOptions(int loadFormat, String password, String baseUri)

初始化此类的新实例。

参数:

范围类型描述
loadFormatint
passwordjava.lang.String
baseUrijava.lang.String

equals(Object arg0)

public boolean equals(Object arg0)

参数:

范围类型描述
arg0java.lang.Object

退货: 布尔值

getBaseUri()

public String getBaseUri()

获取将用于在需要时将文档中找到的相对 URI 解析为绝对 URI 的字符串。可以为 null 或空字符串。默认为空。

在以下情况下,此属性用于将相对 URI 解析为绝对 URI:

  1. 从流中加载 HTML 文档时,该文档包含具有相对 URI 的图像,并且没有在 BASE HTML 元素中指定的基本 URI。
  2. 将文档保存为 PDF 和其他格式时,检索使用相对 URI 链接的图像,以便将图像保存到输出文档中。

退货: java.lang.String - 将用于在需要时将文档中找到的相对 URI 解析为绝对 URI 的字符串。

getClass()

public final native Class<?> getClass()

退货: java.lang.Class

getConvertMetafilesToPng()

public boolean getConvertMetafilesToPng()

获取是否转换图元文件(F:Aspose.FileFormat.Wmf或者F:Aspose.FileFormat.Emf ) 图片到F:Aspose.FileFormat.Png图像格式。图元文件 (F:Aspose.FileFormat.Wmf或者F:Aspose.FileFormat.Emf ) 是一种未压缩的图像格式,有时需要大量 RAM 来保存和处理文档。此选项允许将所有图元文件图像转换为F:Aspose.FileFormat.Png关于文档加载。请注意 - 将矢量图形转换为光栅会降低图像质量。

退货: boolean - 是否转换图元文件 (F:Aspose.FileFormat.Wmf或者F:Aspose.FileFormat.Emf ) 图片到F:Aspose.FileFormat.Png图像格式。

getConvertShapeToOfficeMath()

public boolean getConvertShapeToOfficeMath()

获取是否将带有 EquationXML 的形状转换为 Office Math 对象。

退货: 布尔值 - 是否将带有 EquationXML 的形状转换为 Office Math 对象。

getEncoding()

public Charset getEncoding()

如果文档中未指定编码,则获取将用于加载 HTML、TXT 或 CHM 文档的编码。可以为空。默认为空。

此属性仅在加载 HTML、TXT 或 CHM 文档时使用。

如果文档中未指定编码且此属性为 null ,则系统将尝试自动检测编码。

退货: java.nio.charset.Charset - 如果文档中未指定编码,则用于加载 HTML、TXT 或 CHM 文档的编码。

getFontSettings()

public FontSettings getFontSettings()

允许指定文档字体设置。

加载某些格式时,Aspose.Words 可能需要解析字体。例如,在加载 HTML 文档时,Aspose.Words 可能会解析字体以执行字体回退。

如果设置为空,默认静态字体设置FontSettings.getDefaultInstance()将会被使用。

默认值为空。

退货: FontSettings - 相应的FontSettings价值。

getLanguagePreferences()

public LanguagePreferences getLanguagePreferences()

获取将在加载文档时使用的语言首选项。

退货: LanguagePreferences - 加载文档时将使用的语言首选项。

getLoadFormat()

public int getLoadFormat()

指定要加载的文档的格式。默认为LoadFormat.AUTO.

建议您指定LoadFormat.AUTO值并让 Aspose.Words 自动检测文件格式。如果您知道要加载的文档的格式,则可以明确指定格式,这将通过与自动检测格式相关的开销稍微减少加载时间。如果您指定了一个显式的加载格式,但它会被证明是错误的,那么将调用自动检测并进行第二次加载文件的尝试。

退货: int - 相应的 int 值。返回值是其中之一LoadFormat常数。

getMswVersion()

public int getMswVersion()

允许指定文档加载过程应匹配特定的 MS Word 版本。默认值为MsWordVersion.WORD_2019不同的 Word 版本在加载过程中处理文档内容和格式的某些方面可能略有不同,这可能导致文档对象模型中的细微差别。

退货: int - 相应的 int 值。返回值是其中之一MsWordVersion常数。

getPassword()

public String getPassword()

获取打开加密文档的密码。可以为 null 或空字符串。默认为空。

您需要知道密码才能打开加密文档。如果文档未加密,请将其设置为 null 或空字符串。

退货: java.lang.String - 打开加密文档的密码。

getPreserveIncludePictureField()

public boolean getPreserveIncludePictureField()

获取在阅读 Microsoft Word 格式时是否保留 INCLUDEPICTURE 字段。默认值为假。

默认情况下,INCLUDEPICTURE 字段会转换为形状对象。如果您需要保留该字段,例如,如果您希望以编程方式更新它,则可以覆盖它。但是请注意,这种方法在 Aspose.Words 中并不常见。自行承担使用风险。

一种可能的用例可能是使用 MERGEFIELD 作为子字段来动态更改图片的源路径。在这种情况下,您需要将 INCLUDEPICTURE 保留在模型中。

退货: boolean - 在读取 Microsoft Word 格式时是否保留 INCLUDEPICTURE 字段。

getProgressCallback()

public IDocumentLoadingCallback getProgressCallback()

在加载文档期间调用并接受有关加载进度的数据。

LoadFormat.DOCX, LoadFormat.FLAT_OPC, LoadFormat.DOCM, LoadFormat.DOTM, LoadFormat.DOTX, LoadFormat.MARKDOWN, LoadFormat.RTF, LoadFormat.WORD_ML, LoadFormat.DOC, LoadFormat.DOT, LoadFormat.ODT, LoadFormat.OTT支持的格式。

退货: IDocumentLoadingCallback - 相应的IDocumentLoadingCallback价值。

getResourceLoadingCallback()

public IResourceLoadingCallback getResourceLoadingCallback()

允许控制从 HTML、MHTML 导入文档时如何加载外部资源(图像、样式表)。

退货: IResourceLoadingCallback - 相应的IResourceLoadingCallback价值。

getTempFolder()

public String getTempFolder()

允许在阅读文档时使用临时文件。默认情况下,此属性为 null 且不使用临时文件。

该文件夹必须存在且可写,否则会抛出异常。

Aspose.Words 在读取完成后自动删除所有临时文件。

退货: java.lang.String - 相应的 java.lang.String 值。

getUpdateDirtyFields()

public boolean getUpdateDirtyFields()

指定是否更新具有脏属性的字段。

退货: boolean - 相应的布尔值。

getWarningCallback()

public IWarningCallback getWarningCallback()

在加载操作期间调用,当检测到可能导致数据或格式保真度丢失的问题时调用。

退货: IWarningCallback - 相应的IWarningCallback价值。

hashCode()

public native int hashCode()

退货: 整数

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setBaseUri(String value)

public void setBaseUri(String value)

设置将用于在需要时将文档中找到的相对 URI 解析为绝对 URI 的字符串。可以为 null 或空字符串。默认为空。

在以下情况下,此属性用于将相对 URI 解析为绝对 URI:

  1. 从流中加载 HTML 文档时,该文档包含具有相对 URI 的图像,并且没有在 BASE HTML 元素中指定的基本 URI。
  2. 将文档保存为 PDF 和其他格式时,检索使用相对 URI 链接的图像,以便将图像保存到输出文档中。

参数:

范围类型描述
valuejava.lang.String需要时将用于将文档中找到的相对 URI 解析为绝对 URI 的字符串。

setConvertMetafilesToPng(boolean value)

public void setConvertMetafilesToPng(boolean value)

设置是否转换图元文件(F:Aspose.FileFormat.Wmf或者F:Aspose.FileFormat.Emf ) 图片到F:Aspose.FileFormat.Png图像格式。图元文件 (F:Aspose.FileFormat.Wmf或者F:Aspose.FileFormat.Emf ) 是一种未压缩的图像格式,有时需要大量 RAM 来保存和处理文档。此选项允许将所有图元文件图像转换为F:Aspose.FileFormat.Png关于文档加载。请注意 - 将矢量图形转换为光栅会降低图像质量。

参数:

范围类型描述
valueboolean是否转换元文件(F:Aspose.FileFormat.Wmf或者F:Aspose.FileFormat.Emf ) 图片到F:Aspose.FileFormat.Png图像格式。

setConvertShapeToOfficeMath(boolean value)

public void setConvertShapeToOfficeMath(boolean value)

设置是否将带有 EquationXML 的形状转换为 Office Math 对象。

参数:

范围类型描述
valueboolean是否将带有 EquationXML 的形状转换为 Office Math 对象。

setEncoding(Charset value)

public void setEncoding(Charset value)

如果文档中未指定编码,则设置将用于加载 HTML、TXT 或 CHM 文档的编码。可以为空。默认为空。

此属性仅在加载 HTML、TXT 或 CHM 文档时使用。

如果文档中未指定编码且此属性为 null ,则系统将尝试自动检测编码。

参数:

范围类型描述
valuejava.nio.charset.Charset如果未在文档中指定编码,则将用于加载 HTML、TXT 或 CHM 文档的编码。

setFontSettings(FontSettings value)

public void setFontSettings(FontSettings value)

允许指定文档字体设置。

加载某些格式时,Aspose.Words 可能需要解析字体。例如,在加载 HTML 文档时,Aspose.Words 可能会解析字体以执行字体回退。

如果设置为空,默认静态字体设置FontSettings.getDefaultInstance()将会被使用。

默认值为空。

参数:

范围类型描述
valueFontSettings相应的FontSettings价值。

setLoadFormat(int value)

public void setLoadFormat(int value)

指定要加载的文档的格式。默认为LoadFormat.AUTO.

建议您指定LoadFormat.AUTO值并让 Aspose.Words 自动检测文件格式。如果您知道要加载的文档的格式,则可以明确指定格式,这将通过与自动检测格式相关的开销稍微减少加载时间。如果您指定了一个显式的加载格式,但它会被证明是错误的,那么将调用自动检测并进行第二次加载文件的尝试。

参数:

范围类型描述
valueint对应的int值。该值必须是其中之一LoadFormat常数。

setMswVersion(int value)

public void setMswVersion(int value)

允许指定文档加载过程应匹配特定的 MS Word 版本。默认值为MsWordVersion.WORD_2019不同的 Word 版本在加载过程中处理文档内容和格式的某些方面可能略有不同,这可能导致文档对象模型中的细微差别。

参数:

范围类型描述
valueint对应的int值。该值必须是其中之一MsWordVersion常数。

setPassword(String value)

public void setPassword(String value)

设置打开加密文档的密码。可以为 null 或空字符串。默认为空。

您需要知道密码才能打开加密文档。如果文档未加密,请将其设置为 null 或空字符串。

参数:

范围类型描述
valuejava.lang.String打开加密文档的密码。

setPreserveIncludePictureField(boolean value)

public void setPreserveIncludePictureField(boolean value)

设置在阅读 Microsoft Word 格式时是否保留 INCLUDEPICTURE 字段。默认值为假。

默认情况下,INCLUDEPICTURE 字段会转换为形状对象。如果您需要保留该字段,例如,如果您希望以编程方式更新它,则可以覆盖它。但是请注意,这种方法在 Aspose.Words 中并不常见。自行承担使用风险。

一种可能的用例可能是使用 MERGEFIELD 作为子字段来动态更改图片的源路径。在这种情况下,您需要将 INCLUDEPICTURE 保留在模型中。

参数:

范围类型描述
valueboolean读取 Microsoft Word 格式时是否保留 INCLUDEPICTURE 字段。

setProgressCallback(IDocumentLoadingCallback value)

public void setProgressCallback(IDocumentLoadingCallback value)

在加载文档期间调用并接受有关加载进度的数据。

LoadFormat.DOCX, LoadFormat.FLAT_OPC, LoadFormat.DOCM, LoadFormat.DOTM, LoadFormat.DOTX, LoadFormat.MARKDOWN, LoadFormat.RTF, LoadFormat.WORD_ML, LoadFormat.DOC, LoadFormat.DOT, LoadFormat.ODT, LoadFormat.OTT支持的格式。

参数:

范围类型描述
valueIDocumentLoadingCallback相应的IDocumentLoadingCallback价值。

setResourceLoadingCallback(IResourceLoadingCallback value)

public void setResourceLoadingCallback(IResourceLoadingCallback value)

允许控制从 HTML、MHTML 导入文档时如何加载外部资源(图像、样式表)。

参数:

范围类型描述
valueIResourceLoadingCallback相应的IResourceLoadingCallback价值。

setTempFolder(String value)

public void setTempFolder(String value)

允许在阅读文档时使用临时文件。默认情况下,此属性为 null 且不使用临时文件。

该文件夹必须存在且可写,否则会抛出异常。

Aspose.Words 在读取完成后自动删除所有临时文件。

参数:

范围类型描述
valuejava.lang.String对应的java.lang.String值。

setUpdateDirtyFields(boolean value)

public void setUpdateDirtyFields(boolean value)

指定是否更新具有脏属性的字段。

参数:

范围类型描述
valueboolean对应的布尔值。

setWarningCallback(IWarningCallback value)

public void setWarningCallback(IWarningCallback value)

在加载操作期间调用,当检测到可能导致数据或格式保真度丢失的问题时调用。

参数:

范围类型描述
valueIWarningCallback相应的IWarningCallback价值。

toString()

public String toString()

退货: java.lang.字符串

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

参数:

范围类型描述
arg0long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

参数:

范围类型描述
arg0long
arg1int