FieldMergeField
Overview
FieldMergeField is a class in Aspose.Words FOSS for Java.
Inherits from: Field, IFieldCodeTokenInfoProvider.
Implements the MERGEFIELD field.
Edition status of its 42 listed members (a property and its accessor methods are listed separately, overloads once): 42 not yet exercised by a verified example.
This class declares 31 methods for FieldMergeField objects in Java programs.
Available methods include: getDisplayResult, getEnd, getFieldCode, getFieldName, getFieldNameNoPrefix, getFormat, getLocaleId, getResult, getSeparator, getStart, getTextAfter, getTextBefore, and 13 additional methods.
Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package.
Properties: dirty, displayResult, end, fieldCode, fieldName, fieldNameNoPrefix, and 11 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
type | int | Read | Gets the Microsoft Word field type. |
fieldNameNoPrefix | String | Read | Returns just the name of the data field. |
fieldName | String | Read/Write | Gets or sets the name of a data field. |
textBefore | String | Read/Write | Gets or sets the text to be inserted before the field if the field is not blank. |
textAfter | String | Read/Write | Gets or sets the text to be inserted after the field if the field is not blank. |
mapped | boolean | Read/Write | Gets or sets whether this field is a mapped field. |
verticalFormatting | boolean | Read/Write | Gets or sets whether to enable character conversion for vertical formatting. |
fieldCode | String | Read | Returns text between field start and field separator (or field end if there is no separator). |
start | FieldStart | Read | Gets the node that represents the start of the field. |
separator | FieldSeparator | Read | Gets the node that represents the field separator. |
end | FieldEnd | Read | Gets the node that represents the field end. |
result | String | Read/Write | Gets or sets text that is between the field separator and field end. |
displayResult | String | Read | Gets the text that represents the displayed field result. |
locked | boolean | Read/Write | Gets or sets whether the field is locked (should not recalculate its result). |
dirty | boolean | Read/Write | Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. |
format | FieldFormat | Read | Gets a FieldFormat object that provides typed access to field’s formatting. |
localeId | int | Read/Write | Gets or sets the LCID of the field. |
Methods
| Signature | Description |
|---|---|
getType() → int | Gets the Microsoft Word field type. |
getFieldNameNoPrefix() → String | Returns just the name of the data field. |
getFieldName() → String | Gets or sets the name of a data field. |
setFieldName(value: String) | Sets the field name value. |
getTextBefore() → String | Gets or sets the text to be inserted before the field if the field is not blank. |
setTextBefore(value: String) | Sets the text before value. |
getTextAfter() → String | Gets or sets the text to be inserted after the field if the field is not blank. |
setTextAfter(value: String) | Sets the text after value. |
isMapped() → boolean | Gets or sets whether this field is a mapped field. |
isMapped(value: boolean) | Calls isMapped(value) on this FieldMergeField instance. |
isVerticalFormatting() → boolean | Gets or sets whether to enable character conversion for vertical formatting. |
isVerticalFormatting(value: boolean) | Calls isVerticalFormatting(value) on this FieldMergeField instance. |
getFieldCode() → String | Returns text between field start and field separator (or field end if there is no separator). |
getFieldCode(includeChildFieldCodes: boolean) → String | Returns text between field start and field separator (or field end if there is no separator). |
remove() → Node | Removes the field from the document. |
update() | Performs the field update. |
update(ignoreMergeFormat: boolean) | Performs a field update. |
unlink() → boolean | Performs the field unlink. |
getStart() → FieldStart | Gets the node that represents the start of the field. |
getSeparator() → FieldSeparator | Gets the node that represents the field separator. |
getEnd() → FieldEnd | Gets the node that represents the field end. |
getResult() → String | Gets or sets text that is between the field separator and field end. |
setResult(value: String) | Sets the result value. |
getDisplayResult() → String | Gets the text that represents the displayed field result. |
isLocked() → boolean | Gets or sets whether the field is locked (should not recalculate its result). |
isLocked(value: boolean) | Calls isLocked(value) on this FieldMergeField instance. |
isDirty() → boolean | Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. |
isDirty(value: boolean) | Calls isDirty(value) on this FieldMergeField instance. |
getFormat() → FieldFormat | Gets a FieldFormat object that provides typed access to field’s formatting. |
getLocaleId() → int | Gets or sets the LCID of the field. |
setLocaleId(value: int) | Sets the locale id value. |