com.aspose.words

Class FieldToc

  • java.lang.Object
    • Field
      • 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
 
Property Getters/Setters Summary
java.lang.StringgetBookmarkName()
void
setBookmarkName(java.lang.Stringvalue)
           Gets or sets the name of the bookmark that marks the portion of the document used to build the table.
java.lang.StringgetCaptionlessTableOfFiguresLabel()
void
setCaptionlessTableOfFiguresLabel(java.lang.Stringvalue)
           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()
void
setCustomStyles(java.lang.Stringvalue)
           Gets or sets a list of styles other than the built-in heading styles to include in the table of contents.
FieldEndgetEnd()
Gets the node that represents the field end.
java.lang.StringgetEntryIdentifier()
void
setEntryIdentifier(java.lang.Stringvalue)
           Gets or sets a string that should match type identifiers of TC fields being included.
java.lang.StringgetEntryLevelRange()
void
setEntryLevelRange(java.lang.Stringvalue)
           Gets or sets a range of levels of the table of contents entries to be included.
java.lang.StringgetEntrySeparator()
void
setEntrySeparator(java.lang.Stringvalue)
           Gets or sets a sequence of characters that separate an entry and its page number.
FieldFormatgetFormat()
Gets a FieldFormat object that provides typed access to field's formatting.
java.lang.StringgetHeadingLevelRange()
void
setHeadingLevelRange(java.lang.Stringvalue)
           Gets or sets a range of heading levels to include.
booleangetHideInWebLayout()
void
setHideInWebLayout(booleanvalue)
           Gets or sets whether to hide tab leader and page numbers in Web layout view.
booleangetInsertHyperlinks()
void
setInsertHyperlinks(booleanvalue)
           Gets or sets whether to make the table of contents entries hyperlinks.
booleanisDirty()
void
isDirty(booleanvalue)
           Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
booleanisLocked()
void
isLocked(booleanvalue)
           Gets or sets whether the field is locked (should not recalculate its result).
booleanisPageNumberOmittingLevelRangeSpecified()
intgetLocaleId()
void
setLocaleId(intvalue)
           Gets or sets the LCID of the field.
java.lang.StringgetPageNumberOmittingLevelRange()
void
setPageNumberOmittingLevelRange(java.lang.Stringvalue)
           Gets or sets a range of levels of the table of contents entries from which to omits page numbers.
java.lang.StringgetPrefixedSequenceIdentifier()
void
setPrefixedSequenceIdentifier(java.lang.Stringvalue)
           Gets or sets the identifier of a sequence for which a prefix should be added to the entry's page number.
booleangetPreserveLineBreaks()
void
setPreserveLineBreaks(booleanvalue)
           Gets or sets whether to preserve newline characters within table entries.
booleangetPreserveTabs()
void
setPreserveTabs(booleanvalue)
           Gets or sets whether to preserve tab entries within table entries.
java.lang.StringgetResult()
void
setResult(java.lang.Stringvalue)
           Gets or sets text that is between the field separator and field end.
FieldSeparatorgetSeparator()
Gets the node that represents the field separator. Can be null.
java.lang.StringgetSequenceSeparator()
void
setSequenceSeparator(java.lang.Stringvalue)
           Gets or sets the character sequence that is used to separate sequence numbers and page numbers.
FieldStartgetStart()
Gets the node that represents the start of the field.
java.lang.StringgetTableOfFiguresLabel()
void
setTableOfFiguresLabel(java.lang.Stringvalue)
           Gets or sets the name of the sequence identifier used when building a table of figures.
intgetType()
Gets the Microsoft Word field type. The value of the property is FieldType integer constant.
booleangetUseParagraphOutlineLevel()
void
           Gets or sets whether to use the applied paragraph outline level.
 
Method Summary
java.lang.StringgetFieldCode()
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)
Returns text between field start and field separator (or field end if there is no separator).
Noderemove()
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()
Performs the field unlink.
voidupdate()
Performs the field update. Throws if the field is being updated already.
voidupdate(boolean ignoreMergeFormat)
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

        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

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

        Example:

        Shows how to formatting fields
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        Field field = builder.insertField("MERGEFIELD Date");
        
        FieldFormat format = field.getFormat();
        
        format.setDateTimeFormat("dddd, MMMM dd, yyyy");
        format.setNumericFormat("0.#");
        format.getGeneralFormats().add(GeneralFormat.CHAR_FORMAT);
      • 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

        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

        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

        public int getLocaleId() / public void setLocaleId(int value)
        
        Gets or sets the LCID of the field.

        Example:

        Get or sets locale for fields
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);
        
        Field field = builder.insertField("DATE \\* MERGEFORMAT");
        field.setLocaleId(2064);
        
        ByteArrayOutputStream dstStream = new ByteArrayOutputStream();
        doc.save(dstStream, SaveFormat.DOCX);
        
        Field newField = doc.getRange().getFields().get(0);
        Assert.assertEquals(newField.getLocaleId(), 2064);
        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

        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

        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

        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

        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

        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.

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

        Example:

        Shows how to get text between field start and field separator (or field end if there is no separator)
        Document doc = new Document(getMyDir() + "Field.FieldCode.docx");
        
        for (Field field : doc.getRange().getFields())
        {
            if (field.getType() == FieldType.FIELD_IF)
            {
                FieldIf fieldIf = (FieldIf) field;
        
                String fieldCode = fieldIf.getFieldCode();
        
                if (containsNestedFields)
                {
                    fieldCode = fieldIf.getFieldCode(true);
                } else
                {
                    fieldCode = fieldIf.getFieldCode(false);
                }
            }
        }
      • getFieldCode

        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.

        Example:

        Shows how to get text between field start and field separator (or field end if there is no separator)
        Document doc = new Document(getMyDir() + "Field.FieldCode.docx");
        
        for (Field field : doc.getRange().getFields())
        {
            if (field.getType() == FieldType.FIELD_IF)
            {
                FieldIf fieldIf = (FieldIf) field;
        
                String fieldCode = fieldIf.getFieldCode();
        
                if (containsNestedFields)
                {
                    fieldCode = fieldIf.getFieldCode(true);
                } else
                {
                    fieldCode = fieldIf.getFieldCode(false);
                }
            }
        }
      • remove

        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();
      • unlink

        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.

        Example:

        Shows how to unlink specific field
        Document doc = new Document(getMyDir() + "Field.UnlinkFields.docx");
        
        doc.getRange().getFields().get(1).unlink();
      • update

        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();
      • update

        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.

        Example:

        Shows a way to update a field ignoring the MERGEFORMAT switch
        LoadOptions loadOptions = new LoadOptions();
        loadOptions.setPreserveIncludePictureField(true);
        
        Document doc = new Document(getMyDir() + "Field.UpdateFieldIgnoringMergeFormat.docx", loadOptions);
        
        for (Field field : doc.getRange().getFields())
        {
            if (((field.getType()) == (FieldType.FIELD_INCLUDE_PICTURE)))
            {
                FieldIncludePicture includePicture = (FieldIncludePicture) field;
        
                includePicture.setSourceFullName(getMyDir() + "\\Images\\dotnet-logo.png");
                includePicture.update(true);
            }
        }
        
        doc.updateFields();
        doc.save(getMyDir() + "\\Artifacts\\Field.UpdateFieldIgnoringMergeFormat.docx");
      • 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.