Show / Hide Table of Contents

# Class HTML2PDF.TOCSettings

##### Inheritance

object
HTML2PDF.TOCSettings

##### Implements

IDisposable

##### Inherited Members

object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()

###### Namespace: pdftron.PDF

###### Assembly: PDFTronDotNet.dll

##### Syntax

    public class HTML2PDF.TOCSettings : IDisposable

##### Remarks

This option is deprecated in the latest HTML2PDF module and may have no effect.

### Constructors

#### TOCSettings()

Default table of contents settings.

##### Declaration

    public TOCSettings()

### Methods

#### Destroy()

##### Declaration

    public void Destroy()

#### Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

##### Declaration

    public void Dispose()

#### Dispose(bool)

##### Declaration

    protected virtual void Dispose(bool disposing)

##### Parameters

Type | Name | Description
--- | --- | ---
bool | disposing |

#### ~TOCSettings()

Releases all resources used by the TOCSettings

##### Declaration

    protected ~TOCSettings()

#### SetCaptionText(string)

Caption text to be used with TOC.

##### Declaration

    public void SetCaptionText(string caption)

##### Parameters

Type | Name | Description
--- | --- | ---
string | caption | Text that will appear with the table of contents.

##### Remarks

This option is deprecated in the latest HTML2PDF module and may have no effect.

#### SetDottedLines(bool)

Use a dotted line when creating TOC.

##### Declaration

    public void SetDottedLines(bool enable)

##### Parameters

Type | Name | Description
--- | --- | ---
bool | enable | Table of contents will use dotted lines.

##### Remarks

This option is deprecated in the latest HTML2PDF module and may have no effect.

#### SetLevelIndentation(int)

Indentation used for every TOC level...

##### Declaration

    public void SetLevelIndentation(int indentation)

##### Parameters

Type | Name | Description
--- | --- | ---
int | indentation | How much to indent each level, e.g. "2"

##### Remarks

This option is deprecated in the latest HTML2PDF module and may have no effect.

#### SetLinks(bool)

Create links from TOC to actual content.

##### Declaration

    public void SetLinks(bool enable)

##### Parameters

Type | Name | Description
--- | --- | ---
bool | enable | Entries in table of contents will link to section in the PDF.

##### Remarks

This option is deprecated in the latest HTML2PDF module and may have no effect.

#### SetTextSizeShrink(double)

How much to shrink font for every level, e.g. 0.8

##### Declaration

    public void SetTextSizeShrink(double shrink)

##### Parameters

Type | Name | Description
--- | --- | ---
double | shrink | Rate at which lower level entries will appear smaller

##### Remarks

This option is deprecated in the latest HTML2PDF module and may have no effect.

#### SetXsl(string)

xsl style sheet used to convert outline XML into a table of content.

##### Declaration

    public void SetXsl(string style_sheet)

##### Parameters

Type | Name | Description
--- | --- | ---
string | style_sheet | Path to xsl style sheet to be used to generate this table of contents.

##### Remarks

This option is deprecated in the latest HTML2PDF module and may have no effect.

### Implements

IDisposable