Class HTML2PDF.TOCSettings

Inheritance

System.Object

HTML2PDF.TOCSettings

Implements

System.IDisposable

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: pdftron.PDF

Assembly: PDFTronDotNet.dll

Syntax

public class 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()

Declaration

public void Dispose()

Dispose(Boolean)

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
System.Boolean	disposing

Finalize()

Releases all resources used by the TOCSettings

Declaration

protected void Finalize()

SetCaptionText(String)

Caption text to be used with TOC.

Declaration

public void SetCaptionText(string caption)

Parameters

Type	Name	Description
System.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(Boolean)

Use a dotted line when creating TOC.

Declaration

public void SetDottedLines(bool enable)

Parameters

Type	Name	Description
System.Boolean	enable	Table of contents will use dotted lines.

Remarks

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

SetLevelIndentation(Int32)

Indentation used for every TOC level...

Declaration

public void SetLevelIndentation(int indentation)

Parameters

Type	Name	Description
System.Int32	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(Boolean)

Create links from TOC to actual content.

Declaration

public void SetLinks(bool enable)

Parameters

Type	Name	Description
System.Boolean	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
System.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
System.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

System.IDisposable