com.aspose.words
Class FieldToa

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

public class FieldToa 
extends Field

Implements the TOA field. Builds a table of authorities (that is, a list of the references in a legal document, such as references to cases, statutes, and rules, along with the numbers of the pages on which the references appear) using the entries specified by TA fields.

Constructor Summary
FieldToa()
          
 
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.
FieldEndgetEnd()→ inherited from Field
           Gets the node that represents the field end.
java.lang.StringgetEntryCategory()
voidsetEntryCategory(java.lang.String value)
           Gets or sets the integral category for entries included in the table.
java.lang.StringgetEntrySeparator()
voidsetEntrySeparator(java.lang.String value)
           Gets or sets the character sequence that is used to separate a table of authorities entry and its page number.
FieldFormatgetFormat()→ inherited from Field
           Gets a FieldFormat object that provides typed access to field's formatting.
java.lang.StringgetHeading()
voidsetHeading(java.lang.String value)
           Gets or sets a category heading for the entries in a table of authorities.
booleanisLocked()→ inherited from Field
voidisLocked(boolean value)
           Gets or sets whether the field is locked (should not recalculate its result).
java.lang.StringgetPageNumberListSeparator()
voidsetPageNumberListSeparator(java.lang.String value)
           Gets or sets the character sequence that is used to separate two page numbers in a page number list.
java.lang.StringgetPageRangeSeparator()
voidsetPageRangeSeparator(java.lang.String value)
           Gets or sets the character sequence that is used to separate the start and end of a page range.
booleangetRemoveEntryFormatting()
voidsetRemoveEntryFormatting(boolean value)
           Gets or sets whether to remove the formatting of the entry text in the document from the entry in the table of authorities.
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.StringgetSequenceName()
voidsetSequenceName(java.lang.String value)
           Gets or sets the name of a sequence whose number is included with the page number.
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.
intgetType()→ inherited from Field
           Gets the Microsoft Word field type. The value of the property is FieldType integer constant.
booleangetUsePassim()
voidsetUsePassim(boolean value)
           Gets or sets whether to replace five or more different page references to the same authority with "passim", which is used to indicate that a word or passage occurs frequently in the work cited.
 
Method Summary
java.lang.StringgetFieldCode()→ inherited from Field
           Returns text between field start and field separator (or field end if there is no separator).
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.
 

Constructor Detail

FieldToa

public FieldToa()

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.

getEnd

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

getEntryCategory/setEntryCategory

public java.lang.String getEntryCategory() / public void setEntryCategory(java.lang.String value)
Gets or sets the integral category for entries included in the table.

getEntrySeparator/setEntrySeparator

public java.lang.String getEntrySeparator() / public void setEntrySeparator(java.lang.String value)
Gets or sets the character sequence that is used to separate a table of authorities entry and its page number.

getFormat

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

getHeading/setHeading

public java.lang.String getHeading() / public void setHeading(java.lang.String value)
Gets or sets a category heading for the entries in a table of authorities.

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

getPageNumberListSeparator/setPageNumberListSeparator

public java.lang.String getPageNumberListSeparator() / public void setPageNumberListSeparator(java.lang.String value)
Gets or sets the character sequence that is used to separate two page numbers in a page number list.

getPageRangeSeparator/setPageRangeSeparator

public java.lang.String getPageRangeSeparator() / public void setPageRangeSeparator(java.lang.String value)
Gets or sets the character sequence that is used to separate the start and end of a page range.

getRemoveEntryFormatting/setRemoveEntryFormatting

public boolean getRemoveEntryFormatting() / public void setRemoveEntryFormatting(boolean value)
Gets or sets whether to remove the formatting of the entry text in the document from the entry in the table of authorities.

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.

getSequenceName/setSequenceName

public java.lang.String getSequenceName() / public void setSequenceName(java.lang.String value)
Gets or sets the name of a sequence whose number is included with the page number.

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.

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

getUsePassim/setUsePassim

public boolean getUsePassim() / public void setUsePassim(boolean value)
Gets or sets whether to replace five or more different page references to the same authority with "passim", which is used to indicate that a word or passage occurs frequently in the work cited.

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

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

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