com.aspose.words

Class HtmlLoadOptions

java.lang.Object

com.aspose.words.LoadOptions

com.aspose.words.HtmlLoadOptions

public class HtmlLoadOptions
extends LoadOptions

Allows to specify additional options when loading HTML document into a Document object.

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

Constructor Summary

Constructors

Constructor and Description
HtmlLoadOptions() Initializes a new instance of this class with default values.
HtmlLoadOptions(int loadFormat, java.lang.String password, java.lang.String baseUri) Initializes a new instance of this class.
HtmlLoadOptions(java.lang.String password) A shortcut to initialize a new instance of this class with the specified password to load an encrypted document.

Method Summary

Modifier and Type	Method and Description
int	getBlockImportMode() Gets a value that specifies how properties of block-level elements are imported.
boolean	getConvertSvgToEmf() Gets a value indicating whether to convert loaded SVG images to the EMF format.
boolean	getIgnoreNoscriptElements() Gets a value indicating whether to ignore
int	getPreferredControlType() Gets preferred type of document nodes that will represent imported and elements.
boolean	getSupportVml() Gets a value indicating whether to support VML images.
int	getWebRequestTimeout() The number of milliseconds to wait before the web request times out.
void	setBlockImportMode(int value) Sets a value that specifies how properties of block-level elements are imported.
void	setConvertSvgToEmf(boolean value) Sets a value indicating whether to convert loaded SVG images to the EMF format.
void	setIgnoreNoscriptElements(boolean value) Sets a value indicating whether to ignore
void	setPreferredControlType(int value) Sets preferred type of document nodes that will represent imported and elements.
void	setSupportVml(boolean value) Sets a value indicating whether to support VML images.
void	setWebRequestTimeout(int value) The number of milliseconds to wait before the web request times out.

Methods inherited from class com.aspose.words.LoadOptions

getBaseUri, getConvertMetafilesToPng, getConvertShapeToOfficeMath, getEncoding, getFontSettings, getLanguagePreferences, getLoadFormat, getMswVersion, getPassword, getPreserveIncludePictureField, getProgressCallback, getResourceLoadingCallback, getTempFolder, getUpdateDirtyFields, getWarningCallback, setBaseUri, setConvertMetafilesToPng, setConvertShapeToOfficeMath, setEncoding, setFontSettings, setLoadFormat, setMswVersion, setPassword, setPreserveIncludePictureField, setProgressCallback, setResourceLoadingCallback, setTempFolder, setUpdateDirtyFields, setWarningCallback

Methods inherited from class java.lang.Object

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

Constructor Detail

HtmlLoadOptions

public HtmlLoadOptions()

Initializes a new instance of this class with default values.

HtmlLoadOptions

public HtmlLoadOptions(java.lang.String password)

A shortcut to initialize a new instance of this class with the specified password to load an encrypted document.

Parameters:

password - The password to open an encrypted document. Can be null or empty string.

HtmlLoadOptions

public HtmlLoadOptions(int loadFormat,
                       java.lang.String password,
                       java.lang.String baseUri)

Initializes a new instance of this class.

Method Detail

getSupportVml

public boolean getSupportVml()

Gets a value indicating whether to support VML images.

Returns:

A value indicating whether to support VML images.

setSupportVml

public void setSupportVml(boolean value)

Sets a value indicating whether to support VML images.

Parameters:

value - A value indicating whether to support VML images.

getWebRequestTimeout

public int getWebRequestTimeout()

The number of milliseconds to wait before the web request times out. The default value is 100000 milliseconds (100 seconds). The number of milliseconds that Aspose.Words waits for a response, when loading external resources (images, style sheets) linked in HTML and MHTML documents.

Returns:

The corresponding int value.

setWebRequestTimeout

public void setWebRequestTimeout(int value)

The number of milliseconds to wait before the web request times out. The default value is 100000 milliseconds (100 seconds). The number of milliseconds that Aspose.Words waits for a response, when loading external resources (images, style sheets) linked in HTML and MHTML documents.

Parameters:

value - The corresponding int value.

getPreferredControlType

public int getPreferredControlType()

Gets preferred type of document nodes that will represent imported and elements. Default value is HtmlControlType.FORM_FIELD. Please note that setting this property does not guarantee that all imported controls will be of the specified type. If an HTML control is not representable with document nodes of the preferred type, Aspose.Words will use a compatible HtmlControlType for that control.

Returns:

Preferred type of document nodes that will represent imported

and elements. The returned value is one of HtmlControlType constants.

setPreferredControlType

public void setPreferredControlType(int value)

Sets preferred type of document nodes that will represent imported

and elements. Default value is HtmlControlType.FORM_FIELD. Please note that setting this property does not guarantee that all imported controls will be of the specified type. If an HTML control is not representable with document nodes of the preferred type, Aspose.Words will use a compatible HtmlControlType for that control.

Parameters:

value - Preferred type of document nodes that will represent imported

and elements. The value must be one of HtmlControlType constants.

getIgnoreNoscriptElements

public boolean getIgnoreNoscriptElements()

Gets a value indicating whether to ignore

Returns:

A value indicating whether to ignore

setIgnoreNoscriptElements

public void setIgnoreNoscriptElements(boolean value)

Sets a value indicating whether to ignore

Parameters:

value - A value indicating whether to ignore

getConvertSvgToEmf

public boolean getConvertSvgToEmf()

Gets a value indicating whether to convert loaded SVG images to the EMF format. Default value is false and, if possible, loaded SVG images are stored as is without conversion.

Newer versions of MS Word support SVG images natively. If the MS Word version specified in load options supports SVG, Aspose.Words will store SVG images as is without conversion. If SVG is not supported, loaded SVG images will be converted to the EMF format.

If, however, this option is set to true, Aspose.Words will convert loaded SVG images to EMF even if SVG images are supported by the specified version of MS Word.

Returns:

A value indicating whether to convert loaded SVG images to the EMF format.

setConvertSvgToEmf

public void setConvertSvgToEmf(boolean value)

Sets a value indicating whether to convert loaded SVG images to the EMF format. Default value is false and, if possible, loaded SVG images are stored as is without conversion.

Newer versions of MS Word support SVG images natively. If the MS Word version specified in load options supports SVG, Aspose.Words will store SVG images as is without conversion. If SVG is not supported, loaded SVG images will be converted to the EMF format.

If, however, this option is set to true, Aspose.Words will convert loaded SVG images to EMF even if SVG images are supported by the specified version of MS Word.

Parameters:

value - A value indicating whether to convert loaded SVG images to the EMF format.

getBlockImportMode

public int getBlockImportMode()

Gets a value that specifies how properties of block-level elements are imported. Default value is BlockImportMode.MERGE.

Returns:

A value that specifies how properties of block-level elements are imported. The returned value is one of BlockImportMode constants.

setBlockImportMode

public void setBlockImportMode(int value)

Sets a value that specifies how properties of block-level elements are imported. Default value is BlockImportMode.MERGE.

Parameters:

value - A value that specifies how properties of block-level elements are imported. The value must be one of BlockImportMode constants.

Skip navigation links

• Overview
• Package
• Class
• Tree
• Deprecated
• Index
• Help

• Prev Class
• Next Class

• Frames
• No Frames

• All Classes

• Summary:
• Nested |
• Field |
• Constr |
• Method

• Detail:
• Field |
• Constr |
• Method