com.aspose.words

Class FieldIndex

java.lang.Object

com.aspose.words.Field

com.aspose.words.FieldIndex

public class FieldIndex
extends Field

Implements the INDEX field. Builds an index using the index entries specified by XE fields, and inserts that index at this place in the document.

Method Summary

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 index.
java.lang.String	getCrossReferenceSeparator() Gets the character sequence that is used to separate cross references and other entries.
java.lang.String	getEntryType() Gets an index entry type used to build the index.
java.lang.String	getHeading() Gets a heading that appears at the start of each set of entries for any given letter.
java.lang.String	getLanguageId() Gets the language ID used to generate the index.
java.lang.String	getLetterRange() Gets a range of letters to which limit the index.
java.lang.String	getNumberOfColumns() Gets the number of columns per page used when building the index.
java.lang.String	getPageNumberListSeparator() Gets the character sequence that is used to separate two page numbers in a page number list.
java.lang.String	getPageNumberSeparator() Gets the character sequence that is used to separate an index entry and its page number.
java.lang.String	getPageRangeSeparator() Gets the character sequence that is used to separate the start and end of a page range.
boolean	getRunSubentriesOnSameLine() Gets whether run subentries into the same line as the main entry.
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	getUseYomi() Gets whether to enable the use of yomi text for index entries.
boolean	hasPageNumberSeparator() Gets a value indicating whether a page number separator is overridden through the field's code.
boolean	hasSequenceName() Gets a value indicating whether a sequence should be used while the field's result building.
void	setBookmarkName(java.lang.String value) Sets the name of the bookmark that marks the portion of the document used to build the index.
void	setCrossReferenceSeparator(java.lang.String value) Sets the character sequence that is used to separate cross references and other entries.
void	setEntryType(java.lang.String value) Sets an index entry type used to build the index.
void	setHeading(java.lang.String value) Sets a heading that appears at the start of each set of entries for any given letter.
void	setLanguageId(java.lang.String value) Sets the language ID used to generate the index.
void	setLetterRange(java.lang.String value) Sets a range of letters to which limit the index.
void	setNumberOfColumns(java.lang.String value) Sets the number of columns per page used when building the index.
void	setPageNumberListSeparator(java.lang.String value) Sets the character sequence that is used to separate two page numbers in a page number list.
void	setPageNumberSeparator(java.lang.String value) Sets the character sequence that is used to separate an index entry and its page number.
void	setPageRangeSeparator(java.lang.String value) Sets the character sequence that is used to separate the start and end of a page range.
void	setRunSubentriesOnSameLine(boolean value) Sets whether run subentries into the same line as the main entry.
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	setUseYomi(boolean value) Sets whether to enable the use of yomi text for index entries.

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

Returns:

The name of the bookmark that marks the portion of the document used to build the index.

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

Parameters:

value - The name of the bookmark that marks the portion of the document used to build the index.

Throws:

java.lang.Exception

getNumberOfColumns

public java.lang.String getNumberOfColumns()

Gets the number of columns per page used when building the index.

Returns:

The number of columns per page used when building the index.

setNumberOfColumns

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

Sets the number of columns per page used when building the index.

Parameters:

value - The number of columns per page used when building the index.

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

getPageNumberSeparator

public java.lang.String getPageNumberSeparator()

Gets the character sequence that is used to separate an index entry and its page number.

Returns:

The character sequence that is used to separate an index entry and its page number.

setPageNumberSeparator

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

Sets the character sequence that is used to separate an index entry and its page number.

Parameters:

value - The character sequence that is used to separate an index entry and its page number.

Throws:

java.lang.Exception

hasPageNumberSeparator

public boolean hasPageNumberSeparator()

Gets a value indicating whether a page number separator is overridden through the field's code.

Returns:

A value indicating whether a page number separator is overridden through the field's code.

getEntryType

public java.lang.String getEntryType()

Gets an index entry type used to build the index.

Returns:

An index entry type used to build the index.

setEntryType

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

Sets an index entry type used to build the index.

Parameters:

value - An index entry type used to build the index.

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

getHeading

public java.lang.String getHeading()

Gets a heading that appears at the start of each set of entries for any given letter.

Returns:

A heading that appears at the start of each set of entries for any given letter.

setHeading

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

Sets a heading that appears at the start of each set of entries for any given letter.

Parameters:

value - A heading that appears at the start of each set of entries for any given letter.

Throws:

java.lang.Exception

getCrossReferenceSeparator

public java.lang.String getCrossReferenceSeparator()

Gets the character sequence that is used to separate cross references and other entries.

Returns:

The character sequence that is used to separate cross references and other entries.

setCrossReferenceSeparator

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

Sets the character sequence that is used to separate cross references and other entries.

Parameters:

value - The character sequence that is used to separate cross references and other entries.

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

getLetterRange

public java.lang.String getLetterRange()

Gets a range of letters to which limit the index.

Returns:

A range of letters to which limit the index.

setLetterRange

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

Sets a range of letters to which limit the index.

Parameters:

value - A range of letters to which limit the index.

Throws:

java.lang.Exception

getRunSubentriesOnSameLine

public boolean getRunSubentriesOnSameLine()

Gets whether run subentries into the same line as the main entry.

Returns:

Whether run subentries into the same line as the main entry.

setRunSubentriesOnSameLine

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

Sets whether run subentries into the same line as the main entry.

Parameters:

value - Whether run subentries into the same line as the main entry.

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

hasSequenceName

public boolean hasSequenceName()

Gets a value indicating whether a sequence should be used while the field's result building.

Returns:

A value indicating whether a sequence should be used while the field's result building.

getUseYomi

public boolean getUseYomi()

Gets whether to enable the use of yomi text for index entries.

Returns:

Whether to enable the use of yomi text for index entries.

setUseYomi

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

Sets whether to enable the use of yomi text for index entries.

Parameters:

value - Whether to enable the use of yomi text for index entries.

Throws:

java.lang.Exception

getLanguageId

public java.lang.String getLanguageId()

Gets the language ID used to generate the index.

Returns:

The language ID used to generate the index.

setLanguageId

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

Sets the language ID used to generate the index.

Parameters:

value - The language ID used to generate the index.

Throws:

java.lang.Exception