asposediagram.api

asposediagram.api

Class Hyperlink

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

Example:

var aspose = aspose || {};
aspose.diagram = require("aspose.diagram");

diagram = new aspose.diagram.Diagram("Hyperlinks.vsdx");

// get page by name
var page = diagram.getPages().getPage("Page-1");
// get shape by ID
var shape = page.getShapes().getShape(2);

// initialize Hyperlink object
var hyperlink = new aspose.diagram.Hyperlink();
// set address value
hyperlink.getAddress().setValue("https://www.aspose.com/");
// set sub address value
hyperlink.getSubAddress().setValue("Sub address here");
// set description value
hyperlink.getDescription().setValue("Description here");
// set name
hyperlink.setName("MyHyperLink");

// add hyperlink to the shape
shape.getHyperlinks().add(hyperlink);

diagram.save("out-AddHyperlinkToShape.vsdx", aspose.diagram.SaveFileFormat.VSDX);

Constructor Summary
Hyperlink()
Constructor.
 
Property Getters/Setters Summary
methodgetAddress()
Specifies a URL address, DOS file name, or UNC path to jump to.
methodgetDefault()
Specifies the default hyperlink for a shape or page.
methodgetDel()
method
setDel(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.
methodgetDescription()
Description element contains a text string that describes the hyperlink.
methodgetExtraInfo()
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.
methodgetFrame()
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.
methodgetID()
method
setID(value)
           The unique ID of the element within its parent element.
methodgetInvisible()
Invisible element indicates whether a hyperlink appears on the shortcut menu for a shape or page.
methodgetName()
method
setName(value)
           The name of the element.
methodgetNameU()
method
setNameU(value)
           The universal name of the element.
methodgetNewWindow()
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.
methodgetSortKey()
Invisible element indicates whether a hyperlink appears on the shortcut menu for a shape or page.
methodgetSubAddress()
Specifies a location within the target document to link to.
 
Method Summary
methoddeepClone()
Creates deep copy of this instance.
 

    • Constructor Detail

      • Hyperlink

        Hyperlink()
        Constructor.

    • Property Getters/Setters Detail

      • getName/setName : String 

        String getName() / setName(value)
        The name of the element.

      • getNameU/setNameU : String 

        String getNameU() / setNameU(value)
        The universal name of the element.

      • getID/setID : int 

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

      • getDel/setDel : int 

        int getDel() / setDel(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 : Str2Value 

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

      • getAddress : Str2Value 

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

      • getSubAddress : Str2Value 

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

      • getExtraInfo : Str2Value 

        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 : Str2Value 

        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 : BoolValue 

        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 : BoolValue 

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

      • getInvisible : BoolValue 

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

      • getSortKey : Str2Value 

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

    • Method Detail

      • deepClone

        Object deepClone()
        Creates deep copy of this instance.
        Returns: