TocInfo
Inheritance: java.lang.Object
public final class TocInfo
Represents table of contents info.
Constructors
| Constructor | Description |
|---|---|
| TocInfo() | Initializes a new instance of the TocInfo class. |
Methods
| Method | Description |
|---|---|
| getColumnInfo() | Gets column info. |
| setColumnInfo(ColumnInfo value) | Sets column info. |
| getFormatArray() | Gets format array for table of contents. |
| setFormatArray(LevelFormat[] value) | Sets format array for table of contents. |
| getFormatArrayLength() | Gets format array length |
| setFormatArrayLength(int value) | Sets format array length |
| getTitle() | Gets table of contents title. |
| setTitle(TextFragment value) | Sets table of contents title. |
| isCountTocPages() | Gets is count or passed toc pages. |
| setCountTocPages(boolean value) | Sets is count or passed toc pages. |
| getPageNumbersPrefix() | Gets is prefix before page number. |
| setPageNumbersPrefix(String value) | Sets is prefix before page number. |
| isShowPageNumbers() | Gets is show page numbers at Toc. |
| setShowPageNumbers(boolean value) | Sets is show page numbers at Toc. |
| getLineDash() | Gets or sets TOC line dash. |
| setLineDash(int value) | Gets or sets TOC line dash. |
| getCopyToOutlines() | Gets or sets is TOC copied to outlines. |
| setCopyToOutlines(boolean value) | Gets or sets is TOC copied to outlines. |
| setLevelIndentation(int value) | Set Level indentation |
| getLevelIndentation() | Get Level indentation |
TocInfo()
public TocInfo()
Initializes a new instance of the TocInfo class.
getColumnInfo()
public final ColumnInfo getColumnInfo()
Gets column info.
Returns: ColumnInfo - ColumnInfo instance
setColumnInfo(ColumnInfo value)
public final void setColumnInfo(ColumnInfo value)
Sets column info.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | ColumnInfo | ColumnInfo instance |
getFormatArray()
public final LevelFormat[] getFormatArray()
Gets format array for table of contents.
Returns: com.aspose.pdf.LevelFormat[] - LevelFormat array
setFormatArray(LevelFormat[] value)
public final void setFormatArray(LevelFormat[] value)
Sets format array for table of contents.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | LevelFormat[] | LevelFormat array |
getFormatArrayLength()
public final int getFormatArrayLength()
Gets format array length
Returns: int - boolean value
setFormatArrayLength(int value)
public final void setFormatArrayLength(int value)
Sets format array length
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | boolean value |
getTitle()
public final TextFragment getTitle()
Gets table of contents title.
Returns: TextFragment - TextFragment instance
setTitle(TextFragment value)
public final void setTitle(TextFragment value)
Sets table of contents title.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | TextFragment | TextFragment instance |
isCountTocPages()
public final boolean isCountTocPages()
Gets is count or passed toc pages.
Returns: boolean - boolean value
setCountTocPages(boolean value)
public final void setCountTocPages(boolean value)
Sets is count or passed toc pages.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | boolean value |
getPageNumbersPrefix()
public final String getPageNumbersPrefix()
Gets is prefix before page number.
Returns: java.lang.String - String value
setPageNumbersPrefix(String value)
public final void setPageNumbersPrefix(String value)
Sets is prefix before page number.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String | String value |
isShowPageNumbers()
public final boolean isShowPageNumbers()
Gets is show page numbers at Toc.
Returns: boolean - boolean value
setShowPageNumbers(boolean value)
public final void setShowPageNumbers(boolean value)
Sets is show page numbers at Toc.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | boolean value |
getLineDash()
public final int getLineDash()
Gets or sets TOC line dash.
Returns: int - TabLeaderType value
setLineDash(int value)
public final void setLineDash(int value)
Gets or sets TOC line dash.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | TabLeaderType value |
getCopyToOutlines()
public final boolean getCopyToOutlines()
Gets or sets is TOC copied to outlines.
Returns: boolean - boolean value
setCopyToOutlines(boolean value)
public final void setCopyToOutlines(boolean value)
Gets or sets is TOC copied to outlines.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | boolean value |
setLevelIndentation(int value)
public void setLevelIndentation(int value)
Set Level indentation
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | int value |
getLevelIndentation()
public int getLevelIndentation()
Get Level indentation
Returns: int - int value
