com.aspose.words

Class FieldXE

java.lang.Object

com.aspose.words.Field

com.aspose.words.FieldXE

public class FieldXE
extends Field

Implements the XE field. Defines the text and page number for an index entry, which is used by an INDEX field.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getEntryType() Gets an index entry type.
java.lang.String	getPageNumberReplacement() Gets text used in place of a page number.
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.
int	getSwitchType(java.lang.String switchName)
java.lang.String	getText() Gets the text of the entry.
java.lang.String	getYomi() Gets the yomi (first phonetic character for sorting indexes) for the index entry
boolean	isBold() Gets whether to apply bold formatting to the entry's page number.
void	isBold(boolean value) Sets whether to apply bold formatting to the entry's page number.
boolean	isItalic() Gets whether to apply italic formatting to the entry's page number.
void	isItalic(boolean value) Sets whether to apply italic formatting to the entry's page number.
void	setEntryType(java.lang.String value) Sets an index entry type.
void	setPageNumberReplacement(java.lang.String value) Sets text used in place of a page number.
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	setText(java.lang.String value) Sets the text of the entry.
void	setYomi(java.lang.String value) Sets the yomi (first phonetic character for sorting indexes) for the index 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

getSwitchType

public int getSwitchType(java.lang.String switchName)

getText

public java.lang.String getText()

Gets the text of the entry.

Returns:

The text of the entry.

setText

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

Sets the text of the entry.

Parameters:

value - The text of the entry.

Throws:

java.lang.Exception

isBold

public boolean isBold()

Gets whether to apply bold formatting to the entry's page number.

Returns:

Whether to apply bold formatting to the entry's page number.

isBold

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

Sets whether to apply bold formatting to the entry's page number.

Parameters:

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

Throws:

java.lang.Exception

getEntryType

public java.lang.String getEntryType()

Gets an index entry type.

Returns:

An index entry type.

setEntryType

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

Sets an index entry type.

Parameters:

value - An index entry type.

Throws:

java.lang.Exception

isItalic

public boolean isItalic()

Gets whether to apply italic formatting to the entry's page number.

Returns:

Whether to apply italic formatting to the entry's page number.

isItalic

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

Sets whether to apply italic formatting to the entry's page number.

Parameters:

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

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

getPageNumberReplacement

public java.lang.String getPageNumberReplacement()

Gets text used in place of a page number.

Returns:

Text used in place of a page number.

setPageNumberReplacement

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

Sets text used in place of a page number.

Parameters:

value - Text used in place of a page number.

Throws:

java.lang.Exception

getYomi

public java.lang.String getYomi()

Gets the yomi (first phonetic character for sorting indexes) for the index entry

Returns:

The yomi (first phonetic character for sorting indexes) for the index entry

setYomi

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

Sets the yomi (first phonetic character for sorting indexes) for the index entry

Parameters:

value - The yomi (first phonetic character for sorting indexes) for the index entry

Throws:

java.lang.Exception