WebLoadOptions Leave feedback
On this page
Inheritance: java.lang.Object, com.groupdocs.conversion.contracts.ValueObject, com.groupdocs.conversion.options.load.LoadOptions
All Implemented Interfaces: java.io.Serializable, com.groupdocs.conversion.options.load.IResourceLoadingOptions, com.groupdocs.conversion.options.load.IPageNumberingLoadOptions
public class WebLoadOptions extends LoadOptions implements Serializable, IResourceLoadingOptions, IPageNumberingLoadOptions
Options for loading web documents.
| Constructor | Description |
|---|---|
| WebLoadOptions() | Initializes new instance of class. |
| Method | Description |
|---|---|
| getFormat() | Gets Input document file type. |
| setFormat(WebFileType format) | Sets Input document file type. |
| isPageNumbering() | |
| setPageNumbering(boolean pageNumbering) | |
| getBasePath() | |
| setBasePath(String basePath) | |
| getEncoding() | |
| setEncoding(String encoding) | |
| getResourceLoadingTimeout() | Gets timeout for loading external resources in milliseconds |
| setResourceLoadingTimeout(long resourceLoadingTimeout) | Sets timeout for loading external resources in milliseconds |
| getSkipExternalResources() | {@inheritDoc} |
| setSkipExternalResources(boolean skip) | {@inheritDoc} |
| getWhitelistedResources() | {@inheritDoc} |
| setWhitelistedResources(List |
{@inheritDoc} |
| isUsePdf() | Use pdf for the conversion. |
| setUsePdf(boolean usePdf) |
public WebLoadOptions()
Initializes new instance of class.
public WebFileType getFormat()
Gets Input document file type.
Returns: WebFileType
public void setFormat(WebFileType format)
Sets Input document file type.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| format | WebFileType |
public boolean isPageNumbering()
Enable or disable generation of page numbering in converted document. Default: false
Returns: boolean
public void setPageNumbering(boolean pageNumbering)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| pageNumbering | boolean |
public String getBasePath()
Returns: java.lang.String
public void setBasePath(String basePath)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| basePath | java.lang.String |
public String getEncoding()
Returns: java.lang.String
public void setEncoding(String encoding)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| encoding | java.lang.String |
public long getResourceLoadingTimeout()
Gets timeout for loading external resources in milliseconds
Returns: long
public void setResourceLoadingTimeout(long resourceLoadingTimeout)
Sets timeout for loading external resources in milliseconds
Parameters:
| Parameter | Type | Description |
|---|---|---|
| resourceLoadingTimeout | long |
public boolean getSkipExternalResources()
If true all external resource will not be loading with exception of the resources in the
Returns: boolean
public void setSkipExternalResources(boolean skip)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| skip | boolean |
public List<String> getWhitelistedResources()
External resources that will be always loaded
Returns: java.util.List<java.lang.String>
public void setWhitelistedResources(List<String> whiteList)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| whiteList | java.util.List<java.lang.String> |
public boolean isUsePdf()
Use pdf for the conversion. Default: false
Returns: boolean
public void setUsePdf(boolean usePdf)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| usePdf | boolean |
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.
