DeleteBlankOptions

Inheritance: java.lang.Object, com.aspose.cells.DeleteOptions

public class DeleteBlankOptions extends DeleteOptions

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

Constructors

ConstructorDescription
DeleteBlankOptions()

Methods

MethodDescription
equals(Object arg0)
getClass()
getDrawingsAsBlank()Whether drawing related objects such as picture, shape, chart… will be taken as blank.
getEmptyFormulaValueAsBlank()Whether one cell will be taken as blank when it is formula and the calculated result is null or empty string.
getEmptyStringAsBlank()Whether one cell will be taken as blank when its value is empty string.
getEndIndex()Specifies the end row/column index(inclusive) of the range to check and delete blank rows/columns.
getFormulaChangeMonitor()Gets the monitor for tracking changes caused by the deletion.
getMergedCellsShrinkType()Indicates how to process merged cells when deleting blank rows/columns.
getStartIndex()Specifies the start row/column index of the range to check and delete blank rows/columns.
getUpdateReference()Indicates if update references in other worksheets.
hashCode()
notify()
notifyAll()
setDrawingsAsBlank(boolean value)Whether drawing related objects such as picture, shape, chart… will be taken as blank.
setEmptyFormulaValueAsBlank(boolean value)Whether one cell will be taken as blank when it is formula and the calculated result is null or empty string.
setEmptyStringAsBlank(boolean value)Whether one cell will be taken as blank when its value is empty string.
setEndIndex(int value)Specifies the end row/column index(inclusive) of the range to check and delete blank rows/columns.
setFormulaChangeMonitor(AbstractFormulaChangeMonitor value)Sets the monitor for tracking changes caused by the deletion.
setMergedCellsShrinkType(int value)Indicates how to process merged cells when deleting blank rows/columns.
setStartIndex(int value)Specifies the start row/column index of the range to check and delete blank rows/columns.
setUpdateReference(boolean value)Indicates if update references in other worksheets.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

DeleteBlankOptions()

public DeleteBlankOptions()

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

ParameterTypeDescription
arg0java.lang.Object

Returns: boolean

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

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.

Returns: boolean

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.

Returns: boolean

getEmptyStringAsBlank()

public boolean getEmptyStringAsBlank()

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

Returns: boolean

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.

Returns: int

getFormulaChangeMonitor()

public AbstractFormulaChangeMonitor getFormulaChangeMonitor()

Gets the monitor for tracking changes caused by the deletion.

Returns: AbstractFormulaChangeMonitor

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.

Returns: int

getStartIndex()

public int getStartIndex()

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

Returns: int

getUpdateReference()

public boolean getUpdateReference()

Indicates if update references in other worksheets.

Returns: boolean

hashCode()

public native int hashCode()

Returns: int

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

setDrawingsAsBlank(boolean value)

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.

Parameters:

ParameterTypeDescription
valueboolean

setEmptyFormulaValueAsBlank(boolean value)

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.

Parameters:

ParameterTypeDescription
valueboolean

setEmptyStringAsBlank(boolean value)

public void setEmptyStringAsBlank(boolean value)

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

Parameters:

ParameterTypeDescription
valueboolean

setEndIndex(int value)

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.

Parameters:

ParameterTypeDescription
valueint

setFormulaChangeMonitor(AbstractFormulaChangeMonitor value)

public void setFormulaChangeMonitor(AbstractFormulaChangeMonitor value)

Sets the monitor for tracking changes caused by the deletion.

Parameters:

ParameterTypeDescription
valueAbstractFormulaChangeMonitor

setMergedCellsShrinkType(int value)

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.

Parameters:

ParameterTypeDescription
valueint

setStartIndex(int value)

public void setStartIndex(int value)

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

Parameters:

ParameterTypeDescription
valueint

setUpdateReference(boolean value)

public void setUpdateReference(boolean value)

Indicates if update references in other worksheets.

Parameters:

ParameterTypeDescription
valueboolean

toString()

public String toString()

Returns: java.lang.String

wait()

public final void wait()

wait(long arg0)

public final native void wait(long arg0)

Parameters:

ParameterTypeDescription
arg0long

wait(long arg0, int arg1)

public final void wait(long arg0, int arg1)

Parameters:

ParameterTypeDescription
arg0long
arg1int