All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.aspose.cells.HtmlLoadOptions.html Maven / Gradle / Ivy

There is a newer version: 23.1
Show newest version





HtmlLoadOptions




com.aspose.cells
Class HtmlLoadOptions

java.lang.Object
  extended by LoadOptions
      extended by AbstractTextLoadOptions
          extended by com.aspose.cells.HtmlLoadOptions

public class HtmlLoadOptions 
extends AbstractTextLoadOptions

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)
           The directory that the attached files will be saved to.
booleangetAutoFilter()→ inherited from LoadOptions
voidsetAutoFilter(boolean)
           Indicates whether auto filtering the data when loading the files.
booleangetAutoFitColsAndRows()
voidsetAutoFitColsAndRows(boolean)
           Indicates whether auto-fit columns and rows. The default value is false.
AutoFitterOptionsgetAutoFitterOptions()→ inherited from LoadOptions
voidsetAutoFitterOptions(AutoFitterOptions)
           Gets and sets the auto fitter options
booleangetCheckDataValid()→ inherited from LoadOptions
voidsetCheckDataValid(boolean)
           Check whether data is valid in the template file.
booleangetCheckExcelRestriction()→ inherited from LoadOptions
voidsetCheckExcelRestriction(boolean)
           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()→ inherited from AbstractTextLoadOptions
voidsetConvertDateTimeData(boolean)
           Gets or sets a value that indicates whether the string in text file is converted to date data.
booleangetConvertFormulasData()
voidsetConvertFormulasData(boolean)
           if true, convert string to formula when string value starts with character '=',the default value is false.
booleangetConvertNumericData()→ inherited from AbstractTextLoadOptions
voidsetConvertNumericData(boolean)
           Gets or sets a value that indicates whether the string in text file is converted to numeric data.
DefaultStyleSettingsgetDefaultStyleSettings()→ inherited from LoadOptions
           Gets the default style settings for initializing styles of the workbook
booleangetDeleteRedundantSpaces()
voidsetDeleteRedundantSpaces(boolean)
           Indicates whether delete redundant spaces when the text wraps lines using <br>tag.The default value is false.
com.aspose.cells.EncodinggetEncoding()→ inherited from AbstractTextLoadOptions
voidsetEncoding(com.aspose.cells.Encoding)
           Gets and sets the default encoding. Only applies for csv file.
IndividualFontConfigsgetFontConfigs()→ inherited from LoadOptions
voidsetFontConfigs(IndividualFontConfigs)
           Gets and sets individual font configs. Only works for the Workbook which uses this LoadOptions to load.>
booleangetIgnoreNotPrinted()→ inherited from LoadOptions
voidsetIgnoreNotPrinted(boolean)
           Ignore the data which are not printed if directly printing the file
AbstractInterruptMonitorgetInterruptMonitor()→ inherited from LoadOptions
voidsetInterruptMonitor(AbstractInterruptMonitor)
           Gets and sets the interrupt monitor.
booleangetKeepPrecision()→ inherited from AbstractTextLoadOptions
voidsetKeepPrecision(boolean)
           Indicates whether not parsing a string value if the length is 15.
booleangetKeepUnparsedData()→ inherited from LoadOptions
voidsetKeepUnparsedData(boolean)
           Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true.
intgetLanguageCode()→ inherited from LoadOptions
voidsetLanguageCode(int)
           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)
           The data handler for processing cells data when reading template file.
LoadFiltergetLoadFilter()→ inherited from LoadOptions
voidsetLoadFilter(LoadFilter)
           The filter to denote how to load data.
intgetLoadFormat()→ inherited from LoadOptions
           Gets the load format. The value of the property is LoadFormat integer constant.
booleangetLoadFormulas()
voidsetLoadFormulas(boolean)
           Indicates whether importing formulas if the original html file contains formulas
intgetLoadStyleStrategy()→ inherited from AbstractTextLoadOptions
voidsetLoadStyleStrategy(int)
           Indicates the strategy to apply style for parsed values when converting string value to number or datetime. The value of the property is TxtLoadStyleStrategy integer constant.
java.util.LocalegetLocale()→ inherited from LoadOptions
voidsetLocale(java.util.Locale)
           Gets and sets the Locale used for workbook at the time the file was loaded.
intgetMemorySetting()→ inherited from LoadOptions
voidsetMemorySetting(int)
           Gets or sets the memory usage options. The value of the property is MemorySetting integer constant.
booleangetParsingFormulaOnOpen()→ inherited from LoadOptions
voidsetParsingFormulaOnOpen(boolean)
           Indicates whether parsing the formula when reading the file.
booleangetParsingPivotCachedRecords()→ inherited from LoadOptions
voidsetParsingPivotCachedRecords(boolean)
           Indicates whether parsing pivot cached records when loading the file. The default value is false.
java.lang.StringgetPassword()→ inherited from LoadOptions
voidsetPassword(java.lang.String)
           Gets and set the password of the workbook.
java.lang.StringgetProgId()
           Gets the program id of creating the file. Only for MHT files.
intgetRegion()→ inherited from LoadOptions
voidsetRegion(int)
           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)
           Sets the default standard font name
doublegetStandardFontSize()→ inherited from LoadOptions
voidsetStandardFontSize(double)
           Sets the default standard font size.
IStreamProvidergetStreamProvider()
voidsetStreamProvider(IStreamProvider)
           Gets or sets the StreamProviderImportHtmlFile for importing objects.
booleangetSupportDivTag()
voidsetSupportDivTag(boolean)
           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)
           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.

setAttachedFilesDirectory

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 original html file contains formulas

setLoadFormulas

public void setLoadFormulas(boolean value)
Indicates whether importing formulas if the original html file contains formulas

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.

setSupportDivTag

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.

setDeleteRedundantSpaces

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.

setAutoFitColsAndRows

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

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.

setConvertFormulasData

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.

setStreamProvider

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

getProgId

public java.lang.String getProgId()
Gets the program id of creating the file. Only for MHT files.

getEncoding/setEncoding

→ inherited from AbstractTextLoadOptions
public com.aspose.cells.Encoding getEncoding() / public void setEncoding(com.aspose.cells.Encoding value)
Gets and sets the default encoding. Only applies for csv file.

setEncoding

→ inherited from AbstractTextLoadOptions
public void setEncoding(com.aspose.cells.Encoding value)
Gets and sets the default encoding. Only applies for csv file.

getLoadStyleStrategy/setLoadStyleStrategy

→ inherited from AbstractTextLoadOptions
public int getLoadStyleStrategy() / public void setLoadStyleStrategy(int value)
Indicates the strategy to apply style for parsed values when converting string value to number or datetime. The value of the property is TxtLoadStyleStrategy integer constant.

setLoadStyleStrategy

→ inherited from AbstractTextLoadOptions
public void setLoadStyleStrategy(int value)
Indicates the strategy to apply style for parsed values when converting string value to number or datetime. The value of the property is TxtLoadStyleStrategy integer constant.

getConvertNumericData/setConvertNumericData

→ inherited from AbstractTextLoadOptions
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.

setConvertNumericData

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

getConvertDateTimeData/setConvertDateTimeData

→ inherited from AbstractTextLoadOptions
public boolean getConvertDateTimeData() / public void setConvertDateTimeData(boolean value)
Gets or sets a value that indicates whether the string in text file is converted to date data.

setConvertDateTimeData

→ inherited from AbstractTextLoadOptions
public void setConvertDateTimeData(boolean value)
Gets or sets a value that indicates whether the string in text file is converted to date data.

getKeepPrecision/setKeepPrecision

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

setKeepPrecision

→ inherited from AbstractTextLoadOptions
public void setKeepPrecision(boolean value)
Indicates whether not parsing a string value if the length is 15.

getLoadFormat

→ inherited from LoadOptions
public int getLoadFormat()
Gets 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.

setPassword

→ inherited from LoadOptions
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.

setParsingFormulaOnOpen

→ inherited from LoadOptions
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.

getParsingPivotCachedRecords/setParsingPivotCachedRecords

→ inherited from LoadOptions
public boolean getParsingPivotCachedRecords() / public void setParsingPivotCachedRecords(boolean value)
Indicates whether parsing pivot cached records when loading the file. The default value is false. Only applies for Excel Xlsx, Xltx, Xltm , Xlsm and xlsb file

setParsingPivotCachedRecords

→ inherited from LoadOptions
public void setParsingPivotCachedRecords(boolean value)
Indicates whether parsing pivot cached records when loading the file. The default value is false. Only applies for Excel Xlsx, Xltx, Xltm , Xlsm and xlsb file

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.

setLanguageCode

→ inherited from LoadOptions
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.

setRegion

→ inherited from LoadOptions
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.

setLocale

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

getDefaultStyleSettings

→ inherited from LoadOptions
public DefaultStyleSettings getDefaultStyleSettings()
Gets the default style settings for initializing styles of the workbook

getStandardFont/setStandardFont

→ inherited from LoadOptions
public java.lang.String getStandardFont() / public void setStandardFont(java.lang.String value)
Sets the default standard font name NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings. This property will be removed 12 months later since March 2022. Aspose apologizes for any inconvenience you may have experienced.

setStandardFont

→ inherited from LoadOptions
public void setStandardFont(java.lang.String value)
Sets the default standard font name NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings. This property will be removed 12 months later since March 2022. Aspose apologizes for any inconvenience you may have experienced.

getStandardFontSize/setStandardFontSize

→ inherited from LoadOptions
public double getStandardFontSize() / public void setStandardFontSize(double value)
Sets the default standard font size. NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings. This property will be removed 12 months later since March 2022. Aspose apologizes for any inconvenience you may have experienced.

setStandardFontSize

→ inherited from LoadOptions
public void setStandardFontSize(double value)
Sets the default standard font size. NOTE: This member is now obsolete. Instead, please use DefaultStyleSettings. This property will be removed 12 months later since March 2022. Aspose apologizes for any inconvenience you may have experienced.

getInterruptMonitor/setInterruptMonitor

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

setInterruptMonitor

→ inherited from LoadOptions
public void setInterruptMonitor(AbstractInterruptMonitor 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.

setIgnoreNotPrinted

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

getCheckDataValid/setCheckDataValid

→ inherited from LoadOptions
public boolean getCheckDataValid() / public void setCheckDataValid(boolean value)
Check whether data is valid in the template file.

setCheckDataValid

→ inherited from LoadOptions
public void setCheckDataValid(boolean value)
Check whether data is valid in the template 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.

setCheckExcelRestriction

→ inherited from LoadOptions
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.

getKeepUnparsedData/setKeepUnparsedData

→ inherited from LoadOptions
public boolean getKeepUnparsedData() / public void setKeepUnparsedData(boolean value)
Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true. For scenarios that user only needs to read some contents from template file and does not need to save the workbook back, set this property as false may improve performance, especially when using it together with some kind of LoadFilter,

setKeepUnparsedData

→ inherited from LoadOptions
public void setKeepUnparsedData(boolean value)
Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true. For scenarios that user only needs to read some contents from template file and does not need to save the workbook back, set this property as false may improve performance, especially when using it together with some kind of LoadFilter,

getLoadFilter/setLoadFilter

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

setLoadFilter

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

getLightCellsDataHandler/setLightCellsDataHandler

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

setLightCellsDataHandler

→ inherited from LoadOptions
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.

setMemorySetting

→ inherited from LoadOptions
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.

setWarningCallback

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

getAutoFitterOptions/setAutoFitterOptions

→ inherited from LoadOptions
public AutoFitterOptions getAutoFitterOptions() / public void setAutoFitterOptions(AutoFitterOptions value)
Gets and sets the auto fitter options Only for xlsx ,spreadsheetML file now.

setAutoFitterOptions

→ inherited from LoadOptions
public void setAutoFitterOptions(AutoFitterOptions value)
Gets and sets the auto fitter options Only for xlsx ,spreadsheetML file now.

getAutoFilter/setAutoFilter

→ inherited from LoadOptions
public boolean getAutoFilter() / public void setAutoFilter(boolean value)
Indicates whether auto filtering the data when loading the files. Sometimes although autofilter is set, the corresponding rows is not hidden in the file. Now only works for SpreadSheetML file.

setAutoFilter

→ inherited from LoadOptions
public void setAutoFilter(boolean value)
Indicates whether auto filtering the data when loading the files. Sometimes although autofilter is set, the corresponding rows is not hidden in the file. Now only works for SpreadSheetML file.

getFontConfigs/setFontConfigs

→ inherited from LoadOptions
public IndividualFontConfigs getFontConfigs() / public void setFontConfigs(IndividualFontConfigs value)
Gets and sets individual font configs. Only works for the Workbook which uses this LoadOptions to load.>

setFontConfigs

→ inherited from LoadOptions
public void setFontConfigs(IndividualFontConfigs value)
Gets and sets individual font configs. Only works for the Workbook which uses this LoadOptions to load.>

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.Cells Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.





© 2015 - 2024 Weber Informatics LLC | Privacy Policy