Foxit PDF SDK  9.1
FSTableOfContentsConfig Class Reference

Table border style: Solid.
More...

Inheritance diagram for FSTableOfContentsConfig:

Instance Methods

(void) - dealloc
 
(void *) - getCptr
 
(id) - init
 
(id) - initWithCptr:swigOwnCObject:
 
(id) - initWithTitle:bookmark_level_array:is_show_serial_number:include_toc_pages:
 Constructor, with parameter.
More...
 
(void) - set:bookmark_level_array:is_show_serial_number:include_toc_pages:
 Set value.
More...
 

Protected Attributes

BOOL swigCMemOwn
 
void * swigCPtr
 

Properties

FSInt32Arraybookmark_level_array
 A bookmark level array which is used to specify bookmarks to be used to generate "Table of Contents". For each element in input array, valid range : from 1 to(depth). depth is returned by function FSPDFDoc::getBookmarkLevelDepth. If input array is an empty array, that means all bookmarks are used to generate "Table of Contents".
More...
 
BOOL include_toc_pages
 YES means to include catalog page(s) in the calculation of pages number in the table of contents, while NO means to exclude catalog page(s) from the calculation of pages number in the table of contents.
More...
 
BOOL is_show_serial_number
 YES means to show the serial number in the table of contents, while NO means not to show the serial number.
More...
 
NSString * title
 Title for the table of contents. If this is an empty string, the default value "Table of Contents" will be used.
More...
 

Detailed Description

Table border style: Solid.

Table border style: Dashed.

This class represents the table of contents configuration.

Method Documentation

◆ dealloc

- (void) dealloc

◆ getCptr

- (void*) getCptr

◆ init

- (id) init

◆ initWithCptr:swigOwnCObject:

- (id) initWithCptr: (void *)  cptr
swigOwnCObject: (BOOL)  ownCObject 

◆ initWithTitle:bookmark_level_array:is_show_serial_number:include_toc_pages:

- (id) initWithTitle: (NSString *)  title
bookmark_level_array: (FSInt32Array*)  bookmark_level_array
is_show_serial_number: (BOOL)  is_show_serial_number
include_toc_pages: (BOOL)  include_toc_pages 

Constructor, with parameter.

Parameters
[in]titleTitle for the table of contents.
[in]bookmark_level_arrayA bookmark level array which is used to specify bookmarks to be used to generate "Table of Contents".
[in]is_show_serial_numberYES means to show the serial number in the table of contents, while NO means not to show the serial number.
[in]include_toc_pagesYES means to include catalog page(s) in the calculation of pages number in the table of contents, while NO means to exclude catalog page(s) from the calculation of pages number in the table of contents.

◆ set:bookmark_level_array:is_show_serial_number:include_toc_pages:

- (void) set: (NSString *)  title
bookmark_level_array: (FSInt32Array*)  bookmark_level_array
is_show_serial_number: (BOOL)  is_show_serial_number
include_toc_pages: (BOOL)  include_toc_pages 

Set value.

Parameters
[in]titleTitle for the table of contents.
[in]bookmark_level_arrayA bookmark level array which is used to specify bookmarks to be used to generate "Table of Contents".
[in]is_show_serial_numberYES means to show the serial number in the table of contents, while NO means not to show the serial number.
[in]include_toc_pagesYES means to include catalog page(s) in the calculation of pages number in the table of contents, while NO means to exclude catalog page(s) from the calculation of pages number in the table of contents.

@ return None.

Member Data Documentation

◆ swigCMemOwn

- (BOOL) swigCMemOwn
protected

◆ swigCPtr

- (void*) swigCPtr
protected

Property Documentation

◆ bookmark_level_array

- (FSInt32Array *) bookmark_level_array
readwritenonatomiccopy

A bookmark level array which is used to specify bookmarks to be used to generate "Table of Contents". For each element in input array, valid range : from 1 to(depth). depth is returned by function FSPDFDoc::getBookmarkLevelDepth. If input array is an empty array, that means all bookmarks are used to generate "Table of Contents".

◆ include_toc_pages

- (BOOL) include_toc_pages
readwritenonatomicassign

YES means to include catalog page(s) in the calculation of pages number in the table of contents, while NO means to exclude catalog page(s) from the calculation of pages number in the table of contents.

◆ is_show_serial_number

- (BOOL) is_show_serial_number
readwritenonatomicassign

YES means to show the serial number in the table of contents, while NO means not to show the serial number.

◆ title

- (NSString *) title
readwritenonatomiccopy

Title for the table of contents. If this is an empty string, the default value "Table of Contents" will be used.