com.aspose.cells
Class HTMLLoadOptions

java.lang.Object
  extended by LoadOptions
      extended by com.aspose.cells.HTMLLoadOptions

public class HTMLLoadOptions 
extends LoadOptions

Represents options when importing a html file.

Constructor Summary
HTMLLoadOptions()
           Creates an options of loading the file.
HTMLLoadOptions(int loadFormat)
           Creates an options of loading the file.
 
Property Getters/Setters Summary
java.lang.StringgetAttachedFilesDirectory()
voidsetAttachedFilesDirectory(java.lang.String value)
           The directory that the attached files will be saved to.
booleangetAutoFitColsAndRows()
voidsetAutoFitColsAndRows(boolean value)
           Indicates whether auto-fit columns and rows.The default value is false.
booleangetCheckExcelRestriction()→ inherited from LoadOptions
voidsetCheckExcelRestriction(boolean value)
           Whether check restriction of excel file when user modify cells related objects. For example, excel does not allow inputting string value longer than 32K. When you input a value longer than 32K such as by Cell.PutValue(string), if this property is true, you will get an Exception. If this property is false, we will accept your input string value as the cell's value so that later you can output the complete string value for other file formats such as CSV. However, if you have set such kind of value that is invalid for excel file format, you should not save the workbook as excel file format later. Otherwise there may be unexpected error for the generated excel file.
booleangetConvertDateTimeData()
voidsetConvertDateTimeData(boolean value)
           if set true, do format, default is true
booleangetConvertFormulasData()
voidsetConvertFormulasData(boolean value)
           if true, convert string to formula when string value starts with character '=',the default value is false.
booleangetConvertNumericData()
voidsetConvertNumericData(boolean value)
           Gets or sets a value that indicates whether the string in text file is converted to numeric data.
booleangetDeleteRedundantSpaces()
voidsetDeleteRedundantSpaces(boolean value)
           Indicates whether delete redundant spaces when the text wraps lines using <br>tag.The default value is false.
EncodinggetEncoding()
voidsetEncoding(Encoding value)
           If not set,use Encoding.Default as default enconding type.
booleangetIgnoreNotPrinted()→ inherited from LoadOptions
voidsetIgnoreNotPrinted(boolean value)
           Ignore the data which are not printed if directly printing the file
InterruptMonitorgetInterruptMonitor()→ inherited from LoadOptions
voidsetInterruptMonitor(InterruptMonitor value)
           Gets and sets the interrupt monitor.
booleangetKeepPrecision()
voidsetKeepPrecision(boolean value)
           Indicates whether not parsing a string value if the length is 15.
intgetLanguageCode()→ inherited from LoadOptions
voidsetLanguageCode(int value)
           Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file. The value of the property is CountryCode integer constant.
LightCellsDataHandlergetLightCellsDataHandler()→ inherited from LoadOptions
voidsetLightCellsDataHandler(LightCellsDataHandler value)
           The data handler for processing cells data when reading template file.
booleangetLoadDataAndFormatting()→ inherited from LoadOptions
voidsetLoadDataAndFormatting(boolean value)
           If true, only loads data , formulas and formatting from the file, other contents and settings are all discarded. For example : shapes ,validation,conditional formatting,pivotables are not loaded.
intgetLoadDataFilterOptions()→ inherited from LoadOptions
voidsetLoadDataFilterOptions(int value)
           The filter options to denote what data should be loaded. The value of the property is LoadDataFilterOptions integer constant.
booleangetLoadDataOnly()→ inherited from LoadOptions
voidsetLoadDataOnly(boolean value)
           If true, only loads data and formulas from the file, other contents and settings are all discarded.
LoadDataOptiongetLoadDataOptions()→ inherited from LoadOptions
voidsetLoadDataOptions(LoadDataOption value)
           Only effects when OnlyLoadData is true.
LoadFiltergetLoadFilter()→ inherited from LoadOptions
voidsetLoadFilter(LoadFilter value)
           The filter to denote how to load data.
intgetLoadFormat()→ inherited from LoadOptions
           Gets and set the load format. The value of the property is LoadFormat integer constant.
booleangetLoadFormulas()
voidsetLoadFormulas(boolean value)
           Indicates whether importing formulas if the orignal html file contains falmulas
java.util.LocalegetLocale()→ inherited from LoadOptions
voidsetLocale(java.util.Locale value)
           Gets and sets the Locale used for workbook at the time the file was loaded.
intgetMemorySetting()→ inherited from LoadOptions
voidsetMemorySetting(int value)
           Gets or sets the memory usage options. The value of the property is MemorySetting integer constant.
booleangetOnlyLoadDocumentProperties()→ inherited from LoadOptions
voidsetOnlyLoadDocumentProperties(boolean value)
           If true, only loads document properties
booleangetParsingFormulaOnOpen()→ inherited from LoadOptions
voidsetParsingFormulaOnOpen(boolean value)
           Indicates whether parsing the formula when reading the file.
java.lang.StringgetPassword()→ inherited from LoadOptions
voidsetPassword(java.lang.String value)
           Gets and set the password of the workbook.
intgetRegion()→ inherited from LoadOptions
voidsetRegion(int value)
           Gets or sets the system regional settings based on CountryCode at the time the file was loaded. The value of the property is CountryCode integer constant.
java.lang.StringgetStandardFont()→ inherited from LoadOptions
voidsetStandardFont(java.lang.String value)
           Sets the default standard font name
doublegetStandardFontSize()→ inherited from LoadOptions
voidsetStandardFontSize(double value)
           Sets the default standard font size.
IStreamProvidergetStreamProvider()
voidsetStreamProvider(IStreamProvider value)
           Gets or sets the StreamProviderImportHtmlFile for importing objects.
booleangetSupportDivTag()
voidsetSupportDivTag(boolean value)
           Indicates whether support the layout of <div> tag when the html file contains <div> tags.The default value is false.
IWarningCallbackgetWarningCallback()→ inherited from LoadOptions
voidsetWarningCallback(IWarningCallback value)
           Gets or sets warning callback.
 
Method Summary
voidsetPaperSize(int type)→ inherited from LoadOptions
           Sets the default print paper size from default printer's setting.
 

Constructor Detail

HTMLLoadOptions

public HTMLLoadOptions()
Creates an options of loading the file.

HTMLLoadOptions

public HTMLLoadOptions(int loadFormat)
Creates an options of loading the file.
Parameters:
loadFormat - A LoadFormat value. The loading format.

Property Getters/Setters Detail

getAttachedFilesDirectory/setAttachedFilesDirectory

public java.lang.String getAttachedFilesDirectory() / public void setAttachedFilesDirectory(java.lang.String value)
The directory that the attached files will be saved to. NOTE: This member is now obsolete. Instead, please use HTMLLoadOptions.StreamProvider property. This property will be removed 12 months later since December 2014. Aspose apologizes for any inconvenience you may have experienced.

getLoadFormulas/setLoadFormulas

public boolean getLoadFormulas() / public void setLoadFormulas(boolean value)
Indicates whether importing formulas if the orignal html file contains falmulas

getSupportDivTag/setSupportDivTag

public boolean getSupportDivTag() / public void setSupportDivTag(boolean value)
Indicates whether support the layout of <div> tag when the html file contains <div> tags.The default value is false.

getDeleteRedundantSpaces/setDeleteRedundantSpaces

public boolean getDeleteRedundantSpaces() / public void setDeleteRedundantSpaces(boolean value)
Indicates whether delete redundant spaces when the text wraps lines using <br>tag.The default value is false.

getAutoFitColsAndRows/setAutoFitColsAndRows

public boolean getAutoFitColsAndRows() / public void setAutoFitColsAndRows(boolean value)
Indicates whether auto-fit columns and rows.The default value is false.

getEncoding/setEncoding

public Encoding getEncoding() / public void setEncoding(Encoding value)
If not set,use Encoding.Default as default enconding type.

getConvertNumericData/setConvertNumericData

public boolean getConvertNumericData() / public void setConvertNumericData(boolean value)
Gets or sets a value that indicates whether the string in text file is converted to numeric data.

getKeepPrecision/setKeepPrecision

public boolean getKeepPrecision() / public void setKeepPrecision(boolean value)
Indicates whether not parsing a string value if the length is 15.

getConvertFormulasData/setConvertFormulasData

public boolean getConvertFormulasData() / public void setConvertFormulasData(boolean value)
if true, convert string to formula when string value starts with character '=',the default value is false.

getStreamProvider/setStreamProvider

public IStreamProvider getStreamProvider() / public void setStreamProvider(IStreamProvider value)
Gets or sets the StreamProviderImportHtmlFile for importing objects.

getConvertDateTimeData/setConvertDateTimeData

public boolean getConvertDateTimeData() / public void setConvertDateTimeData(boolean value)
if set true, do format, default is true

getLoadFormat

→ inherited from LoadOptions
public int getLoadFormat()
Gets and set the load format. The value of the property is LoadFormat integer constant.

getPassword/setPassword

→ inherited from LoadOptions
public java.lang.String getPassword() / public void setPassword(java.lang.String value)
Gets and set the password of the workbook.

getParsingFormulaOnOpen/setParsingFormulaOnOpen

→ inherited from LoadOptions
public boolean getParsingFormulaOnOpen() / public void setParsingFormulaOnOpen(boolean value)
Indicates whether parsing the formula when reading the file. Only applies for Excel Xlsx, Xltx, Xltm and Xlsm file because the formulas in the files are stored with a string formula.

getLoadDataAndFormatting/setLoadDataAndFormatting

→ inherited from LoadOptions
public boolean getLoadDataAndFormatting() / public void setLoadDataAndFormatting(boolean value)
If true, only loads data , formulas and formatting from the file, other contents and settings are all discarded. For example : shapes ,validation,conditional formatting,pivotables are not loaded. NOTE: This member is now obsolete. Instead, please use LoadFilter property(LoadFilter = new LoadFilter(LoadDataFilterOptions.CellData). This property will be removed 12 months later since November 2016. Aspose apologizes for any inconvenience you may have experienced.

getLoadDataOnly/setLoadDataOnly

→ inherited from LoadOptions
public boolean getLoadDataOnly() / public void setLoadDataOnly(boolean value)
If true, only loads data and formulas from the file, other contents and settings are all discarded. NOTE: This member is now obsolete. Instead, please use LoadFilter property(LoadFilter = new LoadFilter(LoadDataFilterOptions.CellData). This property will be removed 12 months later since June 2016. Aspose apologizes for any inconvenience you may have experienced.

getOnlyLoadDocumentProperties/setOnlyLoadDocumentProperties

→ inherited from LoadOptions
public boolean getOnlyLoadDocumentProperties() / public void setOnlyLoadDocumentProperties(boolean value)
If true, only loads document properties Only for excel 97- 2003 xls file. If the file is encrypted, we still can get the document properties without password NOTE: This member is now obsolete. Instead, please use LoadFilter property(LoadFilter = new LoadFilter(LoadDataFilterOptions.DocumentProperties). This property will be removed 12 months later since November 2016. Aspose apologizes for any inconvenience you may have experienced.

getLoadDataOptions/setLoadDataOptions

→ inherited from LoadOptions
public LoadDataOption getLoadDataOptions() / public void setLoadDataOptions(LoadDataOption value)
Only effects when OnlyLoadData is true. NOTE: This member is now obsolete. Instead, please use LoadFilter property(User may extend LoadFilter to filter the worksheet and data). This property will be removed 12 months later since November 2016. Aspose apologizes for any inconvenience you may have experienced.

getLanguageCode/setLanguageCode

→ inherited from LoadOptions
public int getLanguageCode() / public void setLanguageCode(int value)
Gets or sets the user interface language of the Workbook version based on CountryCode that has saved the file. The value of the property is CountryCode integer constant.

getRegion/setRegion

→ inherited from LoadOptions
public int getRegion() / public void setRegion(int value)
Gets or sets the system regional settings based on CountryCode at the time the file was loaded. The value of the property is CountryCode integer constant.If you do not want to use the region saved in the file, please reset it after reading the file.

getLocale/setLocale

→ inherited from LoadOptions
public java.util.Locale getLocale() / public void setLocale(java.util.Locale value)
Gets and sets the Locale used for workbook at the time the file was loaded.

getStandardFont/setStandardFont

→ inherited from LoadOptions
public java.lang.String getStandardFont() / public void setStandardFont(java.lang.String value)
Sets the default standard font name

getStandardFontSize/setStandardFontSize

→ inherited from LoadOptions
public double getStandardFontSize() / public void setStandardFontSize(double value)
Sets the default standard font size.

getInterruptMonitor/setInterruptMonitor

→ inherited from LoadOptions
public InterruptMonitor getInterruptMonitor() / public void setInterruptMonitor(InterruptMonitor value)
Gets and sets the interrupt monitor.

getIgnoreNotPrinted/setIgnoreNotPrinted

→ inherited from LoadOptions
public boolean getIgnoreNotPrinted() / public void setIgnoreNotPrinted(boolean value)
Ignore the data which are not printed if directly printing the file Only for xlsx file.

getCheckExcelRestriction/setCheckExcelRestriction

→ inherited from LoadOptions
public boolean getCheckExcelRestriction() / public void setCheckExcelRestriction(boolean value)
Whether check restriction of excel file when user modify cells related objects. For example, excel does not allow inputting string value longer than 32K. When you input a value longer than 32K such as by Cell.PutValue(string), if this property is true, you will get an Exception. If this property is false, we will accept your input string value as the cell's value so that later you can output the complete string value for other file formats such as CSV. However, if you have set such kind of value that is invalid for excel file format, you should not save the workbook as excel file format later. Otherwise there may be unexpected error for the generated excel file.

getLoadFilter/setLoadFilter

→ inherited from LoadOptions
public LoadFilter getLoadFilter() / public void setLoadFilter(LoadFilter value)
The filter to denote how to load data.

getLoadDataFilterOptions/setLoadDataFilterOptions

→ inherited from LoadOptions
public int getLoadDataFilterOptions() / public void setLoadDataFilterOptions(int value)
The filter options to denote what data should be loaded. The value of the property is LoadDataFilterOptions integer constant. NOTE: This member is now obsolete. Instead, please use LoadFilter property(LoadFilter = new LoadFilter(LoadDataFilterOptions). This property will be removed 12 months later since November 2016. Aspose apologizes for any inconvenience you may have experienced.

getLightCellsDataHandler/setLightCellsDataHandler

→ inherited from LoadOptions
public LightCellsDataHandler getLightCellsDataHandler() / public void setLightCellsDataHandler(LightCellsDataHandler value)
The data handler for processing cells data when reading template file.

getMemorySetting/setMemorySetting

→ inherited from LoadOptions
public int getMemorySetting() / public void setMemorySetting(int value)
Gets or sets the memory usage options. The value of the property is MemorySetting integer constant.

getWarningCallback/setWarningCallback

→ inherited from LoadOptions
public IWarningCallback getWarningCallback() / public void setWarningCallback(IWarningCallback value)
Gets or sets warning callback.

Method Detail

setPaperSize

→ inherited from LoadOptions
public void setPaperSize(int type)
Sets the default print paper size from default printer's setting. If there is no setting about paper size,MS Excel will use default printer's setting.
Parameters:
type - A PaperSizeType value. The default paper size.

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cellss Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.