java.lang.Object
Field
com.aspose.words.FieldAdvance
public class FieldAdvance
- extends Field
Implements the ADVANCE field.
Moves the starting point at which the text that lexically follows the field is displayed to the right or left,
up or down, or to a specific horizontal or vertical position.
Property Getters/Setters Summary |
java.lang.String | getDownOffset() | |
void | setDownOffset(java.lang.String value) | |
|
Gets or sets the number of points by which the text that follows the field should be moved down.
|
FieldEnd | getEnd() | → inherited from Field |
|
Gets the node that represents the field end.
|
FieldFormat | getFormat() | → inherited from Field |
|
Gets a FieldFormat object that provides typed access to field's formatting.
|
java.lang.String | getHorizontalPosition() | |
void | setHorizontalPosition(java.lang.String value) | |
|
Gets or sets the number of points by which the text that follows the field should be moved horizontally
from the left edge of the column, frame, or text box.
|
boolean | isLocked() | → inherited from Field |
void | isLocked(boolean value) | |
|
Gets or sets whether the field is locked (should not recalculate its result).
|
java.lang.String | getLeftOffset() | |
void | setLeftOffset(java.lang.String value) | |
|
Gets or sets the number of points by which the text that follows the field should be moved left.
|
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.
|
java.lang.String | getRightOffset() | |
void | setRightOffset(java.lang.String value) | |
|
Gets or sets the number of points by which the text that follows the field should be moved right.
|
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.
|
int | getType() | → inherited from Field |
|
Gets the Microsoft Word field type.
The value of the property is FieldType integer constant. |
java.lang.String | getUpOffset() | |
void | setUpOffset(java.lang.String value) | |
|
Gets or sets the number of points by which the text that follows the field should be moved up.
|
java.lang.String | getVerticalPosition() | |
void | setVerticalPosition(java.lang.String value) | |
|
Gets or sets the number of points by which the text that follows the field should be moved vertically
from the top edge of the page.
|
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.
|
FieldAdvance
public FieldAdvance()
-
Property Getters/Setters Detail |
getDownOffset/setDownOffset | |
public java.lang.String getDownOffset() / public void setDownOffset(java.lang.String value)
|
-
Gets or sets the number of points by which the text that follows the field should be moved down.
-
Gets the node that represents the field end.
-
Gets a FieldFormat object that provides typed access to field's formatting.
getHorizontalPosition/setHorizontalPosition | |
public java.lang.String getHorizontalPosition() / public void setHorizontalPosition(java.lang.String value)
|
-
Gets or sets the number of points by which the text that follows the field should be moved horizontally
from the left edge of the column, frame, or text box.
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).
getLeftOffset/setLeftOffset | |
public java.lang.String getLeftOffset() / public void setLeftOffset(java.lang.String value)
|
-
Gets or sets the number of points by which the text that follows the field should be moved left.
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.
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();
getRightOffset/setRightOffset | |
public java.lang.String getRightOffset() / public void setRightOffset(java.lang.String value)
|
-
Gets or sets the number of points by which the text that follows the field should be moved right.
-
Gets the node that represents the field separator. Can be null.
-
Gets the node that represents the start of the field.
getType | → inherited from Field |
public int getType()
|
-
Gets the Microsoft Word field type.
The value of the property is FieldType integer constant.
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();
getUpOffset/setUpOffset | |
public java.lang.String getUpOffset() / public void setUpOffset(java.lang.String value)
|
-
Gets or sets the number of points by which the text that follows the field should be moved up.
getVerticalPosition/setVerticalPosition | |
public java.lang.String getVerticalPosition() / public void setVerticalPosition(java.lang.String value)
|
-
Gets or sets the number of points by which the text that follows the field should be moved vertically
from the top edge of the page.
getFieldCode | → inherited from Field |
public java.lang.String getFieldCode()
throws java.lang.Exception |
-
Returns text between field start and field separator (or field end if there is no separator).
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 |
-
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.
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 |
-
Performs the field update. Throws if the field is being updated already.
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();
See Also:
Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
Aspose.Words Support Forum - our preferred method of support.