FieldHyperlink

FieldHyperlink

Overview

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

Implements the HYPERLINK field To learn more, visit the Working with Fields documentation article.

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

This class declares 32 methods for FieldHyperlink objects in Java programs. Available methods include: getAddress, getDisplayResult, getEnd, getFieldCode, getFormat, getLocaleId, getOpenInNewWindow, getResult, getScreenTip, getSeparator, getStart, getSubAddress, and 15 additional methods. Public members are accessible to any Java application after installing the Aspose.Words FOSS for Java package. Properties: address, dirty, displayResult, end, fieldCode, format, and 11 more.

Properties

NameTypeAccessDescription
targetStringRead/WriteGets or sets the target to which the link should be redirected.
addressStringRead/WriteGets or sets a location where this hyperlink jumps.
subAddressStringRead/WriteGets or sets a location in the file, such as a bookmark, where this hyperlink jumps.
imageMapbooleanRead/WriteGets or sets whether to append coordinates to the hyperlink for a server-side image map.
openInNewWindowbooleanRead/WriteGets or sets whether to open the destination site in a new web browser window.
screenTipStringRead/WriteGets or sets the ScreenTip text for the hyperlink.
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
getTarget() → StringGets or sets the target to which the link should be redirected.
setTarget(value: String)Sets the target value.
getAddress() → StringGets or sets a location where this hyperlink jumps.
setAddress(value: String)Sets the address value.
getSubAddress() → StringGets or sets a location in the file, such as a bookmark, where this hyperlink jumps.
setSubAddress(value: String)Sets the sub address value.
isImageMap() → booleanGets or sets whether to append coordinates to the hyperlink for a server-side image map.
isImageMap(value: boolean)Calls isImageMap(value) on this FieldHyperlink instance.
getOpenInNewWindow() → booleanGets or sets whether to open the destination site in a new web browser window.
setOpenInNewWindow(value: boolean)Sets the open in new window value.
getScreenTip() → StringGets or sets the ScreenTip text for the hyperlink.
setScreenTip(value: String)Sets the screen tip 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 FieldHyperlink 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 FieldHyperlink 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