com.aspose.words

Class FieldTC

java.lang.Object

com.aspose.words.Field

com.aspose.words.FieldTC

public final class FieldTC
extends Field

Implements the TC field. Defines the text and page number for a table of contents (including a table of figures) entry, which is used by a TOC field.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDocumentOutlineTitle()
java.lang.String	getEntryLevel() Gets the level of the entry.
int	getLevel()
boolean	getOmitPageNumber() Gets whether page number in TOC should be omitted for this field.
int	getPageNumber()
Paragraph	getParagraph()
int	getSequenceValue(java.lang.String sequenceIdentifier)
int	getSwitchType(java.lang.String switchName)
java.lang.String	getText() Gets the text of the entry.
java.lang.String	getTypeIdentifier() Gets a type identifier for this field (which is typically a letter).
boolean	hasBookmark()
boolean	isInFieldCode()
void	setEntryLevel(java.lang.String value) Sets the level of the entry.
void	setOmitPageNumber(boolean value) Sets whether page number in TOC should be omitted for this field.
void	setText(java.lang.String value) Sets the text of the entry.
void	setTypeIdentifier(java.lang.String value) Sets a type identifier for this field (which is typically a letter).

Methods inherited from class com.aspose.words.Field

getDisplayResult, getEnd, getFieldCode, getFieldCode, getFormat, getLocaleId, getResult, getSeparator, getStart, getType, isDirty, isDirty, isLocked, isLocked, needStoreOldResultNodes, remove, setLocaleId, setResult, unlink, update, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getSwitchType

public final int getSwitchType(java.lang.String switchName)

getText

public final java.lang.String getText()

Gets the text of the entry.

Returns:

The text of the entry.

setText

public final void setText(java.lang.String value)
                   throws java.lang.Exception

Sets the text of the entry.

Parameters:

value - The text of the entry.

Throws:

java.lang.Exception

getTypeIdentifier

public final java.lang.String getTypeIdentifier()

Gets a type identifier for this field (which is typically a letter).

Returns:

A type identifier for this field (which is typically a letter).

setTypeIdentifier

public final void setTypeIdentifier(java.lang.String value)
                             throws java.lang.Exception

Sets a type identifier for this field (which is typically a letter).

Parameters:

value - A type identifier for this field (which is typically a letter).

Throws:

java.lang.Exception

getEntryLevel

public final java.lang.String getEntryLevel()

Gets the level of the entry.

Returns:

The level of the entry.

setEntryLevel

public final void setEntryLevel(java.lang.String value)
                         throws java.lang.Exception

Sets the level of the entry.

Parameters:

value - The level of the entry.

Throws:

java.lang.Exception

getOmitPageNumber

public final boolean getOmitPageNumber()

Gets whether page number in TOC should be omitted for this field.

Returns:

Whether page number in TOC should be omitted for this field.

setOmitPageNumber

public final void setOmitPageNumber(boolean value)
                             throws java.lang.Exception

Sets whether page number in TOC should be omitted for this field.

Parameters:

value - Whether page number in TOC should be omitted for this field.

Throws:

java.lang.Exception

getParagraph

public final Paragraph getParagraph()

getLevel

public final int getLevel()

getDocumentOutlineTitle

public final java.lang.String getDocumentOutlineTitle()

isInFieldCode

public final boolean isInFieldCode()

hasBookmark

public final boolean hasBookmark()

getSequenceValue

public final int getSequenceValue(java.lang.String sequenceIdentifier)

getPageNumber

public final int getPageNumber()