PdfDestination Class


PdfDestination Class

Represents a destination in a pdf document.

Inheritance Hierarchy

SystemObject
SelectPdf.UniversalPdfDestination

Namespace: SelectPdf.Universal
Assembly: SelectPdf.HtmlToPdf.Universal (in SelectPdf.HtmlToPdf.Universal.dll) Version: 26.4

Syntax

Copy

public class PdfDestination

Public Class PdfDestination

The PdfDestination type exposes the following members.

Constructors

	Name	Description
	PdfDestination(PdfPage)	Constructs a pdf destination to the specified pdf page.
	PdfDestination(PdfPage, PointF)	Constructs a pdf destination to the specified location in the specified page.
	PdfDestination(PdfPage, PointF, PdfDestinationFitMode)	Constructs a destination to the specified location in the specified page and with the specified fit mode in the destination page.
	PdfDestination(PdfPage, Single, Single)	Constructs a pdf destination to the specified location in the specified page.
	PdfDestination(PdfPage, Single, Single, PdfDestinationFitMode)	Constructs a destination to the specified location in the specified page and with the specified fit mode in the destination page.

Top

Properties

	Name	Description
	FitMode	Gets or sets the auto-fit mode in the destination page.
	Location	Gets or sets the location point in the destination page.
	Page	Gets or sets the destination page.
	X	Gets or sets the X coordinate of the location point in the destination page, in points.
	Y	Gets or sets the Y coordinate of the location point in the destination page, in points.
	ZoomFactor	Gets or sets the zoom factor of the destination page when viewed in a pdf viewer.

Top

Methods

	Name	Description
	SetLocation	Sets both the X and Y coordinates of the location point in the destination page.

Top

Remarks

The pdf destination is used by links, bookmarks or open actions to jump at a specified position in the pdf document.

Example

Copy

PdfDocument document = new PdfDocument();
PdfPage page = document.AddPage();
PdfDestination destination = new PdfDestination(page, 0, 100);
destination.FitMode = PdfDestinationFitMode.EntirePageWidth;
document.Bookmarks.Add("Top of page", destination);
document.Save("out.pdf");
document.Close();

Dim document As New PdfDocument()
Dim page As PdfPage = document.AddPage()
Dim destination As New PdfDestination(page, 0, 100)
destination.FitMode = PdfDestinationFitMode.EntirePageWidth
document.Bookmarks.Add("Top of page", destination)
document.Save("out.pdf")
document.Close()

Reference

SelectPdf.Universal Namespace