GridLoadOptions
Inheritance: java.lang.Object
public class GridLoadOptions
Represents the options of loading the file. [Obsolete(“This class will be obsoleted after stand alone dll usage of cells public api,instead you can use Aspose.Cells.LodOptions “)]
Constructors
| Constructor | Description |
|---|---|
| GridLoadOptions() | Creates an options of loading the file. |
Methods
| Method | Description |
|---|---|
| equals(Object arg0) | |
| getAutoFilter() | Indicates whether auto filtering the data when loading the files. |
| getCheckDataValid() | Check whether data is valid in the template file. |
| getCheckExcelRestriction() | Whether check restriction of excel file when user modify cells related objects. |
| getClass() | |
| getIgnoreNotPrinted() | Ignore the data which are not printed if directly printing the file |
| getKeepUnparsedData() | Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. |
| getOnlyAuto() | Indicates whether only fit the rows which height are not customed. |
| getParsingFormulaOnOpen() | Indicates whether parsing the formula when reading the file. |
| getParsingPivotCachedRecords() | Indicates whether parsing pivot cached records when loading the file. |
| getPassword() | Gets the password of the workbook. |
| getPreservePaddingSpacesInFormula() | Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas. |
| hashCode() | |
| notify() | |
| notifyAll() | |
| setAutoFilter(boolean value) | Indicates whether auto filtering the data when loading the files. |
| setCheckDataValid(boolean value) | Check whether data is valid in the template file. |
| setCheckExcelRestriction(boolean value) | Whether check restriction of excel file when user modify cells related objects. |
| setIgnoreNotPrinted(boolean value) | Ignore the data which are not printed if directly printing the file |
| setKeepUnparsedData(boolean value) | Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. |
| setOnlyAuto(boolean value) | Indicates whether only fit the rows which height are not customed. |
| setParsingFormulaOnOpen(boolean value) | Indicates whether parsing the formula when reading the file. |
| setParsingPivotCachedRecords(boolean value) | Indicates whether parsing pivot cached records when loading the file. |
| setPassword(String value) | Sets the password of the workbook. |
| setPreservePaddingSpacesInFormula(boolean value) | Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas. |
| toString() | |
| wait() | |
| wait(long arg0) | |
| wait(long arg0, int arg1) |
GridLoadOptions()
public GridLoadOptions()
Creates an options of loading the file.
equals(Object arg0)
public boolean equals(Object arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | java.lang.Object |
Returns: boolean
getAutoFilter()
public boolean getAutoFilter()
Indicates whether auto filtering the data when loading the files.
Remarks
Sometimes although autofilter is set, the corresponding rows is not hidden in the file. Now only works for SpreadSheetML file.
Returns: boolean
getCheckDataValid()
public boolean getCheckDataValid()
Check whether data is valid in the template file.
Returns: boolean
getCheckExcelRestriction()
public boolean getCheckExcelRestriction()
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.
Returns: boolean
getClass()
public final native Class<?> getClass()
Returns: java.lang.Class
getIgnoreNotPrinted()
public boolean getIgnoreNotPrinted()
Ignore the data which are not printed if directly printing the file
Remarks
Only for xlsx file.
Returns: boolean
getKeepUnparsedData()
public boolean getKeepUnparsedData()
Whether keep the unparsed data in memory for the Workbook when it is loaded from template file. Default is true.
Remarks
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,
Returns: boolean
getOnlyAuto()
public boolean getOnlyAuto()
Indicates whether only fit the rows which height are not customed.
Returns: boolean
getParsingFormulaOnOpen()
public boolean getParsingFormulaOnOpen()
Indicates whether parsing the formula when reading the file.
Remarks
Only applies for Excel Xlsx, Xltx, Xltm and Xlsm file because the formulas in the files are stored with a string formula.
Returns: boolean
getParsingPivotCachedRecords()
public boolean getParsingPivotCachedRecords()
Indicates whether parsing pivot cached records when loading the file. The default value is false.
Remarks
Only applies for Excel Xlsx, Xltx, Xltm , Xlsm and xlsb file
Returns: boolean
getPassword()
public String getPassword()
Gets the password of the workbook.
Returns: java.lang.String
getPreservePaddingSpacesInFormula()
public boolean getPreservePaddingSpacesInFormula()
Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas. Default value is false.
Remarks
After loading workbook from template file with this option, GridWorkbookSettings.getPreservePaddingSpaces() will be set to the same value with this property.
Returns: boolean
hashCode()
public native int hashCode()
Returns: int
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
setAutoFilter(boolean value)
public void setAutoFilter(boolean value)
Indicates whether auto filtering the data when loading the files.
Remarks
Sometimes although autofilter is set, the corresponding rows is not hidden in the file. Now only works for SpreadSheetML file.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setCheckDataValid(boolean value)
public void setCheckDataValid(boolean value)
Check whether data is valid in the template file.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setCheckExcelRestriction(boolean value)
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setIgnoreNotPrinted(boolean value)
public void setIgnoreNotPrinted(boolean value)
Ignore the data which are not printed if directly printing the file
Remarks
Only for xlsx file.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setKeepUnparsedData(boolean value)
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.
Remarks
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,
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setOnlyAuto(boolean value)
public void setOnlyAuto(boolean value)
Indicates whether only fit the rows which height are not customed.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setParsingFormulaOnOpen(boolean value)
public void setParsingFormulaOnOpen(boolean value)
Indicates whether parsing the formula when reading the file.
Remarks
Only applies for Excel Xlsx, Xltx, Xltm and Xlsm file because the formulas in the files are stored with a string formula.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setParsingPivotCachedRecords(boolean value)
public void setParsingPivotCachedRecords(boolean value)
Indicates whether parsing pivot cached records when loading the file. The default value is false.
Remarks
Only applies for Excel Xlsx, Xltx, Xltm , Xlsm and xlsb file
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setPassword(String value)
public void setPassword(String value)
Sets the password of the workbook.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setPreservePaddingSpacesInFormula(boolean value)
public void setPreservePaddingSpacesInFormula(boolean value)
Indicates whether preserve those spaces and line breaks that are padded between formula tokens while getting and setting formulas. Default value is false.
Remarks
After loading workbook from template file with this option, GridWorkbookSettings.getPreservePaddingSpaces() will be set to the same value with this property.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
toString()
public String toString()
Returns: java.lang.String
wait()
public final void wait()
wait(long arg0)
public final native void wait(long arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long |
wait(long arg0, int arg1)
public final void wait(long arg0, int arg1)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long | |
| arg1 | int |