FieldToa (Aspose.Words for Java API Reference)

java.lang.Object
- com.aspose.words.Field
- - 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.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getBookmarkName()` Gets the name of the bookmark that marks the portion of the document used to build the table.
`java.lang.String`	`getEntryCategory()` Gets the integral category for entries included in the table.
`java.lang.String`	`getEntrySeparator()` Gets the character sequence that is used to separate a table of authorities entry and its page number.
`java.lang.String`	`getPageNumberListSeparator()` Gets the character sequence that is used to separate two page numbers in a page number list.
`java.lang.String`	`getPageRangeSeparator()` Gets the character sequence that is used to separate the start and end of a page range.
`boolean`	`getRemoveEntryFormatting()` Gets whether to remove the formatting of the entry text in the document from the entry in the table of authorities.
`java.lang.String`	`getSequenceName()` Gets the name of a sequence whose number is included with the page number.
`java.lang.String`	`getSequenceSeparator()` Gets the character sequence that is used to separate sequence numbers and page numbers.
`int`	`getSwitchType(java.lang.String switchName)`
`boolean`	`getUseHeading()` Gets whether to include the category heading for the entries in a table of authorities.
`boolean`	`getUsePassim()` Gets 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.
`void`	`setBookmarkName(java.lang.String value)` Sets the name of the bookmark that marks the portion of the document used to build the table.
`void`	`setEntryCategory(java.lang.String value)` Sets the integral category for entries included in the table.
`void`	`setEntrySeparator(java.lang.String value)` Sets the character sequence that is used to separate a table of authorities entry and its page number.
`void`	`setPageNumberListSeparator(java.lang.String value)` Sets the character sequence that is used to separate two page numbers in a page number list.
`void`	`setPageRangeSeparator(java.lang.String value)` Sets the character sequence that is used to separate the start and end of a page range.
`void`	`setRemoveEntryFormatting(boolean value)` Sets whether to remove the formatting of the entry text in the document from the entry in the table of authorities.
`void`	`setSequenceName(java.lang.String value)` Sets the name of a sequence whose number is included with the page number.
`void`	`setSequenceSeparator(java.lang.String value)` Sets the character sequence that is used to separate sequence numbers and page numbers.
`void`	`setUseHeading(boolean value)` Sets whether to include the category heading for the entries in a table of authorities.
`void`	`setUsePassim(boolean value)` 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.

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 int getSwitchType(java.lang.String switchName)
```
  - getBookmarkName
```
public java.lang.String getBookmarkName()
```
    Gets the name of the bookmark that marks the portion of the document used to build the table.
    
    Returns:
    
    The name of the bookmark that marks the portion of the document used to build the table.
  - setBookmarkName
```
public void setBookmarkName(java.lang.String value)
                     throws java.lang.Exception
```
    Sets the name of the bookmark that marks the portion of the document used to build the table.
    
    Parameters:
    
    value - The name of the bookmark that marks the portion of the document used to build the table.
    
    Throws:
    
    java.lang.Exception
  - getEntryCategory
```
public java.lang.String getEntryCategory()
```
    Gets the integral category for entries included in the table.
    
    Returns:
    
    The integral category for entries included in the table.
  - setEntryCategory
```
public void setEntryCategory(java.lang.String value)
                      throws java.lang.Exception
```
    Sets the integral category for entries included in the table.
    
    Parameters:
    
    value - The integral category for entries included in the table.
    
    Throws:
    
    java.lang.Exception
  - getSequenceSeparator
```
public java.lang.String getSequenceSeparator()
```
    Gets the character sequence that is used to separate sequence numbers and page numbers.
    
    Returns:
    
    The character sequence that is used to separate sequence numbers and page numbers.
  - setSequenceSeparator
```
public void setSequenceSeparator(java.lang.String value)
                          throws java.lang.Exception
```
    Sets the character sequence that is used to separate sequence numbers and page numbers.
    
    Parameters:
    
    value - The character sequence that is used to separate sequence numbers and page numbers.
    
    Throws:
    
    java.lang.Exception
  - getEntrySeparator
```
public java.lang.String getEntrySeparator()
```
    Gets the character sequence that is used to separate a table of authorities entry and its page number.
    
    Returns:
    
    The character sequence that is used to separate a table of authorities entry and its page number.
  - setEntrySeparator
```
public void setEntrySeparator(java.lang.String value)
                       throws java.lang.Exception
```
    Sets the character sequence that is used to separate a table of authorities entry and its page number.
    
    Parameters:
    
    value - The character sequence that is used to separate a table of authorities entry and its page number.
    
    Throws:
    
    java.lang.Exception
  - getRemoveEntryFormatting
```
public boolean getRemoveEntryFormatting()
```
    Gets whether to remove the formatting of the entry text in the document from the entry in the table of authorities.
    
    Returns:
    
    Whether to remove the formatting of the entry text in the document from the entry in the table of authorities.
  - setRemoveEntryFormatting
```
public void setRemoveEntryFormatting(boolean value)
                              throws java.lang.Exception
```
    Sets whether to remove the formatting of the entry text in the document from the entry in the table of authorities.
    
    Parameters:
    
    value - Whether to remove the formatting of the entry text in the document from the entry in the table of authorities.
    
    Throws:
    
    java.lang.Exception
  - getPageRangeSeparator
```
public java.lang.String getPageRangeSeparator()
```
    Gets the character sequence that is used to separate the start and end of a page range.
    
    Returns:
    
    The character sequence that is used to separate the start and end of a page range.
  - setPageRangeSeparator
```
public void setPageRangeSeparator(java.lang.String value)
                           throws java.lang.Exception
```
    Sets the character sequence that is used to separate the start and end of a page range.
    
    Parameters:
    
    value - The character sequence that is used to separate the start and end of a page range.
    
    Throws:
    
    java.lang.Exception
  - getUseHeading
```
public boolean getUseHeading()
```
    Gets whether to include the category heading for the entries in a table of authorities.
    
    Returns:
    
    Whether to include the category heading for the entries in a table of authorities.
  - setUseHeading
```
public void setUseHeading(boolean value)
                   throws java.lang.Exception
```
    Sets whether to include the category heading for the entries in a table of authorities.
    
    Parameters:
    
    value - Whether to include the category heading for the entries in a table of authorities.
    
    Throws:
    
    java.lang.Exception
  - getPageNumberListSeparator
```
public java.lang.String getPageNumberListSeparator()
```
    Gets the character sequence that is used to separate two page numbers in a page number list.
    
    Returns:
    
    The character sequence that is used to separate two page numbers in a page number list.
  - setPageNumberListSeparator
```
public void setPageNumberListSeparator(java.lang.String value)
                                throws java.lang.Exception
```
    Sets the character sequence that is used to separate two page numbers in a page number list.
    
    Parameters:
    
    value - The character sequence that is used to separate two page numbers in a page number list.
    
    Throws:
    
    java.lang.Exception
  - getUsePassim
```
public boolean getUsePassim()
```
    Gets 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.
    
    Returns:
    
    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.
  - setUsePassim
```
public void setUsePassim(boolean value)
                  throws java.lang.Exception
```
    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.
    
    Parameters:
    
    value - 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.
    
    Throws:
    
    java.lang.Exception
  - getSequenceName
```
public java.lang.String getSequenceName()
```
    Gets the name of a sequence whose number is included with the page number.
    
    Returns:
    
    The name of a sequence whose number is included with the page number.
  - setSequenceName
```
public void setSequenceName(java.lang.String value)
                     throws java.lang.Exception
```
    Sets the name of a sequence whose number is included with the page number.
    
    Parameters:
    
    value - The name of a sequence whose number is included with the page number.
    
    Throws:
    
    java.lang.Exception

Class FieldToa

Method Summary

Methods inherited from class com.aspose.words.Field

Methods inherited from class java.lang.Object

Method Detail

getSwitchType

getBookmarkName

setBookmarkName

getEntryCategory

setEntryCategory

getSequenceSeparator

setSequenceSeparator

getEntrySeparator

setEntrySeparator

getRemoveEntryFormatting

setRemoveEntryFormatting

getPageRangeSeparator

setPageRangeSeparator

getUseHeading

setUseHeading

getPageNumberListSeparator

setPageNumberListSeparator

getUsePassim

setUsePassim

getSequenceName

setSequenceName