java.lang.ObjectField
com.aspose.words.FieldMergeField
public class FieldMergeField
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 |
||
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. | ||
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). | ||
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. |
Property Getters/Setters Detail |
---|
getEnd | → inherited from Field |
public FieldEnd getEnd() |
getFieldName/setFieldName | |
public java.lang.String getFieldName() / public void setFieldName(java.lang.String value) |
getFieldNameNoPrefix | |
public java.lang.String getFieldNameNoPrefix() |
getFormat | → inherited from Field |
public FieldFormat getFormat() |
isLocked/isLocked | → inherited from Field |
public boolean isLocked() / public void isLocked(boolean value) |
isMapped/isMapped | |
public boolean isMapped() / public void isMapped(boolean value) |
isVerticalFormatting/isVerticalFormatting | |
public boolean isVerticalFormatting() / public void isVerticalFormatting(boolean 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();
getSeparator | → inherited from Field |
public FieldSeparator getSeparator() |
getStart | → inherited from Field |
public FieldStart getStart() |
getTextAfter/setTextAfter | |
public java.lang.String getTextAfter() / public void setTextAfter(java.lang.String value) |
getTextBefore/setTextBefore | |
public java.lang.String getTextBefore() / public void setTextBefore(java.lang.String value) |
getType | |
public int getType() |
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();