java.lang.ObjectField
com.aspose.words.FieldXE
public class FieldXE
Constructor Summary |
---|
FieldXE()
|
Property Getters/Setters Summary | ||
---|---|---|
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. | ||
FieldFormat | getFormat() | → inherited from Field |
Gets a |
||
boolean | hasPageRangeBookmarkName() | |
Gets a value indicating whether a page range bookmark name is provided through the field's code. | ||
boolean | isBold() | |
void | isBold(boolean value) | |
Gets or sets whether to apply bold formatting to the entry's page number. | ||
boolean | isItalic() | |
void | isItalic(boolean value) | |
Gets or sets whether to apply italic formatting to the entry's page number. | ||
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 | getPageNumberReplacement() | |
void | setPageNumberReplacement(java.lang.String value) | |
Gets or sets text used in place of a page number. | ||
java.lang.String | getPageRangeBookmarkName() | |
void | setPageRangeBookmarkName(java.lang.String value) | |
Gets or sets the name of the bookmark that marks a range of pages that is inserted as the entry's page number. | ||
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. | ||
FieldStart | getStart() | → inherited from Field |
Gets the node that represents the start of the field. | ||
java.lang.String | getText() | |
void | setText(java.lang.String value) | |
Gets or sets the text of the entry. | ||
int | getType() | → inherited from Field |
Gets the Microsoft Word field type. The value of the property is FieldType integer constant. | ||
java.lang.String | getYomi() | |
void | setYomi(java.lang.String value) | |
Gets or sets the yomi (first phonetic character for sorting indexes) for the index entry |
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. |
Constructor Detail |
---|
public FieldXE()
Property Getters/Setters Detail |
---|
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() |
hasPageRangeBookmarkName | |
public boolean hasPageRangeBookmarkName() |
isBold/isBold | |
public boolean isBold() / public void isBold(boolean value) |
isItalic/isItalic | |
public boolean isItalic() / public void isItalic(boolean value) |
isLocked/isLocked | → inherited from Field |
public boolean isLocked() / public void isLocked(boolean value) |
getLocaleId/setLocaleId | → inherited from Field |
public int getLocaleId() / public void setLocaleId(int value) |
getPageNumberReplacement/setPageNumberReplacement | |
public java.lang.String getPageNumberReplacement() / public void setPageNumberReplacement(java.lang.String value) |
getPageRangeBookmarkName/setPageRangeBookmarkName | |
public java.lang.String getPageRangeBookmarkName() / public void setPageRangeBookmarkName(java.lang.String value) |
getResult/setResult | → inherited from Field |
public java.lang.String getResult() / public void setResult(java.lang.String value) |
getSeparator | → inherited from Field |
public FieldSeparator getSeparator() |
getStart | → inherited from Field |
public FieldStart getStart() |
getText/setText | |
public java.lang.String getText() / public void setText(java.lang.String value) |
getType | → inherited from Field |
public int getType() |
getYomi/setYomi | |
public java.lang.String getYomi() / public void setYomi(java.lang.String value) |
Method Detail |
---|
getFieldCode | → inherited from Field |
public java.lang.String getFieldCode() |
getFieldCode | → inherited from Field |
public java.lang.String getFieldCode(boolean includeChildFieldCodes) |
includeChildFieldCodes
- True
if child field codes should be included.
getSwitchType | |
public aspose.obfuscated.type getSwitchType(java.lang.String switchName) |
remove | → inherited from Field |
public Aspose.Words.Node remove() throws java.lang.Exception |
unlink | → inherited from Field |
public boolean unlink() throws java.lang.Exception |
Replaces the field with its most recent result.
Some fields, such as XE (Index Entry) fields and SEQ (Sequence) fields, cannot be unlinked.
True
if the field has been unlinked, otherwise false
.
update | → inherited from Field |
public void update() throws java.lang.Exception |
update | → inherited from Field |
public void update(boolean ignoreMergeFormat) throws java.lang.Exception |
ignoreMergeFormat
-
If true
then direct field result formatting is abandoned, regardless of the MERGEFORMAT switch, otherwise normal update is performed.