com.aspose.cells

Class DeleteBlankOptions

java.lang.Object

com.aspose.cells.DeleteOptions

com.aspose.cells.DeleteBlankOptions

public class DeleteBlankOptions
extends DeleteOptions

Represents the setting of deleting blank cells/rows/columns.

Constructor Summary

Constructors

Constructor and Description
DeleteBlankOptions()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getDrawingsAsBlank() Whether drawing related objects such as picture, shape, chart...
boolean	getEmptyFormulaValueAsBlank() Whether one cell will be taken as blank when it is formula and the calculated result is null or empty string.
boolean	getEmptyStringAsBlank() Whether one cell will be taken as blank when its value is empty string.
int	getEndIndex() Specifies the end row/column index(inclusive) of the range to check and delete blank rows/columns.
int	getMergedCellsShrinkType() Indicates how to process merged cells when deleting blank rows/columns.
int	getStartIndex() Specifies the start row/column index of the range to check and delete blank rows/columns.
void	setDrawingsAsBlank(boolean value) Whether drawing related objects such as picture, shape, chart...
void	setEmptyFormulaValueAsBlank(boolean value) Whether one cell will be taken as blank when it is formula and the calculated result is null or empty string.
void	setEmptyStringAsBlank(boolean value) Whether one cell will be taken as blank when its value is empty string.
void	setEndIndex(int value) Specifies the end row/column index(inclusive) of the range to check and delete blank rows/columns.
void	setMergedCellsShrinkType(int value) Indicates how to process merged cells when deleting blank rows/columns.
void	setStartIndex(int value) Specifies the start row/column index of the range to check and delete blank rows/columns.

Methods inherited from class com.aspose.cells.DeleteOptions

getFormulaChangeMonitor, getUpdateReference, setFormulaChangeMonitor, setUpdateReference

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DeleteBlankOptions

public DeleteBlankOptions()

Method Detail

getEmptyStringAsBlank

public boolean getEmptyStringAsBlank()

Whether one cell will be taken as blank when its value is empty string. Default value is true.

setEmptyStringAsBlank

public void setEmptyStringAsBlank(boolean value)

Whether one cell will be taken as blank when its value is empty string. Default value is true.

getEmptyFormulaValueAsBlank

public boolean getEmptyFormulaValueAsBlank()

Whether one cell will be taken as blank when it is formula and the calculated result is null or empty string. Default value is false.

Remarks

Generally user should make sure the formulas have been calculated before deleting operation with this property as true. Otherwise all newly cretaed formulas by normal apis such as Cell.getFormula() will be taken as blank and may be deleted because before calculation their calculated results are all null.

setEmptyFormulaValueAsBlank

public void setEmptyFormulaValueAsBlank(boolean value)

Whether one cell will be taken as blank when it is formula and the calculated result is null or empty string. Default value is false.

Remarks

Generally user should make sure the formulas have been calculated before deleting operation with this property as true. Otherwise all newly cretaed formulas by normal apis such as Cell.getFormula() will be taken as blank and may be deleted because before calculation their calculated results are all null.

getDrawingsAsBlank

public boolean getDrawingsAsBlank()

Whether drawing related objects such as picture, shape, chart... will be taken as blank. Default value is true.

Remarks

When setting this property as false, all rows/columns covered by drawing objects will not be taken as blank and will not be deleted.

setDrawingsAsBlank

public void setDrawingsAsBlank(boolean value)

Whether drawing related objects such as picture, shape, chart... will be taken as blank. Default value is true.

Remarks

When setting this property as false, all rows/columns covered by drawing objects will not be taken as blank and will not be deleted.

getMergedCellsShrinkType

public int getMergedCellsShrinkType()

Indicates how to process merged cells when deleting blank rows/columns.

See MergedCellsShrinkType.

Remarks

For MergedCellsShrinkType.KEEP_HEADER_ONLY, all cells in it will be taken as blank except the non-blank top-left cell. It is the default value of this property.

For MergedCellsShrinkType.NONE, all cells in it will be taken as non-blank.

For MergedCellsShrinkType.SHRINK_TO_FIT, all cells outside the content display area will be taken as blank.

setMergedCellsShrinkType

public void setMergedCellsShrinkType(int value)

Indicates how to process merged cells when deleting blank rows/columns.

See MergedCellsShrinkType.

Remarks

For MergedCellsShrinkType.KEEP_HEADER_ONLY, all cells in it will be taken as blank except the non-blank top-left cell. It is the default value of this property.

For MergedCellsShrinkType.NONE, all cells in it will be taken as non-blank.

For MergedCellsShrinkType.SHRINK_TO_FIT, all cells outside the content display area will be taken as blank.

getStartIndex

public int getStartIndex()

Specifies the start row/column index of the range to check and delete blank rows/columns.

setStartIndex

public void setStartIndex(int value)

Specifies the start row/column index of the range to check and delete blank rows/columns.

getEndIndex

public int getEndIndex()

Specifies the end row/column index(inclusive) of the range to check and delete blank rows/columns. Default value is -1 and -1 means the maximum range of all objects(cells, drawings, ...) that need to be checked.

setEndIndex

public void setEndIndex(int value)

Specifies the end row/column index(inclusive) of the range to check and delete blank rows/columns. Default value is -1 and -1 means the maximum range of all objects(cells, drawings, ...) that need to be checked.