java.lang.ObjectField
com.aspose.words.FieldHyperlink
public class FieldHyperlink
Constructor Summary |
---|
FieldHyperlink()
|
Property Getters/Setters Summary | ||
---|---|---|
java.lang.String | getAddress() | |
void | setAddress(java.lang.String value) | |
Gets or sets a location where this hyperlink jumps. | ||
FieldEnd | getEnd() | → inherited from Field |
Gets the node that represents the field end. | ||
FieldFormat | getFormat() | → inherited from Field |
Gets a |
||
boolean | isDirty() | → inherited from Field |
void | isDirty(boolean value) | |
Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. | ||
boolean | isImageMap() | |
void | isImageMap(boolean value) | |
Gets or sets whether to append coordinates to the hyperlink for a server-side image map. | ||
boolean | isLocked() | → inherited from Field |
void | isLocked(boolean value) | |
Gets or sets whether the field is locked (should not recalculate its result). | ||
int | getLocaleId() | → inherited from Field |
void | setLocaleId(int value) | |
Gets or sets the LCID of the field. | ||
boolean | getOpenInNewWindow() | |
void | setOpenInNewWindow(boolean value) | |
Gets or sets whether to open the destination site in a new web browser window. | ||
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 | getScreenTip() | |
void | setScreenTip(java.lang.String value) | |
Gets or sets the ScreenTip text for the hyperlink. | ||
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. | ||
java.lang.String | getSubAddress() | |
void | setSubAddress(java.lang.String value) | |
Gets or sets a location in the file, such as a bookmark, where this hyperlink jumps. | ||
java.lang.String | getTarget() | |
void | setTarget(java.lang.String value) | |
Gets or sets the target to which the link should be redirected. | ||
int | getType() | → inherited from Field |
Gets the Microsoft Word field type. The value of the property is FieldType integer constant. |
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). Both field code and field result of child fields are included. | ||
java.lang.String | getFieldCode(boolean includeChildFieldCodes) | → inherited from Field |
Returns text between field start and field separator (or field end if there is no separator). | ||
aspose.obfuscated.type | getFormatApplier() | |
Reserved for internal use. | ||
Aspose.Words.Inline | getSourceNode() | |
Reserved for internal use. | ||
aspose.obfuscated.type | getSwitchType(java.lang.String switchName) | |
Reserved for internal use. | ||
Aspose.Words.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. | ||
boolean | unlink() | → inherited from Field |
Performs the field unlink. | ||
void | update() | → inherited from Field |
Performs the field update. Throws if the field is being updated already. | ||
void | update(boolean ignoreMergeFormat) | → inherited from Field |
Performs a field update. Throws if the field is being updated already. |
Constructor Detail |
---|
public FieldHyperlink()
Property Getters/Setters Detail |
---|
getAddress/setAddress | |
public java.lang.String getAddress() / public void setAddress(java.lang.String value) |
getEnd | → inherited from Field |
public FieldEnd getEnd() |
getFormat | → inherited from Field |
public FieldFormat getFormat() |
isDirty/isDirty | → inherited from Field |
public boolean isDirty() / public void isDirty(boolean value) |
isImageMap/isImageMap | |
public boolean isImageMap() / public void isImageMap(boolean value) |
isLocked/isLocked | → inherited from Field |
public boolean isLocked() / public void isLocked(boolean value) |
getLocaleId/setLocaleId | → inherited from Field |
public int getLocaleId() / public void setLocaleId(int value) |
getOpenInNewWindow/setOpenInNewWindow | |
public boolean getOpenInNewWindow() / public void setOpenInNewWindow(boolean value) |
getResult/setResult | → inherited from Field |
public java.lang.String getResult() / public void setResult(java.lang.String value) |
getScreenTip/setScreenTip | |
public java.lang.String getScreenTip() / public void setScreenTip(java.lang.String value) |
getSeparator | → inherited from Field |
public FieldSeparator getSeparator() |
getStart | → inherited from Field |
public FieldStart getStart() |
getSubAddress/setSubAddress | |
public java.lang.String getSubAddress() / public void setSubAddress(java.lang.String value) |
getTarget/setTarget | |
public java.lang.String getTarget() / public void setTarget(java.lang.String value) |
getType | → inherited from Field |
public int getType() |
Method Detail |
---|
getFieldCode | → inherited from Field |
public java.lang.String getFieldCode() |
getFieldCode | → inherited from Field |
public java.lang.String getFieldCode(boolean includeChildFieldCodes) |
includeChildFieldCodes
- True
if child field codes should be included.
getFormatApplier | |
public aspose.obfuscated.type getFormatApplier() |
getSourceNode | |
public Aspose.Words.Inline getSourceNode() |
getSwitchType | |
public aspose.obfuscated.type getSwitchType(java.lang.String switchName) |
remove | → inherited from Field |
public Aspose.Words.Node remove() throws java.lang.Exception |
unlink | → inherited from Field |
public boolean unlink() throws java.lang.Exception |
Replaces the field with its most recent result.
Some fields, such as XE (Index Entry) fields and SEQ (Sequence) fields, cannot be unlinked.
True
if the field has been unlinked, otherwise false
.
update | → inherited from Field |
public void update() throws java.lang.Exception |
update | → inherited from Field |
public void update(boolean ignoreMergeFormat) throws java.lang.Exception |
ignoreMergeFormat
-
If true
then direct field result formatting is abandoned, regardless of the MERGEFORMAT switch, otherwise normal update is performed.