com.aspose.cells

Class ODSLoadOptions

  • java.lang.Object
public class ODSLoadOptions 
extends LoadOptions

Represents the options of loading ods file.

Constructor Summary
ODSLoadOptions()
Represents the options of loading ods file.
ODSLoadOptions(inttype)
Represents the options of loading ods file.
 
Property Getters/Setters Summary
booleangetApplyExcelDefaultStyleToHyperlink()
void
           Indicates whether applying the default style of the Excel to hyperlink.
AutoFitterOptionsgetAutoFitterOptions()
void
           Gets and sets the auto fitter options
booleangetCheckExcelRestriction()
void
           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.
IndividualFontConfigsgetFontConfigs()
void
           Gets and sets individual font configs. Only works for the Workbook which uses this LoadOptions to load.>
booleangetIgnoreNotPrinted()
void
setIgnoreNotPrinted(booleanvalue)
           Ignore the data which are not printed if directly printing the file
InterruptMonitorgetInterruptMonitor()
void
           Gets and sets the interrupt monitor.
intgetLanguageCode()
void
setLanguageCode(intvalue)
           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()
void
           The data handler for processing cells data when reading template file.
LoadFiltergetLoadFilter()
void
           The filter to denote how to load data.
intgetLoadFormat()
Gets the load format. The value of the property is LoadFormat integer constant.
java.util.LocalegetLocale()
void
setLocale(java.util.Localevalue)
           Gets and sets the Locale used for workbook at the time the file was loaded.
intgetMemorySetting()
void
           Gets or sets the memory usage options. The value of the property is MemorySetting integer constant.
booleangetParsingFormulaOnOpen()
void
           Indicates whether parsing the formula when reading the file.
booleangetParsingPivotCachedRecords()
void
           Inidicates whether parsing pivot cached records when loadiing the file. The default value is false.
java.lang.StringgetPassword()
void
setPassword(java.lang.Stringvalue)
           Gets and set the password of the workbook.
intgetRegion()
void
setRegion(intvalue)
           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()
void
setStandardFont(java.lang.Stringvalue)
           Sets the default standard font name
doublegetStandardFontSize()
void
setStandardFontSize(doublevalue)
           Sets the default standard font size.
IWarningCallbackgetWarningCallback()
void
           Gets or sets warning callback.
 
Method Summary
voidsetPaperSize(int type)
Sets the default print paper size from default printer's setting.
 

    • Constructor Detail

      • ODSLoadOptions

        public ODSLoadOptions()
        Represents the options of loading ods file.
      • ODSLoadOptions

        public ODSLoadOptions(int type)
        Represents the options of loading ods file.
        Parameters:
        type - A LoadFormat value. The load format type.
    • Property Getters/Setters Detail

      • getApplyExcelDefaultStyleToHyperlink/setApplyExcelDefaultStyleToHyperlink

        public boolean getApplyExcelDefaultStyleToHyperlink() / public void setApplyExcelDefaultStyleToHyperlink(boolean value)
        
        Indicates whether applying the default style of the Excel to hyperlink.
      • getLoadFormat

        public int getLoadFormat()
        
        Gets the load format. The value of the property is LoadFormat integer constant.
      • getPassword/setPassword

        public java.lang.String getPassword() / public void setPassword(java.lang.String value)
        
        Gets and set the password of the workbook.
      • getParsingFormulaOnOpen/setParsingFormulaOnOpen

        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.
      • getParsingPivotCachedRecords/setParsingPivotCachedRecords

        public boolean getParsingPivotCachedRecords() / public void setParsingPivotCachedRecords(boolean value)
        
        Inidicates whether parsing pivot cached records when loadiing the file. The default value is false. Only applies for Excel Xlsx, Xltx, Xltm , Xlsm and xlsb file
      • getLanguageCode/setLanguageCode

        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

        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

        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

        public java.lang.String getStandardFont() / public void setStandardFont(java.lang.String value)
        
        Sets the default standard font name
      • getStandardFontSize/setStandardFontSize

        public double getStandardFontSize() / public void setStandardFontSize(double value)
        
        Sets the default standard font size.
      • getInterruptMonitor/setInterruptMonitor

        public InterruptMonitor getInterruptMonitor() / public void setInterruptMonitor(InterruptMonitor value)
        
        Gets and sets the interrupt monitor.
      • getIgnoreNotPrinted/setIgnoreNotPrinted

        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

        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

        public LoadFilter getLoadFilter() / public void setLoadFilter(LoadFilter value)
        
        The filter to denote how to load data.
      • getLightCellsDataHandler/setLightCellsDataHandler

        public LightCellsDataHandler getLightCellsDataHandler() / public void setLightCellsDataHandler(LightCellsDataHandler value)
        
        The data handler for processing cells data when reading template file.
      • getMemorySetting/setMemorySetting

        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

        public IWarningCallback getWarningCallback() / public void setWarningCallback(IWarningCallback value)
        
        Gets or sets warning callback.
      • getAutoFitterOptions/setAutoFitterOptions

        public AutoFitterOptions getAutoFitterOptions() / public void setAutoFitterOptions(AutoFitterOptions value)
        
        Gets and sets the auto fitter options Only for xlsx file now.

    setApplyExcelDefaultStyleToHyperlink

    public voidsetApplyExcelDefaultStyleToHyperlink(booleanvalue)
    
    Indicates whether applying the default style of the Excel to hyperlink.

    setPassword

    public voidsetPassword(java.lang.Stringvalue)
    
    Gets and set the password of the workbook.

    setParsingFormulaOnOpen

    public voidsetParsingFormulaOnOpen(booleanvalue)
    
    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.

    setParsingPivotCachedRecords

    public voidsetParsingPivotCachedRecords(booleanvalue)
    
    Inidicates whether parsing pivot cached records when loadiing the file. The default value is false. Only applies for Excel Xlsx, Xltx, Xltm , Xlsm and xlsb file

    setLanguageCode

    public voidsetLanguageCode(intvalue)
    
    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.

    setRegion

    public voidsetRegion(intvalue)
    
    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.

    setLocale

    public voidsetLocale(java.util.Localevalue)
    
    Gets and sets the Locale used for workbook at the time the file was loaded.

    setStandardFont

    public voidsetStandardFont(java.lang.Stringvalue)
    
    Sets the default standard font name

    setStandardFontSize

    public voidsetStandardFontSize(doublevalue)
    
    Sets the default standard font size.

    setInterruptMonitor

    public voidsetInterruptMonitor(InterruptMonitor value)
    
    Gets and sets the interrupt monitor.

    setIgnoreNotPrinted

    public voidsetIgnoreNotPrinted(booleanvalue)
    
    Ignore the data which are not printed if directly printing the file Only for xlsx file.

    setCheckExcelRestriction

    public voidsetCheckExcelRestriction(booleanvalue)
    
    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.

    setLoadFilter

    public voidsetLoadFilter(LoadFilter value)
    
    The filter to denote how to load data.

    setLightCellsDataHandler

    public voidsetLightCellsDataHandler(LightCellsDataHandler value)
    
    The data handler for processing cells data when reading template file.

    setMemorySetting

    public voidsetMemorySetting(intvalue)
    
    Gets or sets the memory usage options. The value of the property is MemorySetting integer constant.

    setWarningCallback

    public voidsetWarningCallback(IWarningCallback value)
    
    Gets or sets warning callback.

    setAutoFitterOptions

    public voidsetAutoFitterOptions(AutoFitterOptions value)
    
    Gets and sets the auto fitter options Only for xlsx file now.

    setFontConfigs

    public voidsetFontConfigs(IndividualFontConfigs value)
    
    Gets and sets individual font configs. Only works for the Workbook which uses this LoadOptions to load.>
    • Method Detail

      • setPaperSize

        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.