UrlAction

Represents an action linking to an external URL.

public class UrlAction : OutlineAnnotationAction
Public Class UrlAction
    Inherits OutlineAnnotationAction

Inheritance: ObjectActionOutlineAnnotationActionUrlAction

Licensing Info

This class is a full DynamicPDF Core Suite feature. One of the following is required for non-evaluation usage:

Examples

This example shows how to create an outline for a PDF document using UrlAction.
Imports System
Imports ceTe.DynamicPDF
     
Module MyModule
     		
    Sub Main()
     		
        ' Create a PDF Document
        Dim MyDocument As Document = New Document
     
        ' Add three blank pages
        MyDocument.Pages.Add(New Page(PageSize.Letter))
        MyDocument.Pages.Add(New Page(PageSize.Letter))
        MyDocument.Pages.Add(New Page(PageSize.Letter))
     
        ' Add a top level outline and set properties
        Dim MyOutline1 As Outline = MyDocument.Outlines.Add("Outline1")
        MyOutline1.Style = TextStyle.Bold
        MyOutline1.Color = New RgbColor(1.0F, 0.0F, 0.0F)
     
        ' Add child outlines
        Dim MyOutline1A As Outline = MyOutline1.ChildOutlines.Add("Outline1A", New UrlAction("http://www.mydomain.com"))
        MyOutline1A.Expanded = False
        Dim MyOutline1A1 As Outline = MyOutline1A.ChildOutlines.Add("Outline1A1", New XYDestination(2, 0, 0))
        Dim MyOutline1A2 As Outline = MyOutline1A.ChildOutlines.Add("Outline1A2", New ZoomDestination(2, PageZoom.FitHeight))
        Dim MyOutline1B As Outline = MyOutline1.ChildOutlines.Add("Outline1B", New ZoomDestination(2, PageZoom.FitWidth))
     		
        ' Add a second top level outline
        Dim MyOutline2 As Outline = MyDocument.Outlines.Add("Outline2", New XYDestination(3, 0, 300))
     		
        ' Add a child outline
        Dim MyOutline2A As Outline = MyOutline2.ChildOutlines.Add("Outline2A")
     		
        ' Save the PDF document
        MyDocument.Draw("C:\MyDocument.pdf")
     		
    End Sub
End Module
using System;
using ceTe.DynamicPDF;

public class Example
{
    public static void CreatePDF(string outputPath)
    {
        // Create a PDF Document
        Document document = new Document();

        // Add three blank pages
        document.Pages.Add(new Page(PageSize.Letter));
        document.Pages.Add(new Page(PageSize.Letter));
        document.Pages.Add(new Page(PageSize.Letter));

        // Add a top level outline and set properties
        Outline outline1 = document.Outlines.Add("Outline1");
        outline1.Style = TextStyle.Bold;
        outline1.Color = new RgbColor(1.0f, 0.0f, 0.0f);

        // Add child outlines
        Outline outline1A = outline1.ChildOutlines.Add("Outline1A", new UrlAction("http://www.mydomain.com"));
        outline1A.Expanded = false;
        Outline outline1A1 = outline1A.ChildOutlines.Add("Outline1A1", new XYDestination(2, 0, 0));
        Outline outline1A2 = outline1A.ChildOutlines.Add("Outline1A2", new ZoomDestination(2, PageZoom.FitHeight));
        Outline outline1B = outline1.ChildOutlines.Add("Outline1B", new ZoomDestination(2, PageZoom.FitWidth));

        // Add a second top level outline
        Outline outline2 = document.Outlines.Add("Outline2", new XYDestination(3, 0, 300));

        // Add a child outline
        Outline outline2A = outline2.ChildOutlines.Add("Outline2A");

        // Save the PDF document
        document.Draw(outputPath);
    }
}

Remarks

This class can be used to specify a URL when defining a Link or a Bookmark .

Constructors

UrlAction(String)Initializes a new instance of the UrlAction class.

Properties

NextActionGets or sets next action for the current action.
(Inherited from OutlineAnnotationAction)
URLGets or sets the URL launched by the action.

Methods

Draw(DocumentWriter)Draws the action to the specified DocumentWriter object.
Equals(Object)Determines whether the specified Object is equal to the current Object .
(Inherited from Object)
GetHashCode()Serves as a hash function for a particular type.
(Inherited from Object)
GetType()Gets the Type of the current instance.
(Inherited from Object)
ToString()Returns a String that represents the current Object .
(Inherited from Object)

See Also

ceTe.DynamicPDF

In this topic