com.aspose.words

Class FieldTA

java.lang.Object

com.aspose.words.Field

com.aspose.words.FieldTA

public class FieldTA
extends Field

Implements the TA field. Defines the text and page number for a table of authorities entry, which is used by a TOA field.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getEntryCategory() Gets the integral entry category, which is a number that corresponds to the order of categories.
java.lang.String	getLongCitation() Gets the long citation for the entry.
java.lang.String	getPageRangeBookmarkName() Gets the name of the bookmark that marks a range of pages that is inserted as the entry's page number.
java.lang.String	getShortCitation() Gets the short citation for the entry.
int	getSwitchType(java.lang.String switchName)
boolean	isBold() Gets whether to apply bold formatting to the page number for the entry.
void	isBold(boolean value) Sets whether to apply bold formatting to the page number for the entry.
boolean	isItalic() Gets whether to apply italic formatting to the page number for the entry.
void	isItalic(boolean value) Sets whether to apply italic formatting to the page number for the entry.
void	setEntryCategory(java.lang.String value) Sets the integral entry category, which is a number that corresponds to the order of categories.
void	setLongCitation(java.lang.String value) Sets the long citation for the entry.
void	setPageRangeBookmarkName(java.lang.String value) Sets the name of the bookmark that marks a range of pages that is inserted as the entry's page number.
void	setShortCitation(java.lang.String value) Sets the short citation for the entry.

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

isBold

public boolean isBold()

Gets whether to apply bold formatting to the page number for the entry.

Returns:

Whether to apply bold formatting to the page number for the entry.

isBold

public void isBold(boolean value)
            throws java.lang.Exception

Sets whether to apply bold formatting to the page number for the entry.

Parameters:

value - Whether to apply bold formatting to the page number for the entry.

Throws:

java.lang.Exception

getEntryCategory

public java.lang.String getEntryCategory()

Gets the integral entry category, which is a number that corresponds to the order of categories.

Returns:

The integral entry category, which is a number that corresponds to the order of categories.

setEntryCategory

public void setEntryCategory(java.lang.String value)
                      throws java.lang.Exception

Sets the integral entry category, which is a number that corresponds to the order of categories.

Parameters:

value - The integral entry category, which is a number that corresponds to the order of categories.

Throws:

java.lang.Exception

isItalic

public boolean isItalic()

Gets whether to apply italic formatting to the page number for the entry.

Returns:

Whether to apply italic formatting to the page number for the entry.

isItalic

public void isItalic(boolean value)
              throws java.lang.Exception

Sets whether to apply italic formatting to the page number for the entry.

Parameters:

value - Whether to apply italic formatting to the page number for the entry.

Throws:

java.lang.Exception

getLongCitation

public java.lang.String getLongCitation()

Gets the long citation for the entry.

Returns:

The long citation for the entry.

setLongCitation

public void setLongCitation(java.lang.String value)
                     throws java.lang.Exception

Sets the long citation for the entry.

Parameters:

value - The long citation for the entry.

Throws:

java.lang.Exception

getPageRangeBookmarkName

public java.lang.String getPageRangeBookmarkName()

Gets the name of the bookmark that marks a range of pages that is inserted as the entry's page number.

Returns:

The name of the bookmark that marks a range of pages that is inserted as the entry's page number.

setPageRangeBookmarkName

public void setPageRangeBookmarkName(java.lang.String value)
                              throws java.lang.Exception

Sets the name of the bookmark that marks a range of pages that is inserted as the entry's page number.

Parameters:

value - The name of the bookmark that marks a range of pages that is inserted as the entry's page number.

Throws:

java.lang.Exception

getShortCitation

public java.lang.String getShortCitation()

Gets the short citation for the entry.

Returns:

The short citation for the entry.

setShortCitation

public void setShortCitation(java.lang.String value)
                      throws java.lang.Exception

Sets the short citation for the entry.

Parameters:

value - The short citation for the entry.

Throws:

java.lang.Exception

getSwitchType

public int getSwitchType(java.lang.String switchName)