com.aspose.words

Class FieldHyperlink

java.lang.Object

com.aspose.words.Field

com.aspose.words.FieldHyperlink

public class FieldHyperlink
extends Field

Implements the HYPERLINK field

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

Remarks:

When selected, causes control to jump to the location such as a bookmark or a URL.

Examples:

Shows how to use HYPERLINK fields to link to documents in the local file system.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 FieldHyperlink field = (FieldHyperlink) builder.insertField(FieldType.FIELD_HYPERLINK, true);

 // When we click this HYPERLINK field in Microsoft Word,
 // it will open the linked document and then place the cursor at the specified bookmark.
 field.setAddress(getMyDir() + "Bookmarks.docx");
 field.setSubAddress("MyBookmark3");
 field.setScreenTip("Open " + field.getAddress() + " on bookmark " + field.getSubAddress() + " in a new window");

 builder.writeln();

 // When we click this HYPERLINK field in Microsoft Word,
 // it will open the linked document, and automatically scroll down to the specified iframe.
 field = (FieldHyperlink) builder.insertField(FieldType.FIELD_HYPERLINK, true);
 field.setAddress(getMyDir() + "Iframes.html");
 field.setScreenTip("Open " + field.getAddress());
 field.setTarget("iframe_3");
 field.setOpenInNewWindow(true);
 field.isImageMap(false);

 doc.updateFields();
 doc.save(getArtifactsDir() + "Field.HYPERLINK.docx");
 
 

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAddress() Gets a location where this hyperlink jumps.
boolean	getOpenInNewWindow() Gets whether to open the destination site in a new web browser window.
java.lang.String	getScreenTip() Gets the ScreenTip text for the hyperlink.
Inline	getSourceNode()
java.lang.String	getSubAddress() Gets a location in the file, such as a bookmark, where this hyperlink jumps.
int	getSwitchType(java.lang.String switchName)
java.lang.String	getTarget() Gets the target to which the link should be redirected.
boolean	isImageMap() Gets whether to append coordinates to the hyperlink for a server-side image map.
void	isImageMap(boolean value) Sets whether to append coordinates to the hyperlink for a server-side image map.
protected boolean	needStoreOldResultNodes()
void	setAddress(java.lang.String value) Sets a location where this hyperlink jumps.
void	setOpenInNewWindow(boolean value) Sets whether to open the destination site in a new web browser window.
void	setScreenTip(java.lang.String value) Sets the ScreenTip text for the hyperlink.
void	setSubAddress(java.lang.String value) Sets a location in the file, such as a bookmark, where this hyperlink jumps.
void	setTarget(java.lang.String value) Sets the target to which the link should be redirected.

Methods inherited from class com.aspose.words.Field

getDisplayResult, getEnd, getFieldCode, getFieldCode, getFormat, getLocaleId, getResult, getSeparator, getStart, getType, isDirty, isDirty, isLocked, isLocked, remove, setLocaleId, setResult, unlink, update, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

needStoreOldResultNodes

protected boolean needStoreOldResultNodes()

Overrides:

needStoreOldResultNodes in class Field

getTarget

public java.lang.String getTarget()

Gets the target to which the link should be redirected.

Examples:

Shows how to use HYPERLINK fields to link to documents in the local file system.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 FieldHyperlink field = (FieldHyperlink) builder.insertField(FieldType.FIELD_HYPERLINK, true);

 // When we click this HYPERLINK field in Microsoft Word,
 // it will open the linked document and then place the cursor at the specified bookmark.
 field.setAddress(getMyDir() + "Bookmarks.docx");
 field.setSubAddress("MyBookmark3");
 field.setScreenTip("Open " + field.getAddress() + " on bookmark " + field.getSubAddress() + " in a new window");

 builder.writeln();

 // When we click this HYPERLINK field in Microsoft Word,
 // it will open the linked document, and automatically scroll down to the specified iframe.
 field = (FieldHyperlink) builder.insertField(FieldType.FIELD_HYPERLINK, true);
 field.setAddress(getMyDir() + "Iframes.html");
 field.setScreenTip("Open " + field.getAddress());
 field.setTarget("iframe_3");
 field.setOpenInNewWindow(true);
 field.isImageMap(false);

 doc.updateFields();
 doc.save(getArtifactsDir() + "Field.HYPERLINK.docx");
 
 

Returns:

The target to which the link should be redirected.

setTarget

public void setTarget(java.lang.String value)
               throws java.lang.Exception

Sets the target to which the link should be redirected.

Examples:

Shows how to use HYPERLINK fields to link to documents in the local file system.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 FieldHyperlink field = (FieldHyperlink) builder.insertField(FieldType.FIELD_HYPERLINK, true);

 // When we click this HYPERLINK field in Microsoft Word,
 // it will open the linked document and then place the cursor at the specified bookmark.
 field.setAddress(getMyDir() + "Bookmarks.docx");
 field.setSubAddress("MyBookmark3");
 field.setScreenTip("Open " + field.getAddress() + " on bookmark " + field.getSubAddress() + " in a new window");

 builder.writeln();

 // When we click this HYPERLINK field in Microsoft Word,
 // it will open the linked document, and automatically scroll down to the specified iframe.
 field = (FieldHyperlink) builder.insertField(FieldType.FIELD_HYPERLINK, true);
 field.setAddress(getMyDir() + "Iframes.html");
 field.setScreenTip("Open " + field.getAddress());
 field.setTarget("iframe_3");
 field.setOpenInNewWindow(true);
 field.isImageMap(false);

 doc.updateFields();
 doc.save(getArtifactsDir() + "Field.HYPERLINK.docx");
 
 

Parameters:

value - The target to which the link should be redirected.

Throws:

java.lang.Exception

getAddress

public java.lang.String getAddress()

Gets a location where this hyperlink jumps.

Examples:

Shows how to use HYPERLINK fields to link to documents in the local file system.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 FieldHyperlink field = (FieldHyperlink) builder.insertField(FieldType.FIELD_HYPERLINK, true);

 // When we click this HYPERLINK field in Microsoft Word,
 // it will open the linked document and then place the cursor at the specified bookmark.
 field.setAddress(getMyDir() + "Bookmarks.docx");
 field.setSubAddress("MyBookmark3");
 field.setScreenTip("Open " + field.getAddress() + " on bookmark " + field.getSubAddress() + " in a new window");

 builder.writeln();

 // When we click this HYPERLINK field in Microsoft Word,
 // it will open the linked document, and automatically scroll down to the specified iframe.
 field = (FieldHyperlink) builder.insertField(FieldType.FIELD_HYPERLINK, true);
 field.setAddress(getMyDir() + "Iframes.html");
 field.setScreenTip("Open " + field.getAddress());
 field.setTarget("iframe_3");
 field.setOpenInNewWindow(true);
 field.isImageMap(false);

 doc.updateFields();
 doc.save(getArtifactsDir() + "Field.HYPERLINK.docx");
 
 

Returns:

A location where this hyperlink jumps.

setAddress

public void setAddress(java.lang.String value)
                throws java.lang.Exception

Sets a location where this hyperlink jumps.

Examples:

Shows how to use HYPERLINK fields to link to documents in the local file system.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 FieldHyperlink field = (FieldHyperlink) builder.insertField(FieldType.FIELD_HYPERLINK, true);

 // When we click this HYPERLINK field in Microsoft Word,
 // it will open the linked document and then place the cursor at the specified bookmark.
 field.setAddress(getMyDir() + "Bookmarks.docx");
 field.setSubAddress("MyBookmark3");
 field.setScreenTip("Open " + field.getAddress() + " on bookmark " + field.getSubAddress() + " in a new window");

 builder.writeln();

 // When we click this HYPERLINK field in Microsoft Word,
 // it will open the linked document, and automatically scroll down to the specified iframe.
 field = (FieldHyperlink) builder.insertField(FieldType.FIELD_HYPERLINK, true);
 field.setAddress(getMyDir() + "Iframes.html");
 field.setScreenTip("Open " + field.getAddress());
 field.setTarget("iframe_3");
 field.setOpenInNewWindow(true);
 field.isImageMap(false);

 doc.updateFields();
 doc.save(getArtifactsDir() + "Field.HYPERLINK.docx");
 
 

Parameters:

value - A location where this hyperlink jumps.

Throws:

java.lang.Exception

getSubAddress

public java.lang.String getSubAddress()

Gets a location in the file, such as a bookmark, where this hyperlink jumps.

Examples:

Shows how to use HYPERLINK fields to link to documents in the local file system.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 FieldHyperlink field = (FieldHyperlink) builder.insertField(FieldType.FIELD_HYPERLINK, true);

 // When we click this HYPERLINK field in Microsoft Word,
 // it will open the linked document and then place the cursor at the specified bookmark.
 field.setAddress(getMyDir() + "Bookmarks.docx");
 field.setSubAddress("MyBookmark3");
 field.setScreenTip("Open " + field.getAddress() + " on bookmark " + field.getSubAddress() + " in a new window");

 builder.writeln();

 // When we click this HYPERLINK field in Microsoft Word,
 // it will open the linked document, and automatically scroll down to the specified iframe.
 field = (FieldHyperlink) builder.insertField(FieldType.FIELD_HYPERLINK, true);
 field.setAddress(getMyDir() + "Iframes.html");
 field.setScreenTip("Open " + field.getAddress());
 field.setTarget("iframe_3");
 field.setOpenInNewWindow(true);
 field.isImageMap(false);

 doc.updateFields();
 doc.save(getArtifactsDir() + "Field.HYPERLINK.docx");
 
 

Returns:

A location in the file, such as a bookmark, where this hyperlink jumps.

setSubAddress

public void setSubAddress(java.lang.String value)
                   throws java.lang.Exception

Sets a location in the file, such as a bookmark, where this hyperlink jumps.

Examples:

Shows how to use HYPERLINK fields to link to documents in the local file system.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 FieldHyperlink field = (FieldHyperlink) builder.insertField(FieldType.FIELD_HYPERLINK, true);

 // When we click this HYPERLINK field in Microsoft Word,
 // it will open the linked document and then place the cursor at the specified bookmark.
 field.setAddress(getMyDir() + "Bookmarks.docx");
 field.setSubAddress("MyBookmark3");
 field.setScreenTip("Open " + field.getAddress() + " on bookmark " + field.getSubAddress() + " in a new window");

 builder.writeln();

 // When we click this HYPERLINK field in Microsoft Word,
 // it will open the linked document, and automatically scroll down to the specified iframe.
 field = (FieldHyperlink) builder.insertField(FieldType.FIELD_HYPERLINK, true);
 field.setAddress(getMyDir() + "Iframes.html");
 field.setScreenTip("Open " + field.getAddress());
 field.setTarget("iframe_3");
 field.setOpenInNewWindow(true);
 field.isImageMap(false);

 doc.updateFields();
 doc.save(getArtifactsDir() + "Field.HYPERLINK.docx");
 
 

Parameters:

value - A location in the file, such as a bookmark, where this hyperlink jumps.

Throws:

java.lang.Exception

isImageMap

public boolean isImageMap()

Gets whether to append coordinates to the hyperlink for a server-side image map.

Examples:

Shows how to use HYPERLINK fields to link to documents in the local file system.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 FieldHyperlink field = (FieldHyperlink) builder.insertField(FieldType.FIELD_HYPERLINK, true);

 // When we click this HYPERLINK field in Microsoft Word,
 // it will open the linked document and then place the cursor at the specified bookmark.
 field.setAddress(getMyDir() + "Bookmarks.docx");
 field.setSubAddress("MyBookmark3");
 field.setScreenTip("Open " + field.getAddress() + " on bookmark " + field.getSubAddress() + " in a new window");

 builder.writeln();

 // When we click this HYPERLINK field in Microsoft Word,
 // it will open the linked document, and automatically scroll down to the specified iframe.
 field = (FieldHyperlink) builder.insertField(FieldType.FIELD_HYPERLINK, true);
 field.setAddress(getMyDir() + "Iframes.html");
 field.setScreenTip("Open " + field.getAddress());
 field.setTarget("iframe_3");
 field.setOpenInNewWindow(true);
 field.isImageMap(false);

 doc.updateFields();
 doc.save(getArtifactsDir() + "Field.HYPERLINK.docx");
 
 

Returns:

Whether to append coordinates to the hyperlink for a server-side image map.

isImageMap

public void isImageMap(boolean value)
                throws java.lang.Exception

Sets whether to append coordinates to the hyperlink for a server-side image map.

Examples:

Shows how to use HYPERLINK fields to link to documents in the local file system.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 FieldHyperlink field = (FieldHyperlink) builder.insertField(FieldType.FIELD_HYPERLINK, true);

 // When we click this HYPERLINK field in Microsoft Word,
 // it will open the linked document and then place the cursor at the specified bookmark.
 field.setAddress(getMyDir() + "Bookmarks.docx");
 field.setSubAddress("MyBookmark3");
 field.setScreenTip("Open " + field.getAddress() + " on bookmark " + field.getSubAddress() + " in a new window");

 builder.writeln();

 // When we click this HYPERLINK field in Microsoft Word,
 // it will open the linked document, and automatically scroll down to the specified iframe.
 field = (FieldHyperlink) builder.insertField(FieldType.FIELD_HYPERLINK, true);
 field.setAddress(getMyDir() + "Iframes.html");
 field.setScreenTip("Open " + field.getAddress());
 field.setTarget("iframe_3");
 field.setOpenInNewWindow(true);
 field.isImageMap(false);

 doc.updateFields();
 doc.save(getArtifactsDir() + "Field.HYPERLINK.docx");
 
 

Parameters:

value - Whether to append coordinates to the hyperlink for a server-side image map.

Throws:

java.lang.Exception

getOpenInNewWindow

public boolean getOpenInNewWindow()

Gets whether to open the destination site in a new web browser window.

Examples:

Shows how to use HYPERLINK fields to link to documents in the local file system.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 FieldHyperlink field = (FieldHyperlink) builder.insertField(FieldType.FIELD_HYPERLINK, true);

 // When we click this HYPERLINK field in Microsoft Word,
 // it will open the linked document and then place the cursor at the specified bookmark.
 field.setAddress(getMyDir() + "Bookmarks.docx");
 field.setSubAddress("MyBookmark3");
 field.setScreenTip("Open " + field.getAddress() + " on bookmark " + field.getSubAddress() + " in a new window");

 builder.writeln();

 // When we click this HYPERLINK field in Microsoft Word,
 // it will open the linked document, and automatically scroll down to the specified iframe.
 field = (FieldHyperlink) builder.insertField(FieldType.FIELD_HYPERLINK, true);
 field.setAddress(getMyDir() + "Iframes.html");
 field.setScreenTip("Open " + field.getAddress());
 field.setTarget("iframe_3");
 field.setOpenInNewWindow(true);
 field.isImageMap(false);

 doc.updateFields();
 doc.save(getArtifactsDir() + "Field.HYPERLINK.docx");
 
 

Returns:

Whether to open the destination site in a new web browser window.

setOpenInNewWindow

public void setOpenInNewWindow(boolean value)
                        throws java.lang.Exception

Sets whether to open the destination site in a new web browser window.

Examples:

Shows how to use HYPERLINK fields to link to documents in the local file system.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 FieldHyperlink field = (FieldHyperlink) builder.insertField(FieldType.FIELD_HYPERLINK, true);

 // When we click this HYPERLINK field in Microsoft Word,
 // it will open the linked document and then place the cursor at the specified bookmark.
 field.setAddress(getMyDir() + "Bookmarks.docx");
 field.setSubAddress("MyBookmark3");
 field.setScreenTip("Open " + field.getAddress() + " on bookmark " + field.getSubAddress() + " in a new window");

 builder.writeln();

 // When we click this HYPERLINK field in Microsoft Word,
 // it will open the linked document, and automatically scroll down to the specified iframe.
 field = (FieldHyperlink) builder.insertField(FieldType.FIELD_HYPERLINK, true);
 field.setAddress(getMyDir() + "Iframes.html");
 field.setScreenTip("Open " + field.getAddress());
 field.setTarget("iframe_3");
 field.setOpenInNewWindow(true);
 field.isImageMap(false);

 doc.updateFields();
 doc.save(getArtifactsDir() + "Field.HYPERLINK.docx");
 
 

Parameters:

value - Whether to open the destination site in a new web browser window.

Throws:

java.lang.Exception

getScreenTip

public java.lang.String getScreenTip()

Gets the ScreenTip text for the hyperlink.

Examples:

Shows how to use HYPERLINK fields to link to documents in the local file system.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 FieldHyperlink field = (FieldHyperlink) builder.insertField(FieldType.FIELD_HYPERLINK, true);

 // When we click this HYPERLINK field in Microsoft Word,
 // it will open the linked document and then place the cursor at the specified bookmark.
 field.setAddress(getMyDir() + "Bookmarks.docx");
 field.setSubAddress("MyBookmark3");
 field.setScreenTip("Open " + field.getAddress() + " on bookmark " + field.getSubAddress() + " in a new window");

 builder.writeln();

 // When we click this HYPERLINK field in Microsoft Word,
 // it will open the linked document, and automatically scroll down to the specified iframe.
 field = (FieldHyperlink) builder.insertField(FieldType.FIELD_HYPERLINK, true);
 field.setAddress(getMyDir() + "Iframes.html");
 field.setScreenTip("Open " + field.getAddress());
 field.setTarget("iframe_3");
 field.setOpenInNewWindow(true);
 field.isImageMap(false);

 doc.updateFields();
 doc.save(getArtifactsDir() + "Field.HYPERLINK.docx");
 
 

Returns:

The ScreenTip text for the hyperlink.

setScreenTip

public void setScreenTip(java.lang.String value)
                  throws java.lang.Exception

Sets the ScreenTip text for the hyperlink.

Examples:

Shows how to use HYPERLINK fields to link to documents in the local file system.

 
 Document doc = new Document();
 DocumentBuilder builder = new DocumentBuilder(doc);

 FieldHyperlink field = (FieldHyperlink) builder.insertField(FieldType.FIELD_HYPERLINK, true);

 // When we click this HYPERLINK field in Microsoft Word,
 // it will open the linked document and then place the cursor at the specified bookmark.
 field.setAddress(getMyDir() + "Bookmarks.docx");
 field.setSubAddress("MyBookmark3");
 field.setScreenTip("Open " + field.getAddress() + " on bookmark " + field.getSubAddress() + " in a new window");

 builder.writeln();

 // When we click this HYPERLINK field in Microsoft Word,
 // it will open the linked document, and automatically scroll down to the specified iframe.
 field = (FieldHyperlink) builder.insertField(FieldType.FIELD_HYPERLINK, true);
 field.setAddress(getMyDir() + "Iframes.html");
 field.setScreenTip("Open " + field.getAddress());
 field.setTarget("iframe_3");
 field.setOpenInNewWindow(true);
 field.isImageMap(false);

 doc.updateFields();
 doc.save(getArtifactsDir() + "Field.HYPERLINK.docx");
 
 

Parameters:

value - The ScreenTip text for the hyperlink.

Throws:

java.lang.Exception

getSwitchType

public int getSwitchType(java.lang.String switchName)

getSourceNode

public Inline getSourceNode()