tableofcontent-ag凯发旗舰厅

com.spire.doc.fields
class tableofcontent

java.lang.object
  com.spire.doc.ownerholder
      com.spire.doc.documents.xml.documentserializable
          com.spire.doc.documentobject
              com.spire.doc.documentbase
                  com.spire.doc.fields.paragraphbase
                      com.spire.doc.fields.tableofcontent

all implemented interfaces:

irunattrsource, idocumentobject, iparagraphbase

public class tableofcontent
extends paragraphbase

tableofcontent

public tableofcontent(idocument doc)

initializes a new instance of the tableofcontent class.

parameters:

doc - the doc.

tableofcontent

public tableofcontent(idocument doc,
                      java.lang.string switches)

initializes a new instance of the tableofcontent class.

parameters:

doc - the doc.

switches - the switches.

getuseabsolutepos

public boolean getuseabsolutepos()

setuseabsolutepos

public void setuseabsolutepos(boolean value)

getuseheadingstyles

public boolean getuseheadingstyles()

gets a value indicating whether to use default heading styles.

returns:

using the default heading styles or not

setuseheadingstyles

public void setuseheadingstyles(boolean value)

sets a value indicating whether to use default heading styles.

parameters:

value - if it uses heading styles, set to true.

getupperheadinglevel

public int getupperheadinglevel()

gets the ending heading level of the table of content. default value is 3.

returns:

the upper heading level.

setupperheadinglevel

public void setupperheadinglevel(int value)

sets the ending heading level of the table of content. default value is 3.

parameters:

value - the upper heading level.

getlowerheadinglevel

public int getlowerheadinglevel()

gets the starting heading level of the table of content. default value is 1

returns:

the starting heading level.

setlowerheadinglevel

public void setlowerheadinglevel(int value)

sets the starting heading level of the table of content. default value is 1

parameters:

value - the starting heading level.

getusetableentryfields

public boolean getusetableentryfields()

gets a value indicating whether to use table entry fields.default value is false.

returns:

using the table entry fields or not

setusetableentryfields

public void setusetableentryfields(boolean value)

sets a value indicating whether to use table entry fields.default value is false.

parameters:

value - if it uses table entry fields, set to true.

gettableid

public java.lang.string gettableid()

gets the table id.

returns:

the table id.

settableid

public void settableid(java.lang.string value)

sets the table id.

parameters:

value - the table id.

getrightalignpagenumbers

public boolean getrightalignpagenumbers()

gets a value indicating whether to show page numbers from right side. default value is true.

returns:

showing the page number from the right side or not

setrightalignpagenumbers

public void setrightalignpagenumbers(boolean value)

sets a value indicating whether to show page numbers from right side. default value is true.

parameters:

value - if right align of page numbers, set to true.

getincludepagenumbers

public boolean getincludepagenumbers()

gets a value indicating whether to show page numbers. default value is true.

returns:

showing the page numbers or not

setincludepagenumbers

public void setincludepagenumbers(boolean value)

sets a value indicating whether to show page numbers. default value is true.

parameters:

value - if it includes page numbers, set to true.

getusehyperlinks

public boolean getusehyperlinks()

gets a value indicating whether to use hyperlinks.default value is true.

returns:

using the hyperlinks or not

setusehyperlinks

public void setusehyperlinks(boolean value)

sets a value indicating whether to use hyperlinks.default value is true.

parameters:

value - if it uses hyperlinks, set to true.

getuseoutlinelevels

public boolean getuseoutlinelevels()

gets a value indicating whether use outline levels.default value is false.

returns:

using the outline levels or not

setuseoutlinelevels

public void setuseoutlinelevels(boolean value)

sets a value indicating whether use outline levels.default value is false.

parameters:

value - if it uses outline levels, set to true.

getdocumentobjecttype

public documentobjecttype getdocumentobjecttype()

gets the type of the document object.

specified by:

getdocumentobjecttype in interface idocumentobject

specified by:

getdocumentobjecttype in class documentobject

returns:

the type of the document object.

settoclevelstyle

public void settoclevelstyle(int levelnumber,
                             java.lang.string stylename)

sets the style for toc level.

parameters:

levelnumber - the level number.

stylename - name of the style.

gettoclevelstyle

public java.lang.string gettoclevelstyle(int levelnumber)

gets the style name for toc level.

parameters:

levelnumber - the level number.

returns:

the style name