com.groupdocs.assembly

Class DocumentTableLoadArgs

java.lang.Object

com.groupdocs.assembly.DocumentTableLoadArgs

public class DocumentTableLoadArgs
extends java.lang.Object

Provides data for the IDocumentTableLoadHandler.handle(com.groupdocs.assembly.DocumentTableLoadArgs) method.

Method Summary

Modifier and Type	Method and Description
DocumentTableOptions	getOptions() Gets DocumentTableOptions to be used while loading the corresponding document table.
int	getTableIndex() Gets the zero-based index of the corresponding document table to be loaded.
boolean	isLoaded() Gets a value indicating whether the corresponding document table is to be loaded or not.
void	isLoaded(boolean value) Sets a value indicating whether the corresponding document table is to be loaded or not.
void	setOptions(DocumentTableOptions value) Sets DocumentTableOptions to be used while loading the corresponding document table.

Methods inherited from class java.lang.Object

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

Method Detail

getTableIndex

public int getTableIndex()

Gets the zero-based index of the corresponding document table to be loaded.

Returns:

The zero-based index of the corresponding document table to be loaded.

isLoaded

public boolean isLoaded()

Gets a value indicating whether the corresponding document table is to be loaded or not. The default value is true.

Returns:

A value indicating whether the corresponding document table is to be loaded or not.

isLoaded

public void isLoaded(boolean value)

Sets a value indicating whether the corresponding document table is to be loaded or not. The default value is true.

Parameters:

value - A value indicating whether the corresponding document table is to be loaded or not.

getOptions

public DocumentTableOptions getOptions()

Gets DocumentTableOptions to be used while loading the corresponding document table. The default value is null, which means that default DocumentTableOptions are to be applied.

Returns:

DocumentTableOptions to be used while loading the corresponding document table.

setOptions

public void setOptions(DocumentTableOptions value)

Sets DocumentTableOptions to be used while loading the corresponding document table. The default value is null, which means that default DocumentTableOptions are to be applied.

Parameters:

value - DocumentTableOptions to be used while loading the corresponding document table.