com.groupdocs.conversion.options.load

Class WebLoadOptions

java.lang.Object

com.groupdocs.conversion.contracts.ValueObject

com.groupdocs.conversion.options.load.LoadOptions

com.groupdocs.conversion.options.load.WebLoadOptions

All Implemented Interfaces:

com.aspose.ms.System.IEquatable<ValueObject>, com.groupdocs.conversion.options.load.IPageNumberingLoadOptions, com.groupdocs.conversion.options.load.IResourceLoadingOptions, Serializable

Direct Known Subclasses:

XmlLoadOptions

public class WebLoadOptions
extends LoadOptions
implements Serializable, com.groupdocs.conversion.options.load.IResourceLoadingOptions, com.groupdocs.conversion.options.load.IPageNumberingLoadOptions

Options for loading web documents.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
WebLoadOptions() Initializes new instance of class.

Method Summary

Modifier and Type	Method and Description
String	getBasePath()
String	getEncoding()
protected List<Object>	getEqualityComponents() Gets equality components.
WebFileType	getFormat() Gets Input document file type.
long	getResourceLoadingTimeout() Gets timeout for loading external resources in milliseconds
boolean	getSkipExternalResources() If true all external resource will not be loading with exception of the resources in the
List<String>	getWhitelistedResources() External resources that will be always loaded
boolean	isPageNumbering() Enable or disable generation of page numbering in converted document.
boolean	isUsePdf() Use pdf for the conversion.
void	setBasePath(String basePath)
void	setEncoding(String encoding)
void	setFormat(WebFileType format) Sets Input document file type.
void	setPageNumbering(boolean pageNumbering)
void	setResourceLoadingTimeout(long resourceLoadingTimeout) Sets timeout for loading external resources in milliseconds
void	setSkipExternalResources(boolean skip)
void	setUsePdf(boolean usePdf)
void	setWhitelistedResources(List<String> whiteList)

Methods inherited from class com.groupdocs.conversion.options.load.LoadOptions

setFormat

Methods inherited from class com.groupdocs.conversion.contracts.ValueObject

equals, equals, hashCode, op_Equality, op_Inequality

Methods inherited from class java.lang.Object

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

Constructor Detail

WebLoadOptions

public WebLoadOptions()

Initializes new instance of class.

Method Detail

getBasePath

public String getBasePath()

getEncoding

public String getEncoding()

getEqualityComponents

protected List<Object> getEqualityComponents()

Gets equality components.

Specified by:

getEqualityComponents in class ValueObject

Returns:

Collection of objects.

getFormat

public WebFileType getFormat()

Gets Input document file type.

Overrides:

getFormat in class LoadOptions

getResourceLoadingTimeout

public long getResourceLoadingTimeout()

Gets timeout for loading external resources in milliseconds

getSkipExternalResources

public boolean getSkipExternalResources()

If true all external resource will not be loading with exception of the resources in the

Specified by:

getSkipExternalResources in interface com.groupdocs.conversion.options.load.IResourceLoadingOptions

getWhitelistedResources

public List<String> getWhitelistedResources()

External resources that will be always loaded

Specified by:

getWhitelistedResources in interface com.groupdocs.conversion.options.load.IResourceLoadingOptions

isPageNumbering

public boolean isPageNumbering()

Description copied from interface: com.groupdocs.conversion.options.load.IPageNumberingLoadOptions

Enable or disable generation of page numbering in converted document. Default: false

Specified by:

isPageNumbering in interface com.groupdocs.conversion.options.load.IPageNumberingLoadOptions

isUsePdf

public boolean isUsePdf()

Use pdf for the conversion. Default: false

setBasePath

public void setBasePath(String basePath)

setEncoding

public void setEncoding(String encoding)

setFormat

public void setFormat(WebFileType format)

Sets Input document file type.

setPageNumbering

public void setPageNumbering(boolean pageNumbering)

Specified by:

setPageNumbering in interface com.groupdocs.conversion.options.load.IPageNumberingLoadOptions

setResourceLoadingTimeout

public void setResourceLoadingTimeout(long resourceLoadingTimeout)

Sets timeout for loading external resources in milliseconds

setSkipExternalResources

public void setSkipExternalResources(boolean skip)

Specified by:

setSkipExternalResources in interface com.groupdocs.conversion.options.load.IResourceLoadingOptions

setUsePdf

public void setUsePdf(boolean usePdf)

setWhitelistedResources

public void setWhitelistedResources(List<String> whiteList)

Specified by:

setWhitelistedResources in interface com.groupdocs.conversion.options.load.IResourceLoadingOptions