com.aspose.cells
Class AbstractTextLoadOptions

java.lang.Object
  extended by LoadOptions
      extended by com.aspose.cells.AbstractTextLoadOptions
Direct Known Subclasses:
HtmlLoadOptions, TxtLoadOptions

public class AbstractTextLoadOptions 
extends LoadOptions

Common options for loading text values


Property Getters/Setters Summary
AutoFitterOptionsgetAutoFitterOptions()→ inherited from LoadOptions
voidsetAutoFitterOptions(AutoFitterOptions value)
           Gets and sets the auto fitter options
booleangetCheckDataValid()→ inherited from LoadOptions
voidsetCheckDataValid(boolean value)
           Check whether data is valid in the template file.
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)
           Gets or sets a value that indicates whether the string in text file is converted to date data.
booleangetConvertNumericData()
voidsetConvertNumericData(boolean value)
           Gets or sets a value that indicates whether the string in text file is converted to numeric data.
com.aspose.cells.EncodinggetEncoding()
voidsetEncoding(com.aspose.cells.Encoding value)
           Gets and sets the default encoding. Only applies for csv file.
IndividualFontConfigsgetFontConfigs()→ inherited from LoadOptions
voidsetFontConfigs(IndividualFontConfigs value)
           Gets and sets individual font configs. Only works for the Workbook which uses this LoadOptions to load.>
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.
booleangetKeepUnparsedData()→ inherited from LoadOptions
voidsetKeepUnparsedData(boolean value)
           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 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.
LoadFiltergetLoadFilter()→ inherited from LoadOptions
voidsetLoadFilter(LoadFilter value)
           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.
intgetLoadStyleStrategy()
voidsetLoadStyleStrategy(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.
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.
booleangetParsingFormulaOnOpen()→ inherited from LoadOptions
voidsetParsingFormulaOnOpen(boolean value)
           Indicates whether parsing the formula when reading the file.
booleangetParsingPivotCachedRecords()→ inherited from LoadOptions
voidsetParsingPivotCachedRecords(boolean value)
           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 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.
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.
 

Property Getters/Setters Detail

getEncoding/setEncoding

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

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

getLoadStyleStrategy/setLoadStyleStrategy

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

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

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

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

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

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

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

setKeepPrecision

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.

getStandardFont/setStandardFont

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

setStandardFont

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

setStandardFontSize

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

setInterruptMonitor

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

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 file now.

setAutoFitterOptions

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

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.