java.lang.Object
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.
Property Getters/Setters Summary |
java.lang.String | getBookmarkName() | |
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.
|
FieldEnd | getEnd() | → inherited from Field |
|
Gets the node that represents the field end.
|
java.lang.String | getEntryCategory() | |
void | setEntryCategory(java.lang.String value) | |
|
Gets or sets the integral category for entries included in the table.
|
java.lang.String | getEntrySeparator() | |
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.
|
FieldFormat | getFormat() | → inherited from Field |
|
Gets a FieldFormat object that provides typed access to field's formatting.
|
boolean | isDirty() | → inherited from Field |
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.
|
boolean | isLocked() | → inherited from Field |
void | isLocked(boolean value) | |
|
Gets or sets whether the field is locked (should not recalculate its result).
|
int | getLocaleId() | → inherited from Field |
void | setLocaleId(int value) | |
|
Gets or sets the LCID of the field.
|
java.lang.String | getPageNumberListSeparator() | |
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.
|
java.lang.String | getPageRangeSeparator() | |
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.
|
boolean | getRemoveEntryFormatting() | |
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.
|
java.lang.String | getResult() | → inherited from Field |
void | setResult(java.lang.String value) | |
|
Gets or sets text that is between the field separator and field end.
|
FieldSeparator | getSeparator() | → inherited from Field |
|
Gets the node that represents the field separator. Can be null.
|
java.lang.String | getSequenceName() | |
void | setSequenceName(java.lang.String value) | |
|
Gets or sets the name of a sequence whose number is included with the page number.
|
java.lang.String | getSequenceSeparator() | |
void | setSequenceSeparator(java.lang.String value) | |
|
Gets or sets the character sequence that is used to separate sequence numbers and page numbers.
|
FieldStart | getStart() | → inherited from Field |
|
Gets the node that represents the start of the field.
|
int | getType() | → inherited from Field |
|
Gets the Microsoft Word field type.
The value of the property is FieldType integer constant. |
boolean | getUseHeading() | |
void | setUseHeading(boolean value) | |
|
Gets or sets whether to include the category heading for the entries in a table of authorities.
|
boolean | getUsePassim() | |
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 Summary |
java.lang.String | getFieldCode() | → 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.String | getFieldCode(boolean includeChildFieldCodes) | → inherited from Field |
Returns text between field start and field separator (or field end if there is no separator).
|
aspose.obfuscated.type | getSwitchType(java.lang.String switchName) | |
Reserved for internal use. |
Aspose.Words.Node | remove() | → 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.
|
boolean | unlink() | → inherited from Field |
Performs the field unlink.
|
void | update() | → inherited from Field |
Performs the field update. Throws if the field is being updated already.
|
void | update(boolean ignoreMergeFormat) | → inherited from Field |
Performs a field update. Throws if the field is being updated already.
|
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.
-
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.
-
Gets a FieldFormat object that provides typed access to field's formatting.
isDirty/isDirty | → inherited from Field |
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 | → 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)
|
-
Gets or sets the LCID of the field.
- See Also:
- FieldUpdateCultureSource.FIELD_CODE
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.
-
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.
-
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.
getUseHeading/setUseHeading | |
public boolean getUseHeading() / public void setUseHeading(boolean value)
|
-
Gets or sets whether to include the category heading for the entries in a table of authorities.
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.
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.
getSwitchType | |
public aspose.obfuscated.type getSwitchType(java.lang.String switchName) |
- 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.