DocumentTableLoadArgs
Inheritance: java.lang.Object
public class DocumentTableLoadArgs
Provides data for the IDocumentTableLoadHandler.handle(com.groupdocs.assembly.DocumentTableLoadArgs) method.
Methods
| Method | Description |
|---|---|
| getTableIndex() | Gets the zero-based index of the corresponding document table to be loaded. |
| isLoaded() | Gets a value indicating whether the corresponding document table is to be loaded or not. |
| isLoaded(boolean value) | Sets a value indicating whether the corresponding document table is to be loaded or not. |
| getOptions() | Gets DocumentTableOptions to be used while loading the corresponding document table. |
| setOptions(DocumentTableOptions value) | Sets DocumentTableOptions to be used while loading the corresponding document table. |
getTableIndex()
public int getTableIndex()
Gets the zero-based index of the corresponding document table to be loaded.
Returns: int - 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: boolean - A value indicating whether the corresponding document table is to be loaded or not.
isLoaded(boolean value)
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:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | 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 - DocumentTableOptions to be used while loading the corresponding document table.
setOptions(DocumentTableOptions value)
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:
| Parameter | Type | Description |
|---|---|---|
| value | DocumentTableOptions | DocumentTableOptions to be used while loading the corresponding document table. |