java.lang.ObjectField
com.aspose.words.FieldIndex
public class FieldIndex
Constructor Summary |
---|
FieldIndex()
|
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 index. | ||
java.lang.String | getCrossReferenceSeparator() | |
void | setCrossReferenceSeparator(java.lang.String value) | |
Gets or sets the character sequence that is used to separate cross references and other entries. | ||
FieldEnd | getEnd() | → inherited from Field |
Gets the node that represents the field end. | ||
java.lang.String | getEntryType() | |
void | setEntryType(java.lang.String value) | |
Gets or sets an index entry type used to build the index. | ||
FieldFormat | getFormat() | → inherited from Field |
Gets a |
||
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. | ||
java.lang.String | getHeading() | |
void | setHeading(java.lang.String value) | |
Gets or sets a heading that appears at the start of each set of entries for any given letter. | ||
boolean | isLocked() | → inherited from Field |
void | isLocked(boolean value) | |
Gets or sets whether the field is locked (should not recalculate its result). | ||
java.lang.String | getLanguageId() | |
void | setLanguageId(java.lang.String value) | |
Gets or sets the language ID used to generate the index. | ||
java.lang.String | getLetterRange() | |
void | setLetterRange(java.lang.String value) | |
Gets or sets a range of letters to which limit the index. | ||
java.lang.String | getNumberOfColumns() | |
void | setNumberOfColumns(java.lang.String value) | |
Gets or sets the number of columns per page used when building the index. | ||
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 | getPageNumberSeparator() | |
void | setPageNumberSeparator(java.lang.String value) | |
Gets or sets the character sequence that is used to separate an index entry and its page number. | ||
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. | ||
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. | ||
boolean | getRunSubentriesOnSameLine() | |
void | setRunSubentriesOnSameLine(boolean value) | |
Gets or sets whether run subentries into the same line as the main entry. | ||
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 | getUseYomi() | |
void | setUseYomi(boolean value) | |
Gets or sets whether to enable the use of yomi text for index entries. |
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). | ||
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. | ||
void | update() | → inherited from Field |
Performs the field update. Throws if the field is being updated already. |
Constructor Detail |
---|
public FieldIndex()
Property Getters/Setters Detail |
---|
getBookmarkName/setBookmarkName | |
public java.lang.String getBookmarkName() / public void setBookmarkName(java.lang.String value) |
getCrossReferenceSeparator/setCrossReferenceSeparator | |
public java.lang.String getCrossReferenceSeparator() / public void setCrossReferenceSeparator(java.lang.String value) |
getEnd | → inherited from Field |
public FieldEnd getEnd() |
getEntryType/setEntryType | |
public java.lang.String getEntryType() / public void setEntryType(java.lang.String value) |
getFormat | → inherited from Field |
public FieldFormat getFormat() |
hasPageNumberSeparator | |
public boolean hasPageNumberSeparator() |
hasSequenceName | |
public boolean hasSequenceName() |
getHeading/setHeading | |
public java.lang.String getHeading() / public void setHeading(java.lang.String value) |
isLocked/isLocked | → inherited from Field |
public boolean isLocked() / public void isLocked(boolean value) |
getLanguageId/setLanguageId | |
public java.lang.String getLanguageId() / public void setLanguageId(java.lang.String value) |
getLetterRange/setLetterRange | |
public java.lang.String getLetterRange() / public void setLetterRange(java.lang.String value) |
getNumberOfColumns/setNumberOfColumns | |
public java.lang.String getNumberOfColumns() / public void setNumberOfColumns(java.lang.String value) |
getPageNumberListSeparator/setPageNumberListSeparator | |
public java.lang.String getPageNumberListSeparator() / public void setPageNumberListSeparator(java.lang.String value) |
getPageNumberSeparator/setPageNumberSeparator | |
public java.lang.String getPageNumberSeparator() / public void setPageNumberSeparator(java.lang.String value) |
getPageRangeSeparator/setPageRangeSeparator | |
public java.lang.String getPageRangeSeparator() / public void setPageRangeSeparator(java.lang.String value) |
getResult/setResult | → inherited from Field |
public java.lang.String getResult() / public void setResult(java.lang.String value) |
Example:
Inserts a field into a document using DocumentBuilder.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert a simple Date field into the document. // When we insert a field through the DocumentBuilder class we can get the // special Field object which contains information about the field. Field dateField = builder.insertField("DATE \\* MERGEFORMAT"); // Update this particular field in the document so we can get the FieldResult. dateField.update(); // Display some information from this field. // The field result is where the last evaluated value is stored. This is what is displayed in the document // When field codes are not showing. System.out.println(MessageFormat.format("FieldResult: {0}", dateField.getResult())); // Display the field code which defines the behaviour of the field. This can been seen in Microsoft Word by pressing ALT+F9. System.out.println(MessageFormat.format("FieldCode: {0}", dateField.getFieldCode())); // The field type defines what type of field in the Document this is. In this case the type is "FieldDate" System.out.println(MessageFormat.format("FieldType: {0}", dateField.getType())); // Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object. dateField.remove();
getRunSubentriesOnSameLine/setRunSubentriesOnSameLine | |
public boolean getRunSubentriesOnSameLine() / public void setRunSubentriesOnSameLine(boolean value) |
getSeparator | → inherited from Field |
public FieldSeparator getSeparator() |
getSequenceName/setSequenceName | |
public java.lang.String getSequenceName() / public void setSequenceName(java.lang.String value) |
getSequenceSeparator/setSequenceSeparator | |
public java.lang.String getSequenceSeparator() / public void setSequenceSeparator(java.lang.String value) |
getStart | → inherited from Field |
public FieldStart getStart() |
getType | → inherited from Field |
public int getType() |
Example:
Inserts a field into a document using DocumentBuilder.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert a simple Date field into the document. // When we insert a field through the DocumentBuilder class we can get the // special Field object which contains information about the field. Field dateField = builder.insertField("DATE \\* MERGEFORMAT"); // Update this particular field in the document so we can get the FieldResult. dateField.update(); // Display some information from this field. // The field result is where the last evaluated value is stored. This is what is displayed in the document // When field codes are not showing. System.out.println(MessageFormat.format("FieldResult: {0}", dateField.getResult())); // Display the field code which defines the behaviour of the field. This can been seen in Microsoft Word by pressing ALT+F9. System.out.println(MessageFormat.format("FieldCode: {0}", dateField.getFieldCode())); // The field type defines what type of field in the Document this is. In this case the type is "FieldDate" System.out.println(MessageFormat.format("FieldType: {0}", dateField.getType())); // Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object. dateField.remove();
getUseYomi/setUseYomi | |
public boolean getUseYomi() / public void setUseYomi(boolean value) |
Method Detail |
---|
getFieldCode | → inherited from Field |
public java.lang.String getFieldCode() throws java.lang.Exception |
Example:
Inserts a field into a document using DocumentBuilder.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert a simple Date field into the document. // When we insert a field through the DocumentBuilder class we can get the // special Field object which contains information about the field. Field dateField = builder.insertField("DATE \\* MERGEFORMAT"); // Update this particular field in the document so we can get the FieldResult. dateField.update(); // Display some information from this field. // The field result is where the last evaluated value is stored. This is what is displayed in the document // When field codes are not showing. System.out.println(MessageFormat.format("FieldResult: {0}", dateField.getResult())); // Display the field code which defines the behaviour of the field. This can been seen in Microsoft Word by pressing ALT+F9. System.out.println(MessageFormat.format("FieldCode: {0}", dateField.getFieldCode())); // The field type defines what type of field in the Document this is. In this case the type is "FieldDate" System.out.println(MessageFormat.format("FieldType: {0}", dateField.getType())); // Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object. dateField.remove();
remove | → inherited from Field |
public Node remove() throws java.lang.Exception |
Example:
Inserts a field into a document using DocumentBuilder.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert a simple Date field into the document. // When we insert a field through the DocumentBuilder class we can get the // special Field object which contains information about the field. Field dateField = builder.insertField("DATE \\* MERGEFORMAT"); // Update this particular field in the document so we can get the FieldResult. dateField.update(); // Display some information from this field. // The field result is where the last evaluated value is stored. This is what is displayed in the document // When field codes are not showing. System.out.println(MessageFormat.format("FieldResult: {0}", dateField.getResult())); // Display the field code which defines the behaviour of the field. This can been seen in Microsoft Word by pressing ALT+F9. System.out.println(MessageFormat.format("FieldCode: {0}", dateField.getFieldCode())); // The field type defines what type of field in the Document this is. In this case the type is "FieldDate" System.out.println(MessageFormat.format("FieldType: {0}", dateField.getType())); // Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object. dateField.remove();
update | → inherited from Field |
public void update() throws java.lang.Exception |
Example:
Inserts a field into a document using DocumentBuilder.Document doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); // Insert a simple Date field into the document. // When we insert a field through the DocumentBuilder class we can get the // special Field object which contains information about the field. Field dateField = builder.insertField("DATE \\* MERGEFORMAT"); // Update this particular field in the document so we can get the FieldResult. dateField.update(); // Display some information from this field. // The field result is where the last evaluated value is stored. This is what is displayed in the document // When field codes are not showing. System.out.println(MessageFormat.format("FieldResult: {0}", dateField.getResult())); // Display the field code which defines the behaviour of the field. This can been seen in Microsoft Word by pressing ALT+F9. System.out.println(MessageFormat.format("FieldCode: {0}", dateField.getFieldCode())); // The field type defines what type of field in the Document this is. In this case the type is "FieldDate" System.out.println(MessageFormat.format("FieldType: {0}", dateField.getType())); // Finally let's completely remove the field from the document. This can easily be done by invoking the Remove method on the object. dateField.remove();