FieldAdvance

Overview

FieldAdvance is a class in Aspose.Words FOSS for Java. Inherits from: Field, IFieldCodeTokenInfoProvider.

Implements the ADVANCE field.

Edition status of its 45 listed members (a property and its accessor methods are listed separately, overloads once): 45 not yet exercised by a verified example.

This class declares 32 methods for FieldAdvance objects in Java programs. Available methods include: getDisplayResult, getDownOffset, getEnd, getFieldCode, getFormat, getHorizontalPosition, getLeftOffset, getLocaleId, getResult, getRightOffset, getSeparator, getStart, and 16 additional methods. Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package. Properties: dirty, displayResult, downOffset, end, fieldCode, format, and 11 more.

Properties

NameTypeAccessDescription
downOffsetStringRead/WriteGets or sets the number of points by which the text that follows the field should be moved down.
leftOffsetStringRead/WriteGets or sets the number of points by which the text that follows the field should be moved left.
rightOffsetStringRead/WriteGets or sets the number of points by which the text that follows the field should be moved right.
upOffsetStringRead/WriteGets or sets the number of points by which the text that follows the field should be moved up.
horizontalPositionStringRead/WriteGets 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.
verticalPositionStringRead/WriteGets 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.
fieldCodeStringReadReturns text between field start and field separator (or field end if there is no separator).
startFieldStartReadGets the node that represents the start of the field.
separatorFieldSeparatorReadGets the node that represents the field separator.
endFieldEndReadGets the node that represents the field end.
typeintReadGets the type.
resultStringRead/WriteGets or sets text that is between the field separator and field end.
displayResultStringReadGets the text that represents the displayed field result.
lockedbooleanRead/WriteGets or sets whether the field is locked (should not recalculate its result).
dirtybooleanRead/WriteGets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
formatFieldFormatReadGets a FieldFormat object that provides typed access to field’s formatting.
localeIdintRead/WriteGets or sets the LCID of the field.

Methods

SignatureDescription
getDownOffset() → StringGets or sets the number of points by which the text that follows the field should be moved down.
setDownOffset(value: String)Sets the down offset value.
getLeftOffset() → StringGets or sets the number of points by which the text that follows the field should be moved left.
setLeftOffset(value: String)Sets the left offset value.
getRightOffset() → StringGets or sets the number of points by which the text that follows the field should be moved right.
setRightOffset(value: String)Sets the right offset value.
getUpOffset() → StringGets or sets the number of points by which the text that follows the field should be moved up.
setUpOffset(value: String)Sets the up offset value.
getHorizontalPosition() → StringGets 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.
setHorizontalPosition(value: String)Sets the horizontal position value.
getVerticalPosition() → StringGets 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.
setVerticalPosition(value: String)Sets the vertical position value.
getFieldCode() → StringReturns text between field start and field separator (or field end if there is no separator).
getFieldCode(includeChildFieldCodes: boolean) → StringReturns text between field start and field separator (or field end if there is no separator).
remove() → NodeRemoves the field from the document.
update()Performs the field update.
update(ignoreMergeFormat: boolean)Performs a field update.
unlink() → booleanPerforms the field unlink.
getStart() → FieldStartGets the node that represents the start of the field.
getSeparator() → FieldSeparatorGets the node that represents the field separator.
getEnd() → FieldEndGets the node that represents the field end.
getType() → intReturns the type.
getResult() → StringGets or sets text that is between the field separator and field end.
setResult(value: String)Sets the result value.
getDisplayResult() → StringGets the text that represents the displayed field result.
isLocked() → booleanGets or sets whether the field is locked (should not recalculate its result).
isLocked(value: boolean)Calls isLocked(value) on this FieldAdvance instance.
isDirty() → booleanGets 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 FieldAdvance instance.
getFormat() → FieldFormatGets a FieldFormat object that provides typed access to field’s formatting.
getLocaleId() → intGets or sets the LCID of the field.
setLocaleId(value: int)Sets the locale id value.

See Also