TocInfo

Inheritance: java.lang.Object, com.aspose.pdf.TocInfo

public final class TocInfo extends Object

Represents table of contents info.

Constructors

Constructor	Description
TocInfo	Initializes a new instance of the {@code TocInfo} class.

Methods

Method	Description
getColumnInfo	Gets column info.
getCopyToOutlines	Gets or sets is TOC copied to outlines.
getFormatArray	Gets format array for table of contents.
getFormatArrayLength	Gets format array length
getLevelIndentation	Get Level indentation
getLineDash	Gets or sets TOC line dash.
getPageNumbersPrefix	Gets is prefix before page number.
getTitle	Gets table of contents title.
isCountTocPages	Gets is count or passed toc pages.
isShowPageNumbers	Gets is show page numbers at Toc.
setColumnInfo	Sets column info.
setCopyToOutlines	Gets or sets is TOC copied to outlines.
setCountTocPages	Sets is count or passed toc pages.
setFormatArray	Sets format array for table of contents.
setFormatArrayLength	Sets format array length
setLevelIndentation	Set Level indentation
setLineDash	Gets or sets TOC line dash.
setPageNumbersPrefix	Sets is prefix before page number.
setShowPageNumbers	Sets is show page numbers at Toc.
setTitle	Sets table of contents title.

TocInfo

public TocInfo()

Initializes a new instance of the {@code TocInfo} class.

getColumnInfo

public final ColumnInfo getColumnInfo()

Gets column info.

Returns: ColumnInfo instance

getCopyToOutlines

public final boolean getCopyToOutlines()

Gets or sets is TOC copied to outlines.

Returns: boolean value

getFormatArray

public final LevelFormat [] getFormatArray()

Gets format array for table of contents.

Returns: LevelFormat array

getFormatArrayLength

public final int getFormatArrayLength()

Gets format array length

Returns: boolean value

getLevelIndentation

public int getLevelIndentation()

Get Level indentation

Returns: int value

getLineDash

public final int getLineDash()

Gets or sets TOC line dash.

Returns: TabLeaderType value

getPageNumbersPrefix

public final String getPageNumbersPrefix()

Gets is prefix before page number.

Returns: String value

getTitle

public final TextFragment getTitle()

Gets table of contents title.

Returns: TextFragment instance

isCountTocPages

public final boolean isCountTocPages()

Gets is count or passed toc pages.

Returns: boolean value

isShowPageNumbers

public final boolean isShowPageNumbers()

Gets is show page numbers at Toc.

Returns: boolean value

setColumnInfo

Sets column info.

setCopyToOutlines

public final void setCopyToOutlines(boolean value)

Gets or sets is TOC copied to outlines.

Parameters:

Parameter	Type	Description
value		boolean value

setCountTocPages

public final void setCountTocPages(boolean value)

Sets is count or passed toc pages.

Parameters:

Parameter	Type	Description
value		boolean value

setFormatArray

Sets format array for table of contents.

setFormatArrayLength

public final void setFormatArrayLength(int value)

Sets format array length

Parameters:

Parameter	Type	Description
value		boolean value

setLevelIndentation

public void setLevelIndentation(int value)

Set Level indentation

Parameters:

Parameter	Type	Description
value		int value

setLineDash

public final void setLineDash(int value)

Gets or sets TOC line dash.

Parameters:

Parameter	Type	Description
value		TabLeaderType value

setPageNumbersPrefix

Sets is prefix before page number.

setShowPageNumbers

public final void setShowPageNumbers(boolean value)

Sets is show page numbers at Toc.

Parameters:

Parameter	Type	Description
value		boolean value

setTitle

Sets table of contents title.