Create a Hyperlink for a Shape

Introduction

Every type of shape has HyperlinkClick and HyperlinkMouseOver properties. You can set one of them to create a hyperlink. The entire shape becomes a link in that case.

cURL Example

Request

Create Request Token

curl -X POST "https://api.aspose.cloud/connect/token" -d "grant_type=client_credentials&client_id=MyClientId&client_secret=MyClientSecret" -H "Content-Type: application/x-www-form-urlencoded" -H "Accept: application/json"

Add Portion

curl -X PUT "https://api.aspose.cloud/v3.0/slides/MyPresentation.pptx/slides/1/shapes/2" -d "@shape.json" -H "Content-Type: text/json" -H "Authorization: Bearer AuthToken"

shape.json example

{
    "type": "Shape",
    "hyperlinkClick": {
        "actionType": "Hyperlink",
        "externalUrl": "https://docs.aspose.cloud/slides"
    }
}

Response

{
    "type": "Shape",
    "shapeType": "Rectangle",
    "name": "ShapeObject",
    "width": 500.0,
    "height": 200.0,
    "x": 100.0,
    "y":100.0,
    "lineFormat": {
        "alignment": "Center",
        "capStyle": "Flat",
        "dashStyle": "Solid",
        "joinStyle": "Round",
        "style": "Single",
        "miterLimit": 10.0,
        "width": 0.75
    },
    "hyperlinkClick": {
        "actionType": "Hyperlink",
        "externalUrl": "https://docs.aspose.cloud/slides"
    },
    "selfUri": {
        "href": "https://api.aspose.cloud/v3.0/slides/MyPresentation.pptx/slides/1/masterSlide/shapes/6",
        "relation": "self"
    }
}

SDKs

Using an SDK (API client) is the quickest way for a developer to speed up the development. An SDK takes care of a lot of low-level details of making requests and handling responses and lets you focus on writing code specific to your particular project. Check out our GitHub repository for a complete list of Aspose.Slides Cloud SDKs along with working examples, to get you started in no time. Please check Available SDKs article to learn how to add an SDK to your project.

SDK Examples

string fileName = "MyPresentation.pptx";
int slideIndex = 1;
int shapeIndex = 2;
SlidesApi api = new SlidesApi("MyClientId", "MyClientSecret");

Shape shape = new Shape
{
    HyperlinkClick = new Hyperlink
    {
        ActionType = Hyperlink.ActionTypeEnum.Hyperlink,
        ExternalUrl = "https://docs.aspose.cloud/slides"
    }
};
ShapeBase updatedShape = api.UpdateShape(fileName, slideIndex, shapeIndex, shape);
Console.WriteLine(updatedShape.HyperlinkClick.ExternalUrl); //https://docs.aspose.cloud/slides

Java

String fileName = "MyPresentation.pptx";
int slideIndex = 1;
int shapeIndex = 2;
SlidesApi api = new SlidesApi("MyClientId", "MyClientSecret");

Shape shape = new Shape();
Hyperlink hyperlink = new Hyperlink();
hyperlink.setActionType(Hyperlink.ActionTypeEnum.HYPERLINK);
hyperlink.setExternalUrl("https://docs.aspose.cloud/slides");
shape.setHyperlinkClick(hyperlink);
Shape updatedShape = (Shape)api.updateShape(fileName, slideIndex, shapeIndex, shape, null, null, null, null);
System.out.println(updatedShape.getHyperlinkClick().getExternalUrl()); //https://docs.aspose.cloud/slides

PHP

use Aspose\Slides\Cloud\Sdk\Api\Configuration;
use Aspose\Slides\Cloud\Sdk\Api\SlidesApi;
use Aspose\Slides\Cloud\Sdk\Model\Shape;
use Aspose\Slides\Cloud\Sdk\Model\Hyperlink;

$config = new Configuration();
$config->setAppSid("MyClientId");
$config->setAppKey("MyClientSecret");
$api = new SlidesApi(null, $config);

$fileName = "MyPresentation.pptx";
$slideIndex = 1;
$shapeIndex = 2;

$shape = new Shape();
$hyperlink = new Hyperlink();
$hyperlink->setActionType("Hyperlink");
$hyperlink->setExternalUrl("https://docs.aspose.cloud/slides");
$shape->setHyperlinkClick($hyperlink);
$updatedShape = $api->updateShape($fileName, $slideIndex, $shapeIndex, $shape);
print($updatedShape->getHyperlinkClick()->getExternalUrl()); //https://docs.aspose.cloud/slides

Ruby

Python

import asposeslidescloud

from asposeslidescloud.configuration import Configuration
from asposeslidescloud.apis.slides_api import SlidesApi
from asposeslidescloud.models.shape import Shape
from asposeslidescloud.models.hyperlink import Hyperlink

configuration = Configuration()
configuration.app_sid = 'MyClientId'
configuration.app_key = 'MyClientSecret'
api = SlidesApi(configuration)

file_name = "MyPresentation.pptx"
slide_index = 1
shape_index = 2

shape = Shape()
hyperlink = Hyperlink()
hyperlink.action_type = "Hyperlink"
hyperlink.external_url = "https://docs.aspose.cloud/slides"
shape.hyperlink_click = hyperlink
updated_shape = api.update_shape(file_name, slide_index, shape_index, shape)
print(len(updated_shape.hyperlink_click.external_url)) #https://docs.aspose.cloud/slides

Node.js

const CloudSdk = require("asposeslidescloud");
const api = new CloudSdk.SlidesApi("MyClientId", "MyClientSecret");

const fileName = "MyPresentation.pptx";
const slideIndex = 1;
const shapeIndex = 2;

const shape = new CloudSdk.Shape();
const hyperlink = new CloudSdk.Hyperlink();
hyperlink.actionType = CloudSdk.Hyperlink.ActionTypeEnum.Hyperlink;
hyperlink.externalUrl = "https://docs.aspose.cloud/slides";
shape.hyperlinkClick = hyperlink;
return api.updateShape(fileName, slideIndex, shapeIndex, shape).then(result => {
    console.log(result.body.hyperlinkClick.externalUrl); //https://docs.aspose.cloud/slides
});

cfg := asposeslidescloud.NewConfiguration()
cfg.AppSid = "MyClientId"
cfg.AppKey = "MyClientSecret"
api := asposeslidescloud.NewAPIClient(cfg)

fileName := "MyPresentation.pptx"
var slideIndex int32 = 1
var shapeIndex int32 = 2

shape := asposeslidescloud.NewShape()
hyperlink := asposeslidescloud.NewHyperlink()
hyperlink.ActionType = "Hyperlink"
hyperlink.ExternalUrl = "https://docs.aspose.cloud/slides"
shape.HyperlinkClick = hyperlink
updatedShape, _, e := api.SlidesApi.UpdateShape(fileName, slideIndex, shapeIndex, shape, "password", "", "", "")
if e != nil {
    fmt.Printf("Error: %v.", e)
    return
}
fmt.Printf("Hyperlink URL: %v.", updatedShape.GetHyperlinkClick().GetExternalUrl())

C++

Perl

Swift

SDK Source

The Aspose Cloud SDK’s can be downloaded from the following page: Available SDK’s

Create a Hyperlink for a Text Portion