com.aspose.diagram
Class Hyperlink

java.lang.Object
    extended by com.aspose.diagram.Hyperlink

public class Hyperlink 
extends java.lang.Object

Contains elements for creating multiple jumps between a shape or drawing page and another drawing page, another file, or a Web site.


Constructor Summary
Hyperlink()
           Constructor.
 
Property Getters/Setters Summary
Str2ValuegetAddress()
           Specifies a URL address, DOS file name, or UNC path to jump to.
BoolValuegetDefault()
           Specifies the default hyperlink for a shape or page.
intgetDel()
voidsetDel(int)
           A flag indicating whether the element has been deleted locally. A value of 1 indicates that the element was deleted locally. The value of the property is BOOL integer constant.
Str2ValuegetDescription()
           Description element contains a text string that describes the hyperlink.
Str2ValuegetExtraInfo()
           Contains information to be used in resolving a URL, such as the coordinates of an image map. For example, x=41 y=7 would specify the coordinates of an image map.
Str2ValuegetFrame()
           Contains the name of a frame to target when Microsoft Visio is open as an active document in a container application. The default is an empty string.
intgetID()
voidsetID(int)
           The unique ID of the element within its parent element.
BoolValuegetInvisible()
           Invisible element indicates whether a hyperlink appears on the shortcut menu for a shape or page.
java.lang.StringgetName()
voidsetName(java.lang.String)
           The name of the element.
java.lang.StringgetNameU()
voidsetNameU(java.lang.String)
           The universal name of the element.
BoolValuegetNewWindow()
           Specifies whether Microsoft Visio opens a window in a new location when it follows a hyperlink to open a Web page or another Visio document.
Str2ValuegetSortKey()
           Invisible element indicates whether a hyperlink appears on the shortcut menu for a shape or page.
Str2ValuegetSubAddress()
           Specifies a location within the target document to link to.
 
Method Summary
java.lang.ObjectdeepClone()
           Creates deep copy of this instance.
 

Constructor Detail

Hyperlink

public Hyperlink()
Constructor.

Property Getters/Setters Detail

getName/setName

public java.lang.String getName() / public void setName(java.lang.String value)
The name of the element.

getNameU/setNameU

public java.lang.String getNameU() / public void setNameU(java.lang.String value)
The universal name of the element.

getID/setID

public int getID() / public void setID(int value)
The unique ID of the element within its parent element.

getDel/setDel

public int getDel() / public void setDel(int value)
A flag indicating whether the element has been deleted locally. A value of 1 indicates that the element was deleted locally. The value of the property is BOOL integer constant.

getDescription

public Str2Value getDescription()
Description element contains a text string that describes the hyperlink.

getAddress

public Str2Value getAddress()
Specifies a URL address, DOS file name, or UNC path to jump to.

getSubAddress

public Str2Value getSubAddress()
Specifies a location within the target document to link to.

getExtraInfo

public Str2Value getExtraInfo()
Contains information to be used in resolving a URL, such as the coordinates of an image map. For example, x=41 y=7 would specify the coordinates of an image map.

getFrame

public Str2Value getFrame()
Contains the name of a frame to target when Microsoft Visio is open as an active document in a container application. The default is an empty string.

getNewWindow

public BoolValue getNewWindow()
Specifies whether Microsoft Visio opens a window in a new location when it follows a hyperlink to open a Web page or another Visio document.

getDefault

public BoolValue getDefault()
Specifies the default hyperlink for a shape or page.

getInvisible

public BoolValue getInvisible()
Invisible element indicates whether a hyperlink appears on the shortcut menu for a shape or page.

getSortKey

public Str2Value getSortKey()
Invisible element indicates whether a hyperlink appears on the shortcut menu for a shape or page.

Method Detail

deepClone

public java.lang.Object deepClone()
                throws java.lang.Exception
Creates deep copy of this instance.
Returns:

See Also:
          Aspose.Diagram Documentation - the home page for the Aspose.Diagram Product Documentation.
          Aspose.Diagram Support Forum - our preferred method of support.