java.lang.Object
Field
com.aspose.words.FieldMergeField
public class FieldMergeField
- extends Field
Implements the MERGEFIELD field.
Retrieves the name of a data field within the merge characters in a mail merge main document.
When the main document is merged with the selected data source, information from the specified
data field is inserted in place of the merge field.
Property Getters/Setters Summary |
FieldEnd | getEnd() | → inherited from Field |
|
Gets the node that represents the field end.
|
java.lang.String | getFieldName() | |
void | setFieldName(java.lang.String value) | |
|
Gets or sets the name of a data field.
|
java.lang.String | getFieldNameNoPrefix() | |
|
Returns just the name of the data field. Any prefix is stripped to the prefix property.
|
FieldFormat | getFormat() | → inherited from Field |
|
Gets a FieldFormat object that provides typed access to field's formatting.
|
boolean | isDirty() | → inherited from Field |
void | isDirty(boolean value) | |
|
Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
|
boolean | isLocked() | → inherited from Field |
void | isLocked(boolean value) | |
|
Gets or sets whether the field is locked (should not recalculate its result).
|
boolean | isMapped() | |
void | isMapped(boolean value) | |
|
Gets or sets whether this field is a mapped field.
|
boolean | isVerticalFormatting() | |
void | isVerticalFormatting(boolean value) | |
|
Gets or sets whether to enable character conversion for vertical formatting.
|
int | getLocaleId() | → inherited from Field |
void | setLocaleId(int value) | |
|
Gets or sets the LCID of the field.
|
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 | getTextAfter() | |
void | setTextAfter(java.lang.String value) | |
|
Gets or sets the text to be inserted after the field if the field is not blank.
|
java.lang.String | getTextBefore() | |
void | setTextBefore(java.lang.String value) | |
|
Gets or sets the text to be inserted before the field if the field is not blank.
|
int | getType() | |
| The value of the property is FieldType integer constant. |
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.
|
Property Getters/Setters Detail |
-
Gets the node that represents the field end.
getFieldName/setFieldName | |
public java.lang.String getFieldName() / public void setFieldName(java.lang.String value)
|
-
Gets or sets the name of a data field.
getFieldNameNoPrefix | |
public java.lang.String getFieldNameNoPrefix()
|
-
Returns just the name of the data field. Any prefix is stripped to the prefix property.
-
Gets a FieldFormat object that provides typed access to field's formatting.
isDirty/isDirty | → inherited from Field |
public boolean isDirty() / public void isDirty(boolean value)
|
-
Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
isLocked/isLocked | → inherited from Field |
public boolean isLocked() / public void isLocked(boolean value)
|
-
Gets or sets whether the field is locked (should not recalculate its result).
isMapped/isMapped | |
public boolean isMapped() / public void isMapped(boolean value)
|
-
Gets or sets whether this field is a mapped field.
isVerticalFormatting/isVerticalFormatting | |
public boolean isVerticalFormatting() / public void isVerticalFormatting(boolean value)
|
-
Gets or sets whether to enable character conversion for vertical formatting.
getLocaleId/setLocaleId | → inherited from Field |
public int getLocaleId() / public void setLocaleId(int value)
|
-
Gets or sets the LCID of the field.
- See Also:
- FieldUpdateCultureSource.FIELD_CODE
getResult/setResult | → inherited from Field |
public java.lang.String getResult() / public void setResult(java.lang.String value)
|
-
Gets or sets text that is between the field separator and field end.
-
Gets the node that represents the field separator. Can be null.
-
Gets the node that represents the start of the field.
getTextAfter/setTextAfter | |
public java.lang.String getTextAfter() / public void setTextAfter(java.lang.String value)
|
-
Gets or sets the text to be inserted after the field if the field is not blank.
getTextBefore/setTextBefore | |
public java.lang.String getTextBefore() / public void setTextBefore(java.lang.String value)
|
-
Gets or sets the text to be inserted before the field if the field is not blank.
getType | |
public int getType()
|
- The value of the property is FieldType integer constant.
getFieldCode | → inherited from Field |
public java.lang.String getFieldCode() |
-
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.
getFieldCode | → inherited from Field |
public java.lang.String getFieldCode(boolean includeChildFieldCodes) |
-
Returns text between field start and field separator (or field end if there is no separator).
- Parameters:
includeChildFieldCodes
- True
if child field codes should be included.
getSwitchType | |
public aspose.obfuscated.type getSwitchType(java.lang.String switchName) |
- Reserved for internal use.
remove | → inherited from Field |
public Aspose.Words.Node remove()
throws java.lang.Exception |
-
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.
unlink | → inherited from Field |
public boolean unlink()
throws java.lang.Exception |
-
Performs the field unlink.
Replaces the field with its most recent result.
Some fields, such as XE (Index Entry) fields and SEQ (Sequence) fields, cannot be unlinked.
- Returns:
True
if the field has been unlinked, otherwise false
.
update | → inherited from Field |
public void update()
throws java.lang.Exception |
-
Performs the field update. Throws if the field is being updated already.
update | → inherited from Field |
public void update(boolean ignoreMergeFormat)
throws java.lang.Exception |
-
Performs a field update. Throws if the field is being updated already.
- Parameters:
ignoreMergeFormat
-
If true
then direct field result formatting is abandoned, regardless of the MERGEFORMAT switch, otherwise normal update is performed.
See Also:
Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
Aspose.Words Support Forum - our preferred method of support.