com.aspose.words
Class FieldTC

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

public 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.

Constructor Summary
FieldTC()
          
 
Property Getters/Setters Summary
FieldEndgetEnd()→ inherited from Field
           Gets the node that represents the field end.
java.lang.StringgetEntryLevel()
voidsetEntryLevel(java.lang.String value)
           Gets or sets the level of the entry.
FieldFormatgetFormat()→ inherited from Field
           Gets a FieldFormat object that provides typed access to field's formatting.
booleanisLocked()→ inherited from Field
voidisLocked(boolean value)
           Gets or sets whether the field is locked (should not recalculate its result).
intgetLocaleId()→ inherited from Field
voidsetLocaleId(int value)
          
booleangetOmitPageNumber()
voidsetOmitPageNumber(boolean value)
           Gets or sets whether page number in TOC should be omitted for this field.
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.
FieldStartgetStart()→ inherited from Field
           Gets the node that represents the start of the field.
java.lang.StringgetText()
voidsetText(java.lang.String value)
           Gets or sets the text of the entry.
intgetType()→ inherited from Field
           Gets the Microsoft Word field type. The value of the property is FieldType integer constant.
java.lang.StringgetTypeIdentifier()
voidsetTypeIdentifier(java.lang.String value)
           Gets or sets a type identifier for this field (which is typically a letter).
 
Method Summary
java.lang.StringgetEntryTitle()
          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.typegetLabelRange()
          Reserved for internal use.
intgetLevel()
          Reserved for internal use.
Aspose.Words.ParagraphgetParagraph()
          Reserved for internal use.
aspose.obfuscated.typegetSwitchType(java.lang.String switchName)
          Reserved for internal use.
aspose.obfuscated.typeinsertBookmark(java.lang.String bookmarkName)
          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.
 

Constructor Detail

FieldTC

public FieldTC()

Property Getters/Setters Detail

getEnd

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

getEntryLevel/setEntryLevel

public java.lang.String getEntryLevel() / public void setEntryLevel(java.lang.String value)
Gets or sets the level of the entry.

getFormat

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

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

getLocaleId/setLocaleId

→ inherited from Field
public int getLocaleId() / public void setLocaleId(int value)

getOmitPageNumber/setOmitPageNumber

public boolean getOmitPageNumber() / public void setOmitPageNumber(boolean value)
Gets or sets whether page number in TOC should be omitted for this field.

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.

getStart

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

getText/setText

public java.lang.String getText() / public void setText(java.lang.String value)
Gets or sets the text of the entry.

getType

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

getTypeIdentifier/setTypeIdentifier

public java.lang.String getTypeIdentifier() / public void setTypeIdentifier(java.lang.String value)
Gets or sets a type identifier for this field (which is typically a letter).

Method Detail

getEntryTitle

public java.lang.String getEntryTitle()
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.

getLabelRange

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

getLevel

public int getLevel()
Reserved for internal use.

getParagraph

public Aspose.Words.Paragraph getParagraph()
Reserved for internal use.

getSwitchType

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

insertBookmark

public aspose.obfuscated.type insertBookmark(java.lang.String bookmarkName)
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.

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