com.groupdocs.assembly

Class DocumentTableOptions

java.lang.Object

com.groupdocs.assembly.DocumentTableOptions

public class DocumentTableOptions
extends java.lang.Object

Provides a set of options to control extraction of data from a document table.

Constructor Summary

Constructors

Constructor and Description
DocumentTableOptions() Creates a new instance of this class.

Method Summary

Modifier and Type	Method and Description
boolean	getFirstRowContainsColumnNames() Gets a value indicating whether column names are to be obtained from the first extracted row of a document table.
int	getMaxColumnIndex() Gets the largest zero-based index of a column to be extracted from a document table.
int	getMaxRowIndex() Gets the largest zero-based index of a row to be extracted from a document table.
int	getMinColumnIndex() Gets the smallest zero-based index of a column to be extracted from a document table.
int	getMinRowIndex() Gets the smallest zero-based index of a row to be extracted from a document table.
void	setFirstRowContainsColumnNames(boolean value) Sets a value indicating whether column names are to be obtained from the first extracted row of a document table.
void	setMaxColumnIndex(int value) Sets the largest zero-based index of a column to be extracted from a document table.
void	setMaxRowIndex(int value) Sets the largest zero-based index of a row to be extracted from a document table.
void	setMinColumnIndex(int value) Sets the smallest zero-based index of a column to be extracted from a document table.
void	setMinRowIndex(int value) Sets the smallest zero-based index of a row to be extracted from a document table.

Methods inherited from class java.lang.Object

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

Constructor Detail

DocumentTableOptions

public DocumentTableOptions()

Creates a new instance of this class.

Method Detail

getMinRowIndex

public int getMinRowIndex()

Gets the smallest zero-based index of a row to be extracted from a document table. The default value is negative which means that the smallest row index is not limited.

Returns:

The smallest zero-based index of a row to be extracted from a document table.

setMinRowIndex

public void setMinRowIndex(int value)

Sets the smallest zero-based index of a row to be extracted from a document table. The default value is negative which means that the smallest row index is not limited.

Parameters:

value - The smallest zero-based index of a row to be extracted from a document table.

getMaxRowIndex

public int getMaxRowIndex()

Gets the largest zero-based index of a row to be extracted from a document table. The default value is negative which means that the largest row index is not limited.

Returns:

The largest zero-based index of a row to be extracted from a document table.

setMaxRowIndex

public void setMaxRowIndex(int value)

Sets the largest zero-based index of a row to be extracted from a document table. The default value is negative which means that the largest row index is not limited.

Parameters:

value - The largest zero-based index of a row to be extracted from a document table.

getMinColumnIndex

public int getMinColumnIndex()

Gets the smallest zero-based index of a column to be extracted from a document table. The default value is negative which means that the smallest column index is not limited.

Returns:

The smallest zero-based index of a column to be extracted from a document table.

setMinColumnIndex

public void setMinColumnIndex(int value)

Sets the smallest zero-based index of a column to be extracted from a document table. The default value is negative which means that the smallest column index is not limited.

Parameters:

value - The smallest zero-based index of a column to be extracted from a document table.

getMaxColumnIndex

public int getMaxColumnIndex()

Gets the largest zero-based index of a column to be extracted from a document table. The default value is negative which means that the largest column index is not limited.

Returns:

The largest zero-based index of a column to be extracted from a document table.

setMaxColumnIndex

public void setMaxColumnIndex(int value)

Sets the largest zero-based index of a column to be extracted from a document table. The default value is negative which means that the largest column index is not limited.

Parameters:

value - The largest zero-based index of a column to be extracted from a document table.

getFirstRowContainsColumnNames

public boolean getFirstRowContainsColumnNames()

Gets a value indicating whether column names are to be obtained from the first extracted row of a document table. The default value is false. If column names are not set to be obtained from the first extracted row of a document table, default column names are used instead. For documents of Spreadsheet file formats, default column names are defined as A, B, C, ... Z, AA, AB, and so on. For documents of other file formats, default column names are defined as Column1, Column2, Column3, and so on.

Returns:

A value indicating whether column names are to be obtained from the first extracted row of a document table.

setFirstRowContainsColumnNames

public void setFirstRowContainsColumnNames(boolean value)

Sets a value indicating whether column names are to be obtained from the first extracted row of a document table. The default value is false. If column names are not set to be obtained from the first extracted row of a document table, default column names are used instead. For documents of Spreadsheet file formats, default column names are defined as A, B, C, ... Z, AA, AB, and so on. For documents of other file formats, default column names are defined as Column1, Column2, Column3, and so on.

Parameters:

value - A value indicating whether column names are to be obtained from the first extracted row of a document table.