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
| Name | Type | Access | Description |
|---|---|---|---|
target | String | Read/Write | Gets or sets the target to which the link should be redirected. |
address | String | Read/Write | Gets or sets a location where this hyperlink jumps. |
subAddress | String | Read/Write | Gets or sets a location in the file, such as a bookmark, where this hyperlink jumps. |
imageMap | boolean | Read/Write | Gets or sets whether to append coordinates to the hyperlink for a server-side image map. |
openInNewWindow | boolean | Read/Write | Gets or sets whether to open the destination site in a new web browser window. |
screenTip | String | Read/Write | Gets or sets the ScreenTip text for the hyperlink. |
fieldCode | String | Read | Returns text between field start and field separator (or field end if there is no separator). |
start | FieldStart | Read | Gets the node that represents the start of the field. |
separator | FieldSeparator | Read | Gets the node that represents the field separator. |
end | FieldEnd | Read | Gets the node that represents the field end. |
type | int | Read | Gets the type. |
result | String | Read/Write | Gets or sets text that is between the field separator and field end. |
displayResult | String | Read | Gets the text that represents the displayed field result. |
locked | boolean | Read/Write | Gets or sets whether the field is locked (should not recalculate its result). |
dirty | boolean | Read/Write | Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. |
format | FieldFormat | Read | Gets a FieldFormat object that provides typed access to field’s formatting. |
localeId | int | Read/Write | Gets or sets the LCID of the field. |
Methods
| Signature | Description |
|---|---|
getTarget() → String | Gets or sets the target to which the link should be redirected. |
setTarget(value: String) | Sets the target value. |
getAddress() → String | Gets or sets a location where this hyperlink jumps. |
setAddress(value: String) | Sets the address value. |
getSubAddress() → String | Gets or sets a location in the file, such as a bookmark, where this hyperlink jumps. |
setSubAddress(value: String) | Sets the sub address value. |
isImageMap() → boolean | Gets 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() → boolean | Gets 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() → String | Gets or sets the ScreenTip text for the hyperlink. |
setScreenTip(value: String) | Sets the screen tip value. |
getFieldCode() → String | Returns text between field start and field separator (or field end if there is no separator). |
getFieldCode(includeChildFieldCodes: boolean) → String | Returns text between field start and field separator (or field end if there is no separator). |
remove() → Node | Removes the field from the document. |
update() | Performs the field update. |
update(ignoreMergeFormat: boolean) | Performs a field update. |
unlink() → boolean | Performs the field unlink. |
getStart() → FieldStart | Gets the node that represents the start of the field. |
getSeparator() → FieldSeparator | Gets the node that represents the field separator. |
getEnd() → FieldEnd | Gets the node that represents the field end. |
getType() → int | Returns the type. |
getResult() → String | Gets or sets text that is between the field separator and field end. |
setResult(value: String) | Sets the result value. |
getDisplayResult() → String | Gets the text that represents the displayed field result. |
isLocked() → boolean | Gets or sets whether the field is locked (should not recalculate its result). |
isLocked(value: boolean) | Calls isLocked(value) on this FieldHyperlink instance. |
isDirty() → boolean | Gets 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() → FieldFormat | Gets a FieldFormat object that provides typed access to field’s formatting. |
getLocaleId() → int | Gets or sets the LCID of the field. |
setLocaleId(value: int) | Sets the locale id value. |