SetHyperlinkURL, DocSetHyperLinkURL

The SetHyperlinkURL and DocSetHyperLinkURL methods create hyperlinks to external locations such as http://www.amyuni.com and ftp:// ftp.amyuni.com. When the document is opened and the hyperlink is clicked, the default web browser will be launched.

 

Syntax

ActiveX:

System.Boolean SetHyperLinkURL(System.Int32 PageNumber, System.Int32 xStart, System.Int32 yStart, System.Int32 xEnd, System.Int32 yEnd, System.String URL)

DLL:

int DocSetHyperLinkURL(EXTDOCHANDLE edhDocument, long PageNumber, long xStart, long yStart, long xEnd, long yEnd, LPCSTR URL)

 

Parameters

PageNumber

Number of the page where the hyperlink should be created.

xStart

X-coordinate of the top left part of the rectangle in twips.

yStart

Y-coordinate of the top left part of the rectangle in twips.

xEnd

X-coordinate of the bottom right part of the rectangle in twips.

yEnd

Y-coordinate of the bottom right part of the rectangle in twips.

URL

Target URL.

edhDocument

Handle Returned by DocOpen.

 

Return Value

The return value is True if the SetHyperLinkURL method succeed. Otherwise, False If the SetHyperLinkURL method fails.

The return value is zero if the DocSetHyperLinkURL method succeed. If the DocSetHyperLinkURL method fails, a negative value will returned.

 

Remarks

 

Member of CDIntfEx.Document.

 

Example

Public Sub Sample()

    ' Constants for Activation codes

    Const strLicenseTo As String = "Amyuni PDF Converter Evaluation"

    Const strActivationCode As String = "07EFCDAB0100010025AFF1801CB9441306C5739F7D452154D8833B9CECBA2ADE79E3762A69FFC354528A5F4A5811BE3204A0A439F5BA"

 

    ' Declare a new cdintfex document if it does not exist in the form.

    Dim pdfDoc As New CDIntfEx.Document

 

    ' The SetLicenseKey method should be called after creating an object of type 

    ' CDIntfEx.Document to activate the advanced methods that require the object 

    ' activation code to work properly

    pdfDoc.SetLicenseKey(strLicenseTo, strActivationCode)

 

    ' Open the document

    pdfDoc.Open("c:\temp\test.pdf")

 

    ' SetHyperLinkURL

    pdfDoc.SetHyperLinkURL(1, 0, 0, 500, 500, "http:// amyuni.com")

 

    ' Save the document

    pdfDoc.Save("c:\temp\hyperlink.pdf")

End Sub

public void Sample()

{

    // Constants for Activation codes

    const string strLicenseTo = "Amyuni PDF Converter Evaluation";

    const string strActivationCode = "07EFCDAB0100010025AFF1801CB9441306C5739F7D452154D8833B9CECBA2ADE79E3762A69FFC354528A5F4A5811BE3204A0A439F5BA";

 

    // Declare a new cdintfex document if it does not exist in the form.

    CDIntfEx.Document pdfDoc = new CDIntfEx.Document();

 

    // The SetLicenseKey method should be called after creating an object of type 

    // CDIntfEx.Document to activate the advanced methods that require the object 

    // activation code to work properly

    pdfDoc.SetLicenseKey(strLicenseTo, strActivationCode);

 

    // Open the document

    pdfDoc.Open(@"c:\temp\test.pdf");

 

    // SetHyperLinkURL

    pdfDoc.SetHyperLinkURL(1, 0, 0, 500, 500, "http:// amyuni.com");

 

    // Save the document

    pdfDoc.Save(@"c:\temp\hyperlink.pdf");

}

// PDF Converter Cpp.cpp : Defines the entry point for the console application.

// 

 

#include <Windows.h>

#include <string>

#include <iostream>

#include "CdIntf.h"

#pragma comment (lib, "CDIntf.lib")

 

using namespace std;

 

int main()

{

     // Constants for Activation codes

    #define strLicenseTo  "Amyuni PDF Converter Evaluation"

    #define strActivationCode "07EFCDAB0100010025AFF1801CB9441306C5739F7D452154D8833B9CECBA2ADE79E3762A69FFC354528A5F4A5811BE3204A0A439F5BA"

 

    // Declare a new cdintfex document if it does not exist in the form.

    EXTDOCHANDLE pdfDoc;

 

    // The SetLicenseKey method should be called after creating an object of type 

    // CDIntfEx.Document to activate the advanced methods that require the object 

    // activation code to work properly

    SetLicenseKeyA(strLicenseTo, strActivationCode);

 

    // Open the document

    LPBYTE passWord = nullptr;

    DocOpenA(&pdfDoc, "C:\temp\\test.pdf", passWord);

 

    // Set DocSetHyperLinkURL

    DocSetHyperLinkURLA(pdfDoc,  1, 0, 0, 500, 500, "http:// amyuni.com");

 

    // Save the document

    DocSaveA(pdfDoc, "C:\temp\\hyperlink.pdf");

 

    // Destroy pdfDoc object

    DocClose(pdfDoc);

    pdfDoc = nullptr;    

 

    return 0;

}

 

 package Example;

 

import com.jacob.activeX.ActiveXComponent;

import com.jacob.com.Dispatch;

import com.jacob.com.Variant;

 

public class Sample {

    public static void main(String[] args)

    {

        // Constants for Activation codes

        String strLicenseTo  = "Amyuni PDF Converter Evaluation";

        String strActivationCode = "07EFCDAB0100010025AFF1801CB9441306C5739F7D452154D8833B9CECBA2ADE79E3762A69FFC354528A5F4A5811BE3204A0A439F5BA";

 

        // Declare a new cdintfex document if it does not exist in the form.

        ActiveXComponent pdfDoc = new ActiveXComponent("CDIntfEx.Document.6.5"); 

 

        // The SetLicenseKey method should be called after creating an object of type 

        // CDIntfEx.Document to activate the advanced methods that require the object 

        // activation code to work properly

        Dispatch.call(pdfDoc, "SetLicenseKey", strLicenseTo, strActivationCode);

 

        // Open the document

        Dispatch.call(pdfDoc, "Open", "C:\temp\\test.pdf");

 

        // SetHyperLinkURL

        Dispatch.call(pdfDoc, "SetHyperLinkURL", 1, 0, 0, 500, 500, "http:// amyuni.com");

 

        // Save the document

        Dispatch.call(pdfDoc, "Save", "C:\temp\\hyperlink.pdf");

 

        // Destroy pdfDoc object

        pdfDoc = null;

    }

}

# Constants for Activation codes

$strLicenseTo  =  "Amyuni PDF Converter Evaluation"

$strActivationCode = "07EFCDAB0100010025AFF1801CB9441306C5739F7D452154D8833B9CECBA2ADE79E3762A69FFC354528A5F4A5811BE3204A0A439F5BA"

 

#Declare a new cdintfex document if it does not exist in the form.

$pdfDoc = New-Object -ComObject CDIntfEx.Document.6.5

 

#The SetLicenseKey method should be called after creating an object of type 

#CDIntfEx.Document to activate the advanced methods that require the object 

#activation code to work properly

[System.__ComObject].InvokeMember('SetLicenseKey', [System.Reflection.BindingFlags]::InvokeMethod,$null,$pdfDoc, @($strLicenseTo, $strActivationCode))

 

#Open the document

[System.__ComObject].InvokeMember('Open', [System.Reflection.BindingFlags]::InvokeMethod,$null,$pdfDoc,"c:\temp\test.pdf") 

 

#SetHyperLinkURL

[System.__ComObject].InvokeMember('SetHyperLinkURL', [System.Reflection.BindingFlags]::InvokeMethod,$null,$pdfDoc, 

    @(1, 0, 0, 500, 500, "http:// amyuni.com"))

 

#Save the document

[System.__ComObject].InvokeMember('Save', [System.Reflection.BindingFlags]::InvokeMethod,$null,$pdfDoc,"c:\temp\hyperlink.pdf") 

 

#Destroy pdfDoc object

$pdfDoc = $null  

' Constants for Activation codes

Const strLicenseTo = "Amyuni PDF Converter Evaluation"

Const strActivationCode = "07EFCDAB0100010025AFF1801CB9441306C5739F7D452154D8833B9CECBA2ADE79E3762A69FFC354528A5F4A5811BE3204A0A439F5BA"

 

' Declare a new Document object

Dim pdfDoc

Set pdfDoc = CreateObject("CDIntfEx.Document.6.5")

 

' The SetLicenseKey method should be called after creating an object of type 

' CDIntfEx.Document to activate the advanced methods that require the object 

' activation code to work properly

pdfDoc.SetLicenseKey strLicenseTo, strActivationCode

 

' Open the document

pdfDoc.Open "c:\temp\test.pdf"

 

' SetHyperLinkURL

pdfDoc.SetHyperLinkURL 1, 0, 0, 500, 500, "http:// amyuni.com"

 

' Save the document

pdfDoc.Save "c:\temp\hyperlink.pdf"

 

' Destroy pdfDoc object

Set pdfDoc = Nothing