FieldGoToButton

FieldGoToButton

Overview

FieldGoToButton is a class in Aspose.Words FOSS for Java. Inherits from: Field.

Implements the GOTOBUTTON field.

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

This class declares 24 methods for FieldGoToButton objects in Java programs. Available methods include: getDisplayResult, getDisplayText, getEnd, getFieldCode, getFormat, getLocaleId, getLocation, getResult, getSeparator, getStart, getType, isDirty, and 8 additional methods. Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package. Properties: dirty, displayResult, displayText, end, fieldCode, format, and 7 more.

Properties

NameTypeAccessDescription
locationStringRead/WriteGets or sets the name of a bookmark, a page number, or some other item to jump to.
displayTextStringRead/WriteGets or sets the text of the “button” that appears in the document, such that it can be selected to activate the jump.
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
getLocation() → StringGets or sets the name of a bookmark, a page number, or some other item to jump to.
setLocation(value: String)Sets the location value.
getDisplayText() → StringGets or sets the text of the “button” that appears in the document, such that it can be selected to activate the jump.
setDisplayText(value: String)Sets the display text 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 FieldGoToButton 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 FieldGoToButton 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