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
booleangetAreCustomStylesSpecified()
          
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.
intgetEntryTypeCore()
           Gets an internal value that should match type identifiers of TC fields being included.
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.
booleangetIncludeTocEntryFields()
           Gets whether to include TC fields in TOC.
booleangetInsertHyperlinks()
voidsetInsertHyperlinks(boolean value)
           Gets or sets whether to make the table of contents entries hyperlinks.
booleanisBookmarkRangeSpecified()
          
booleanisEntryLevelRangeSpecified()
          
booleanisHeadingLevelRangeSpecified()
          
booleanisLocked()→ inherited from Field
voidisLocked(boolean value)
           Gets or sets whether the field is locked (should not recalculate its result).
booleanisPageNumberOmittingLevelRangeSpecified()
          
booleanisTableOfFigures()
          
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
java.lang.StringgetFieldCode()→ inherited from Field
           Returns text between field start and field separator (or field end if there is no separator).
intgetLevelForCustomStyle(java.lang.String styleName)
           Returns a level for a custom style specified in the \t switch argument or -1 if the style is missing.
BookmarkgetRangeBookmark()
           Makes a Bookmark object for a bookmark name in \\b switch argument.
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.
voidupdate()→ inherited from Field
           Performs the 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

getAreCustomStylesSpecified

public boolean getAreCustomStylesSpecified()

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.

getEntryTypeCore

public int getEntryTypeCore()
Gets an internal value that should match type identifiers of TC fields being included.

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.

getIncludeTocEntryFields

public boolean getIncludeTocEntryFields()
Gets whether to include TC fields in TOC.

getInsertHyperlinks/setInsertHyperlinks

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

isBookmarkRangeSpecified

public boolean isBookmarkRangeSpecified()

isEntryLevelRangeSpecified

public boolean isEntryLevelRangeSpecified()

isHeadingLevelRangeSpecified

public boolean isHeadingLevelRangeSpecified()

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

isTableOfFigures

public boolean isTableOfFigures()

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.

Example:

Inserts a field into a document using DocumentBuilder.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Insert a simple Date field into the document.
// When we insert a field through the DocumentBuilder class we can get the
// special Field object which contains information about the field.
Field dateField = builder.insertField("DATE \\* MERGEFORMAT");

// Update this particular field in the document so we can get the FieldResult.
dateField.update();

// Display some information from this field.
// The field result is where the last evaluated value is stored. This is what is displayed in the document
// When field codes are not showing.
System.out.println(MessageFormat.format("FieldResult: {0}", dateField.getResult()));

// Display the field code which defines the behaviour of the field. This can been seen in Microsoft Word by pressing ALT+F9.
System.out.println(MessageFormat.format("FieldCode: {0}", dateField.getFieldCode()));

// The field type defines what type of field in the Document this is. In this case the type is "FieldDate"
System.out.println(MessageFormat.format("FieldType: {0}", dateField.getType()));

// Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object.
dateField.remove();

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.

Example:

Inserts a field into a document using DocumentBuilder.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Insert a simple Date field into the document.
// When we insert a field through the DocumentBuilder class we can get the
// special Field object which contains information about the field.
Field dateField = builder.insertField("DATE \\* MERGEFORMAT");

// Update this particular field in the document so we can get the FieldResult.
dateField.update();

// Display some information from this field.
// The field result is where the last evaluated value is stored. This is what is displayed in the document
// When field codes are not showing.
System.out.println(MessageFormat.format("FieldResult: {0}", dateField.getResult()));

// Display the field code which defines the behaviour of the field. This can been seen in Microsoft Word by pressing ALT+F9.
System.out.println(MessageFormat.format("FieldCode: {0}", dateField.getFieldCode()));

// The field type defines what type of field in the Document this is. In this case the type is "FieldDate"
System.out.println(MessageFormat.format("FieldType: {0}", dateField.getType()));

// Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object.
dateField.remove();

getUseParagraphOutlineLevel/setUseParagraphOutlineLevel

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

Method Detail

getFieldCode

→ inherited from Field
public java.lang.String getFieldCode()
                   throws java.lang.Exception
Returns text between field start and field separator (or field end if there is no separator).

Example:

Inserts a field into a document using DocumentBuilder.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Insert a simple Date field into the document.
// When we insert a field through the DocumentBuilder class we can get the
// special Field object which contains information about the field.
Field dateField = builder.insertField("DATE \\* MERGEFORMAT");

// Update this particular field in the document so we can get the FieldResult.
dateField.update();

// Display some information from this field.
// The field result is where the last evaluated value is stored. This is what is displayed in the document
// When field codes are not showing.
System.out.println(MessageFormat.format("FieldResult: {0}", dateField.getResult()));

// Display the field code which defines the behaviour of the field. This can been seen in Microsoft Word by pressing ALT+F9.
System.out.println(MessageFormat.format("FieldCode: {0}", dateField.getFieldCode()));

// The field type defines what type of field in the Document this is. In this case the type is "FieldDate"
System.out.println(MessageFormat.format("FieldType: {0}", dateField.getType()));

// Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object.
dateField.remove();

getLevelForCustomStyle

public int getLevelForCustomStyle(java.lang.String styleName)
Returns a level for a custom style specified in the \t switch argument or -1 if the style is missing.
Parameters:
styleName -
Returns:

getRangeBookmark

public Bookmark getRangeBookmark()
                         throws java.lang.Exception
Makes a Bookmark object for a bookmark name in \\b switch argument.
Returns:
null if a valid bookmark can not be found.

remove

→ inherited from Field
public 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.

Example:

Inserts a field into a document using DocumentBuilder.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Insert a simple Date field into the document.
// When we insert a field through the DocumentBuilder class we can get the
// special Field object which contains information about the field.
Field dateField = builder.insertField("DATE \\* MERGEFORMAT");

// Update this particular field in the document so we can get the FieldResult.
dateField.update();

// Display some information from this field.
// The field result is where the last evaluated value is stored. This is what is displayed in the document
// When field codes are not showing.
System.out.println(MessageFormat.format("FieldResult: {0}", dateField.getResult()));

// Display the field code which defines the behaviour of the field. This can been seen in Microsoft Word by pressing ALT+F9.
System.out.println(MessageFormat.format("FieldCode: {0}", dateField.getFieldCode()));

// The field type defines what type of field in the Document this is. In this case the type is "FieldDate"
System.out.println(MessageFormat.format("FieldType: {0}", dateField.getType()));

// Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object.
dateField.remove();

update

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

Example:

Inserts a field into a document using DocumentBuilder.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Insert a simple Date field into the document.
// When we insert a field through the DocumentBuilder class we can get the
// special Field object which contains information about the field.
Field dateField = builder.insertField("DATE \\* MERGEFORMAT");

// Update this particular field in the document so we can get the FieldResult.
dateField.update();

// Display some information from this field.
// The field result is where the last evaluated value is stored. This is what is displayed in the document
// When field codes are not showing.
System.out.println(MessageFormat.format("FieldResult: {0}", dateField.getResult()));

// Display the field code which defines the behaviour of the field. This can been seen in Microsoft Word by pressing ALT+F9.
System.out.println(MessageFormat.format("FieldCode: {0}", dateField.getFieldCode()));

// The field type defines what type of field in the Document this is. In this case the type is "FieldDate"
System.out.println(MessageFormat.format("FieldType: {0}", dateField.getType()));

// Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object.
dateField.remove();

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.