public class FieldListNum
Constructor Summary |
---|
Property Getters/Setters Summary | ||
---|---|---|
FieldEnd | getEnd() | |
Gets the node that represents the field end.
|
||
FieldFormat | getFormat() | |
Gets a |
||
boolean | hasListName() | |
Returns a value indicating whether the name of an abstract numbering definition
is provided by the field's code.
|
||
boolean | isDirty() | |
void | isDirty(booleanvalue) | |
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() | |
void | isLocked(booleanvalue) | |
Gets or sets whether the field is locked (should not recalculate its result). | ||
java.lang.String | getListLevel() | |
void | setListLevel(java.lang.Stringvalue) | |
Gets or sets the level in the list, overriding the default behavior of the field. | ||
java.lang.String | getListName() | |
void | setListName(java.lang.Stringvalue) | |
Gets or sets the name of the abstract numbering definition used for the numbering. | ||
int | getLocaleId() | |
void | setLocaleId(intvalue) | |
Gets or sets the LCID of the field. | ||
java.lang.String | getResult() | |
void | setResult(java.lang.Stringvalue) | |
Gets or sets text that is between the field separator and field end. | ||
FieldSeparator | getSeparator() | |
Gets the node that represents the field separator. Can be null.
|
||
FieldStart | getStart() | |
Gets the node that represents the start of the field.
|
||
java.lang.String | getStartingNumber() | |
void | setStartingNumber(java.lang.Stringvalue) | |
Gets or sets the starting value for this field. | ||
int | getType() | |
Gets the Microsoft Word field type.
The value of the property is FieldType integer constant. |
Method Summary | ||
---|---|---|
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.
|
||
java.lang.String | getFieldCode(boolean includeChildFieldCodes) | |
Returns text between field start and field separator (or field end if there is no separator).
|
||
Node | remove() | |
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() | |
Performs the field unlink.
|
||
void | update() | |
Performs the field update. Throws if the field is being updated already.
|
||
void | update(boolean ignoreMergeFormat) | |
Performs a field update. Throws if the field is being updated already.
|
public FieldEnd getEnd()
public FieldFormat getFormat()
Example:
Shows how to formatting fieldsDocument doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); Field field = builder.insertField("MERGEFIELD Date"); FieldFormat format = field.getFormat(); format.setDateTimeFormat("dddd, MMMM dd, yyyy"); format.setNumericFormat("0.#"); format.getGeneralFormats().add(GeneralFormat.CHAR_FORMAT);
public boolean hasListName()
public boolean isDirty() / public void isDirty(boolean value)
Example:
Shows how to use special property for updating field resultDocument doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); Field fieldToc = builder.insertTableOfContents("\\o \"1-3\" \\h \\z \\u"); fieldToc.isDirty(true);
public boolean isLocked() / public void isLocked(boolean value)
public java.lang.String getListLevel() / public void setListLevel(java.lang.String value)
public java.lang.String getListName() / public void setListName(java.lang.String value)
public int getLocaleId() / public void setLocaleId(int value)
Example:
Get or sets locale for fieldsDocument doc = new Document(); DocumentBuilder builder = new DocumentBuilder(doc); Field field = builder.insertField("DATE \\* MERGEFORMAT"); field.setLocaleId(2064); ByteArrayOutputStream dstStream = new ByteArrayOutputStream(); doc.save(dstStream, SaveFormat.DOCX); Field newField = doc.getRange().getFields().get(0); Assert.assertEquals(newField.getLocaleId(), 2064);
public java.lang.String getResult() / public void setResult(java.lang.String value)
Example:
Inserts a field into a document using DocumentBuilder and FieldCode.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();
public FieldSeparator getSeparator()
public FieldStart getStart()
public java.lang.String getStartingNumber() / public void setStartingNumber(java.lang.String value)
public int getType()
Example:
Inserts a field into a document using DocumentBuilder and FieldCode.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();
public java.lang.String getFieldCode()
Example:
Inserts a field into a document using DocumentBuilder and FieldCode.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();
Example:
Shows how to get text between field start and field separator (or field end if there is no separator)Document doc = new Document(getMyDir() + "Field.FieldCode.docx"); for (Field field : doc.getRange().getFields()) { if (field.getType() == FieldType.FIELD_IF) { FieldIf fieldIf = (FieldIf) field; String fieldCode = fieldIf.getFieldCode(); if (containsNestedFields) { fieldCode = fieldIf.getFieldCode(true); } else { fieldCode = fieldIf.getFieldCode(false); } } }
public java.lang.String getFieldCode(boolean includeChildFieldCodes)
includeChildFieldCodes
- True
if child field codes should be included.
Example:
Shows how to get text between field start and field separator (or field end if there is no separator)Document doc = new Document(getMyDir() + "Field.FieldCode.docx"); for (Field field : doc.getRange().getFields()) { if (field.getType() == FieldType.FIELD_IF) { FieldIf fieldIf = (FieldIf) field; String fieldCode = fieldIf.getFieldCode(); if (containsNestedFields) { fieldCode = fieldIf.getFieldCode(true); } else { fieldCode = fieldIf.getFieldCode(false); } } }
public Node remove() throws java.lang.Exception
Example:
Inserts a field into a document using DocumentBuilder and FieldCode.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();
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
.
Example:
Shows how to unlink specific fieldDocument doc = new Document(getMyDir() + "Field.UnlinkFields.docx"); doc.getRange().getFields().get(1).unlink();
public void update() throws java.lang.Exception
Example:
Inserts a field into a document using DocumentBuilder and FieldCode.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();
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.
Example:
Shows a way to update a field ignoring the MERGEFORMAT switchLoadOptions loadOptions = new LoadOptions(); loadOptions.setPreserveIncludePictureField(true); Document doc = new Document(getMyDir() + "Field.UpdateFieldIgnoringMergeFormat.docx", loadOptions); for (Field field : doc.getRange().getFields()) { if (((field.getType()) == (FieldType.FIELD_INCLUDE_PICTURE))) { FieldIncludePicture includePicture = (FieldIncludePicture) field; includePicture.setSourceFullName(getMyDir() + "\\Images\\dotnet-logo.png"); includePicture.update(true); } } doc.updateFields(); doc.save(getMyDir() + "\\Artifacts\\Field.UpdateFieldIgnoringMergeFormat.docx");