ExportTableOptions

Inheritance: java.lang.Object

public class ExportTableOptions

Represents all export table options.

Remarks

If there are some special requirements about the exporting, such as ignoring error values, user may extend this class to overwrite corresponding apis to achive the goal.

Constructors

Constructor	Description
ExportTableOptions()

Methods

Method	Description
equals(Object arg0)
getAllowDBNull()	This value indicates whether DBNulls are allowed in this table.
getCheckMixedValueType()	False, Aspose.Cells will set the DataColumn’s type by the value type of the first row for performance.
getClass()
getExportAsHtmlString()	Exports the html string value of the cells to the DataTable.
getExportAsString()	Exports the string value of the cells to the DataTable.
getExportColumnName()	Indicates whether the data in the first row are exported to the column name of the DataTable.
getFormatStrategy()	Gets the format strategy when exporting the value as string value.
getIndexes()	The indexes of columns/rows which should be exported out.
getPlotVisibleCells()	Only exports visible cells.
getPlotVisibleColumns()	Only exports visible columns.
getPlotVisibleRows()	Only exports visible rows.
getRenameStrategy()	Strategy for duplicate names of columns.
getSkipErrorValue()	Indicates whether skip invalid value for the column.
hashCode()
isVertical()	True if a row in Workbook file represents a row in DataTable.
notify()
notifyAll()
preprocessExportedValue(int cellRow, int cellColumn, CellValue value)	Preprocess the value of current cell to be exported.
setAllowDBNull(boolean value)	This value indicates whether DBNulls are allowed in this table.
setCheckMixedValueType(boolean value)	False, Aspose.Cells will set the DataColumn’s type by the value type of the first row for performance.
setExportAsHtmlString(boolean value)	Exports the html string value of the cells to the DataTable.
setExportAsString(boolean value)	Exports the string value of the cells to the DataTable.
setExportColumnName(boolean value)	Indicates whether the data in the first row are exported to the column name of the DataTable.
setFormatStrategy(int value)	Sets the format strategy when exporting the value as string value.
setIndexes(int[] value)	The indexes of columns/rows which should be exported out.
setPlotVisibleCells(boolean value)	Only exports visible cells.
setPlotVisibleColumns(boolean value)	Only exports visible columns.
setPlotVisibleRows(boolean value)	Only exports visible rows.
setRenameStrategy(int value)	Strategy for duplicate names of columns.
setSkipErrorValue(boolean value)	Indicates whether skip invalid value for the column.
setVertical(boolean value)	True if a row in Workbook file represents a row in DataTable.
toString()
wait()
wait(long arg0)
wait(long arg0, int arg1)

ExportTableOptions()

public ExportTableOptions()

equals(Object arg0)

public boolean equals(Object arg0)

Parameters:

Parameter	Type	Description
arg0	java.lang.Object

Returns: boolean

getAllowDBNull()

public boolean getAllowDBNull()

This value indicates whether DBNulls are allowed in this table.

Returns: boolean

getCheckMixedValueType()

public boolean getCheckMixedValueType()

False, Aspose.Cells will set the DataColumn’s type by the value type of the first row for performance. True, Aspose.Cells will check whether the value type in the column are mixed before set the DataColumn’s type And the value type are mixed, the DataColumn’s type will be string.

Returns: boolean

getClass()

public final native Class<?> getClass()

Returns: java.lang.Class

getExportAsHtmlString()

public boolean getExportAsHtmlString()

Exports the html string value of the cells to the DataTable.

Returns: boolean

getExportAsString()

public boolean getExportAsString()

Exports the string value of the cells to the DataTable.

Returns: boolean

getExportColumnName()

public boolean getExportColumnName()

Indicates whether the data in the first row are exported to the column name of the DataTable. The default value is false.

Returns: boolean

getFormatStrategy()

public int getFormatStrategy()

Gets the format strategy when exporting the value as string value.

See CellValueFormatStrategy.

Returns: int

getIndexes()

public int[] getIndexes()

The indexes of columns/rows which should be exported out.

Returns: int[]

getPlotVisibleCells()

public boolean getPlotVisibleCells()

Only exports visible cells.

Returns: boolean

getPlotVisibleColumns()

public boolean getPlotVisibleColumns()

Only exports visible columns.

Returns: boolean

getPlotVisibleRows()

public boolean getPlotVisibleRows()

Only exports visible rows.

Returns: boolean

getRenameStrategy()

public int getRenameStrategy()

Strategy for duplicate names of columns.

See RenameStrategy.

Returns: int

getSkipErrorValue()

public boolean getSkipErrorValue()

Indicates whether skip invalid value for the column. For example,if the column type is decimal ,the value is greater than decimal.MaxValue and this property is true,we will not throw exception again. The default value is false.

Returns: boolean

hashCode()

public native int hashCode()

Returns: int

isVertical()

public boolean isVertical()

True if a row in Workbook file represents a row in DataTable. False if a column in Workbook file represents a row in DataTable.

Returns: boolean

notify()

public final native void notify()

notifyAll()

public final native void notifyAll()

preprocessExportedValue(int cellRow, int cellColumn, CellValue value)

public boolean preprocessExportedValue(int cellRow, int cellColumn, CellValue value)

Preprocess the value of current cell to be exported.

Remarks

The row and column index is cell’s absolute index in the worksheet, not index in the exported table. User may check the value of current cell in the override implementation of this method, if current cell needs to be replaced with other type and value, here the implementation should set the expected type and value to the CellValue object and return true. By default this method does nothing and returns false.

Parameters:

Parameter	Type	Description
cellRow	int	the row index of current cell
cellColumn	int	the column index of cell
value	CellValue	value and type of current cell

Returns: boolean - Whether current cell has been replaced with different type and/or value.

setAllowDBNull(boolean value)

public void setAllowDBNull(boolean value)

This value indicates whether DBNulls are allowed in this table.

Parameters:

Parameter	Type	Description
value	boolean

setCheckMixedValueType(boolean value)

public void setCheckMixedValueType(boolean value)

False, Aspose.Cells will set the DataColumn’s type by the value type of the first row for performance. True, Aspose.Cells will check whether the value type in the column are mixed before set the DataColumn’s type And the value type are mixed, the DataColumn’s type will be string.

Parameters:

Parameter	Type	Description
value	boolean

setExportAsHtmlString(boolean value)

public void setExportAsHtmlString(boolean value)

Exports the html string value of the cells to the DataTable.

Parameters:

Parameter	Type	Description
value	boolean

setExportAsString(boolean value)

public void setExportAsString(boolean value)

Exports the string value of the cells to the DataTable.

Parameters:

Parameter	Type	Description
value	boolean

setExportColumnName(boolean value)

public void setExportColumnName(boolean value)

Indicates whether the data in the first row are exported to the column name of the DataTable. The default value is false.

Parameters:

Parameter	Type	Description
value	boolean

setFormatStrategy(int value)

public void setFormatStrategy(int value)

Sets the format strategy when exporting the value as string value.

See CellValueFormatStrategy.

Parameters:

Parameter	Type	Description
value	int

setIndexes(int[] value)

public void setIndexes(int[] value)

The indexes of columns/rows which should be exported out.

Parameters:

Parameter	Type	Description
value	int[]

setPlotVisibleCells(boolean value)

public void setPlotVisibleCells(boolean value)

Only exports visible cells.

Parameters:

Parameter	Type	Description
value	boolean

setPlotVisibleColumns(boolean value)

public void setPlotVisibleColumns(boolean value)

Only exports visible columns.

Parameters:

Parameter	Type	Description
value	boolean

setPlotVisibleRows(boolean value)

public void setPlotVisibleRows(boolean value)

Only exports visible rows.

Parameters:

Parameter	Type	Description
value	boolean

setRenameStrategy(int value)

public void setRenameStrategy(int value)

Strategy for duplicate names of columns.

See RenameStrategy.

Parameters:

Parameter	Type	Description
value	int

setSkipErrorValue(boolean value)

public void setSkipErrorValue(boolean value)

Indicates whether skip invalid value for the column. For example,if the column type is decimal ,the value is greater than decimal.MaxValue and this property is true,we will not throw exception again. The default value is false.

Parameters:

Parameter	Type	Description
value	boolean

setVertical(boolean value)

public void setVertical(boolean value)

True if a row in Workbook file represents a row in DataTable. False if a column in Workbook file represents a row in DataTable.

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