com.aspose.words
Class FieldToc

java.lang.Object
  extended by Field
      extended by com.aspose.words.FieldToc

public class FieldToc 
extends Field

Implements the TOC field. Builds a table of contents (which can also be a table of figures) using the entries specified by TC fields, their heading levels, and specified styles, and inserts that table at this place in the document.

Constructor Summary
FieldToc()
          
 
Property Getters/Setters Summary
java.lang.StringgetBookmarkName()
voidsetBookmarkName(java.lang.String value)
           Gets or sets the name of the bookmark that marks the portion of the document used to build the table.
java.lang.StringgetCaptionlessTableOfFiguresLabel()
voidsetCaptionlessTableOfFiguresLabel(java.lang.String value)
           Gets or sets the name of the sequence identifier used when building a table of figures that does not include caption's label and number.
java.lang.StringgetCustomStyles()
voidsetCustomStyles(java.lang.String value)
           Gets or sets a list of styles other than the built-in heading styles to include in the table of contents.
FieldEndgetEnd()→ inherited from Field
           Gets the node that represents the field end.
java.lang.StringgetEntryIdentifier()
voidsetEntryIdentifier(java.lang.String value)
           Gets or sets a string that should match type identifiers of TC fields being included.
java.lang.StringgetEntryLevelRange()
voidsetEntryLevelRange(java.lang.String value)
           Gets or sets a range of levels of the table of contents entries to be included.
java.lang.StringgetEntrySeparator()
voidsetEntrySeparator(java.lang.String value)
           Gets or sets a sequence of characters that separate an entry and its page number.
FieldFormatgetFormat()→ inherited from Field
           Gets a FieldFormat object that provides typed access to field's formatting.
java.lang.StringgetHeadingLevelRange()
voidsetHeadingLevelRange(java.lang.String value)
           Gets or sets a range of heading levels to include.
booleangetHideInWebLayout()
voidsetHideInWebLayout(boolean value)
           Gets or sets whether to hide tab leader and page numbers in Web layout view.
booleangetInsertHyperlinks()
voidsetInsertHyperlinks(boolean value)
           Gets or sets whether to make the table of contents entries hyperlinks.
booleanisDirty()→ inherited from Field
voidisDirty(boolean value)
           Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
booleanisLocked()→ inherited from Field
voidisLocked(boolean value)
           Gets or sets whether the field is locked (should not recalculate its result).
booleanisPageNumberOmittingLevelRangeSpecified()
          
intgetLocaleId()→ inherited from Field
voidsetLocaleId(int value)
           Gets or sets the LCID of the field.
java.lang.StringgetPageNumberOmittingLevelRange()
voidsetPageNumberOmittingLevelRange(java.lang.String value)
           Gets or sets a range of levels of the table of contents entries from which to omits page numbers.
java.lang.StringgetPrefixedSequenceIdentifier()
voidsetPrefixedSequenceIdentifier(java.lang.String value)
           Gets or sets the identifier of a sequence for which a prefix should be added to the entry's page number.
booleangetPreserveLineBreaks()
voidsetPreserveLineBreaks(boolean value)
           Gets or sets whether to preserve newline characters within table entries.
booleangetPreserveTabs()
voidsetPreserveTabs(boolean value)
           Gets or sets whether to preserve tab entries within table entries.
java.lang.StringgetResult()→ inherited from Field
voidsetResult(java.lang.String value)
           Gets or sets text that is between the field separator and field end.
FieldSeparatorgetSeparator()→ inherited from Field
           Gets the node that represents the field separator. Can be null.
java.lang.StringgetSequenceSeparator()
voidsetSequenceSeparator(java.lang.String value)
           Gets or sets the character sequence that is used to separate sequence numbers and page numbers.
FieldStartgetStart()→ inherited from Field
           Gets the node that represents the start of the field.
java.lang.StringgetTableOfFiguresLabel()
voidsetTableOfFiguresLabel(java.lang.String value)
           Gets or sets the name of the sequence identifier used when building a table of figures.
intgetType()→ inherited from Field
           Gets the Microsoft Word field type. The value of the property is FieldType integer constant.
booleangetUseParagraphOutlineLevel()
voidsetUseParagraphOutlineLevel(boolean value)
           Gets or sets whether to use the applied paragraph outline level.
 
Method Summary
booleangetAreCustomStylesSpecified()
          Reserved for internal use.
java.lang.StringgetCaptionlessTableOfFiguresLabel()
          Reserved for internal use.
intgetEntryTypeCore()
          Reserved for internal use.
java.lang.StringgetFieldCode()→ inherited from Field
           Returns text between field start and field separator (or field end if there is no separator). Both field code and field result of child fields are included.
java.lang.StringgetFieldCode(boolean includeChildFieldCodes)→ inherited from Field
           Returns text between field start and field separator (or field end if there is no separator).
aspose.obfuscated.typegetHeadingLevelRangeParsed()
          Reserved for internal use.
booleangetIncludeTocEntryFields()
          Reserved for internal use.
intgetLevelForCustomStyle(Aspose.Words.Paragraph paragraph, aspose.obfuscated.type style)
          Reserved for internal use.
aspose.obfuscated.typegetRangeBookmark()
          Reserved for internal use.
booleangetSkipTables()
          Reserved for internal use.
aspose.obfuscated.typegetSwitchType(java.lang.String switchName)
          Reserved for internal use.
java.lang.StringgetTableOfFiguresLabel()
          Reserved for internal use.
aspose.obfuscated.typegetTocEntryLevelRange()
          Reserved for internal use.
booleangetUseParagraphOutlineLevel()
          Reserved for internal use.
booleanisBookmarkRangeSpecified()
          Reserved for internal use.
booleanisEntryLevelRangeSpecified()
          Reserved for internal use.
booleanisHeadingLevelRangeSpecified()
          Reserved for internal use.
booleanisTableOfFigures()
          Reserved for internal use.
Aspose.Words.Noderemove()→ inherited from Field
           Removes the field from the document. Returns a node right after the field. If the field's end is the last child of its parent node, returns its parent paragraph. If the field is already removed, returns null.
booleanunlink()→ inherited from Field
           Performs the field unlink.
voidupdate()→ inherited from Field
           Performs the field update. Throws if the field is being updated already.
voidupdate(boolean ignoreMergeFormat)→ inherited from Field
           Performs a field update. Throws if the field is being updated already.
booleanupdatePageNumbers()
           Updates the page numbers for items in this table of contents.
 

Constructor Detail

FieldToc

public FieldToc()

Property Getters/Setters Detail

getBookmarkName/setBookmarkName

public java.lang.String getBookmarkName() / public void setBookmarkName(java.lang.String value)
Gets or sets the name of the bookmark that marks the portion of the document used to build the table.

getCaptionlessTableOfFiguresLabel/setCaptionlessTableOfFiguresLabel

public java.lang.String getCaptionlessTableOfFiguresLabel() / public void setCaptionlessTableOfFiguresLabel(java.lang.String value)
Gets or sets the name of the sequence identifier used when building a table of figures that does not include caption's label and number.

getCustomStyles/setCustomStyles

public java.lang.String getCustomStyles() / public void setCustomStyles(java.lang.String value)
Gets or sets a list of styles other than the built-in heading styles to include in the table of contents.

getEnd

→ inherited from Field
public FieldEnd getEnd()
Gets the node that represents the field end.

getEntryIdentifier/setEntryIdentifier

public java.lang.String getEntryIdentifier() / public void setEntryIdentifier(java.lang.String value)
Gets or sets a string that should match type identifiers of TC fields being included.

getEntryLevelRange/setEntryLevelRange

public java.lang.String getEntryLevelRange() / public void setEntryLevelRange(java.lang.String value)
Gets or sets a range of levels of the table of contents entries to be included.

getEntrySeparator/setEntrySeparator

public java.lang.String getEntrySeparator() / public void setEntrySeparator(java.lang.String value)
Gets or sets a sequence of characters that separate an entry and its page number.

getFormat

→ inherited from Field
public FieldFormat getFormat()
Gets a FieldFormat object that provides typed access to field's formatting.

getHeadingLevelRange/setHeadingLevelRange

public java.lang.String getHeadingLevelRange() / public void setHeadingLevelRange(java.lang.String value)
Gets or sets a range of heading levels to include.

getHideInWebLayout/setHideInWebLayout

public boolean getHideInWebLayout() / public void setHideInWebLayout(boolean value)
Gets or sets whether to hide tab leader and page numbers in Web layout view.

getInsertHyperlinks/setInsertHyperlinks

public boolean getInsertHyperlinks() / public void setInsertHyperlinks(boolean value)
Gets or sets whether to make the table of contents entries hyperlinks.

isDirty/isDirty

→ inherited from Field
public boolean isDirty() / public void isDirty(boolean value)
Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.

isLocked/isLocked

→ inherited from Field
public boolean isLocked() / public void isLocked(boolean value)
Gets or sets whether the field is locked (should not recalculate its result).

isPageNumberOmittingLevelRangeSpecified

public boolean isPageNumberOmittingLevelRangeSpecified()

getLocaleId/setLocaleId

→ inherited from Field
public int getLocaleId() / public void setLocaleId(int value)
Gets or sets the LCID of the field.
See Also:
FieldUpdateCultureSource.FIELD_CODE

getPageNumberOmittingLevelRange/setPageNumberOmittingLevelRange

public java.lang.String getPageNumberOmittingLevelRange() / public void setPageNumberOmittingLevelRange(java.lang.String value)
Gets or sets a range of levels of the table of contents entries from which to omits page numbers.

getPrefixedSequenceIdentifier/setPrefixedSequenceIdentifier

public java.lang.String getPrefixedSequenceIdentifier() / public void setPrefixedSequenceIdentifier(java.lang.String value)
Gets or sets the identifier of a sequence for which a prefix should be added to the entry's page number.

getPreserveLineBreaks/setPreserveLineBreaks

public boolean getPreserveLineBreaks() / public void setPreserveLineBreaks(boolean value)
Gets or sets whether to preserve newline characters within table entries.

getPreserveTabs/setPreserveTabs

public boolean getPreserveTabs() / public void setPreserveTabs(boolean value)
Gets or sets whether to preserve tab entries within table entries.

getResult/setResult

→ inherited from Field
public java.lang.String getResult() / public void setResult(java.lang.String value)
Gets or sets text that is between the field separator and field end.

getSeparator

→ inherited from Field
public FieldSeparator getSeparator()
Gets the node that represents the field separator. Can be null.

getSequenceSeparator/setSequenceSeparator

public java.lang.String getSequenceSeparator() / public void setSequenceSeparator(java.lang.String value)
Gets or sets the character sequence that is used to separate sequence numbers and page numbers.

getStart

→ inherited from Field
public FieldStart getStart()
Gets the node that represents the start of the field.

getTableOfFiguresLabel/setTableOfFiguresLabel

public java.lang.String getTableOfFiguresLabel() / public void setTableOfFiguresLabel(java.lang.String value)
Gets or sets the name of the sequence identifier used when building a table of figures.

getType

→ inherited from Field
public int getType()
Gets the Microsoft Word field type. The value of the property is FieldType integer constant.

getUseParagraphOutlineLevel/setUseParagraphOutlineLevel

public boolean getUseParagraphOutlineLevel() / public void setUseParagraphOutlineLevel(boolean value)
Gets or sets whether to use the applied paragraph outline level.

Method Detail

getAreCustomStylesSpecified

public boolean getAreCustomStylesSpecified()
Reserved for internal use.

getCaptionlessTableOfFiguresLabel

public java.lang.String getCaptionlessTableOfFiguresLabel()
Reserved for internal use.

getEntryTypeCore

public int getEntryTypeCore()
Reserved for internal use.

getFieldCode

→ inherited from Field
public java.lang.String getFieldCode()
Returns text between field start and field separator (or field end if there is no separator). Both field code and field result of child fields are included.

getFieldCode

→ inherited from Field
public java.lang.String getFieldCode(boolean includeChildFieldCodes)
Returns text between field start and field separator (or field end if there is no separator).
Parameters:
includeChildFieldCodes - True if child field codes should be included.

getHeadingLevelRangeParsed

public aspose.obfuscated.type getHeadingLevelRangeParsed()
Reserved for internal use.

getIncludeTocEntryFields

public boolean getIncludeTocEntryFields()
Reserved for internal use.

getLevelForCustomStyle

public int getLevelForCustomStyle(Aspose.Words.Paragraph paragraph, aspose.obfuscated.type style)
Reserved for internal use.

getRangeBookmark

public aspose.obfuscated.type getRangeBookmark()
                     throws java.lang.Exception
Reserved for internal use.

getSkipTables

public boolean getSkipTables()
Reserved for internal use.

getSwitchType

public aspose.obfuscated.type getSwitchType(java.lang.String switchName)
Reserved for internal use.

getTableOfFiguresLabel

public java.lang.String getTableOfFiguresLabel()
Reserved for internal use.

getTocEntryLevelRange

public aspose.obfuscated.type getTocEntryLevelRange()
Reserved for internal use.

getUseParagraphOutlineLevel

public boolean getUseParagraphOutlineLevel()
Reserved for internal use.

isBookmarkRangeSpecified

public boolean isBookmarkRangeSpecified()
Reserved for internal use.

isEntryLevelRangeSpecified

public boolean isEntryLevelRangeSpecified()
Reserved for internal use.

isHeadingLevelRangeSpecified

public boolean isHeadingLevelRangeSpecified()
Reserved for internal use.

isTableOfFigures

public boolean isTableOfFigures()
Reserved for internal use.

remove

→ inherited from Field
public Aspose.Words.Node remove()
           throws java.lang.Exception
Removes the field from the document. Returns a node right after the field. If the field's end is the last child of its parent node, returns its parent paragraph. If the field is already removed, returns null.

unlink

→ inherited from Field
public boolean unlink()
              throws java.lang.Exception
Performs the field unlink.

Replaces the field with its most recent result.

Some fields, such as XE (Index Entry) fields and SEQ (Sequence) fields, cannot be unlinked.

Returns:
True if the field has been unlinked, otherwise false.

update

→ inherited from Field
public void update()
           throws java.lang.Exception
Performs the field update. Throws if the field is being updated already.

update

→ inherited from Field
public void update(boolean ignoreMergeFormat)
           throws java.lang.Exception
Performs a field update. Throws if the field is being updated already.
Parameters:
ignoreMergeFormat - If true then direct field result formatting is abandoned, regardless of the MERGEFORMAT switch, otherwise normal update is performed.

updatePageNumbers

public boolean updatePageNumbers()
                         throws java.lang.Exception
Updates the page numbers for items in this table of contents.
Returns:
True if the operation is successful. If any of the related TOC bookmarks was removed, false will be returned.

See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.