Class PdfExplicitDestination

Namespace

iText.Kernel.Pdf.Navigation

Assembly

itext.kernel.dll

This class shall be used for creation of destinations, associated with outline items, annotations or actions within current document.

public class PdfExplicitDestination : PdfDestination

Inheritance

object

PdfObjectWrapper<PdfObject>

PdfDestination

PdfExplicitDestination

Inherited Members

PdfDestination.MakeDestination(PdfObject)

PdfObjectWrapper<PdfObject>.GetPdfObject()

PdfObjectWrapper<PdfObject>.MakeIndirect(PdfDocument, PdfIndirectReference)

PdfObjectWrapper<PdfObject>.MakeIndirect(PdfDocument)

PdfObjectWrapper<PdfObject>.SetModified()

PdfObjectWrapper<PdfObject>.Flush()

PdfObjectWrapper<PdfObject>.IsFlushed()

PdfObjectWrapper<PdfObject>.SetPdfObject(PdfObject)

PdfObjectWrapper<PdfObject>.SetForbidRelease()

PdfObjectWrapper<PdfObject>.UnsetForbidRelease()

PdfObjectWrapper<PdfObject>.EnsureUnderlyingObjectHasIndirectReference()

PdfObjectWrapper<PdfObject>.MarkObjectAsIndirect(PdfObject)

PdfObjectWrapper<PdfObject>.EnsureObjectIsAddedToDocument(PdfObject)

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

This class shall be used for creation of destinations, associated with outline items, annotations or actions within current document. If you need to create a destination, associated with an object in another PDF (e.g. Remote Go-To actions or Embedded Go-To actions), you should use PdfExplicitRemoteGoToDestination class instead. Note that despite methods with integer value for page parameter are deprecated in this class, Adobe Acrobat handles such destinations correctly, but removes them completely from a PDF, when it is saved as an optimized pdf with the "discard-invalid-links" option. Therefore it is strongly recommended to use methods accepting pdfPage instance, if the destination is inside of the current document.

Constructors

PdfExplicitDestination()

public PdfExplicitDestination()

PdfExplicitDestination(PdfArray)

public PdfExplicitDestination(PdfArray pdfObject)

Parameters

pdfObject PdfArray

Methods

Create(PdfPage, PdfName, float, float, float, float, float)

Creates a PdfExplicitDestination associated with an object inside current PDF document.

public static PdfExplicitDestination Create(PdfPage page, PdfName type, float left, float bottom, float right, float top, float zoom)

Parameters

page PdfPage

the destination page

type PdfName

a PdfName specifying one of the possible ways to define the area to be displayed. See ISO 32000-1, section 12.3.2.2 "Explicit Destinations", Table 151 – Destination syntax

left float

the X coordinate of the left edge of the destination rectangle

bottom float

the Y coordinate of the lower edge of the destination rectangle

right float

the X coordinate of the right edge of the destination rectangle

top float

the Y coordinate of the upper edge of the destination rectangle

zoom float

zoom factor

Returns

PdfExplicitDestination

newly created PdfExplicitDestination

CreateFit(PdfPage)

Creates PdfExplicitDestination.

public static PdfExplicitDestination CreateFit(PdfPage page)

Parameters

page PdfPage

the destination page

Returns

PdfExplicitDestination

newly created PdfExplicitDestination

Remarks

Creates PdfExplicitDestination . The designated page will be displayed with its contents magnified just enough to fit the entire page within the window both horizontally and vertically.

CreateFitB(PdfPage)

Creates PdfExplicitDestination.

public static PdfExplicitDestination CreateFitB(PdfPage page)

Parameters

page PdfPage

the destination page

Returns

PdfExplicitDestination

newly created PdfExplicitDestination

Remarks

Creates PdfExplicitDestination . The designated page will be displayed with its contents magnified just enough to fit its bounding box entirely within the window both horizontally and vertically.

CreateFitBH(PdfPage, float)

Creates PdfExplicitDestination.

public static PdfExplicitDestination CreateFitBH(PdfPage page, float top)

Parameters

page PdfPage

the destination page

top float

the Y coordinate of the upper edge of the destination rectangle

Returns

PdfExplicitDestination

newly created PdfExplicitDestination

Remarks

Creates PdfExplicitDestination . The designated page will be displayed with its contents magnified just enough to fit the entire width of its bounding box within the window.

CreateFitBV(PdfPage, float)

Creates PdfExplicitDestination.

public static PdfExplicitDestination CreateFitBV(PdfPage page, float left)

Parameters

page PdfPage

the destination page

left float

the X coordinate of the left edge of the destination rectangle

Returns

PdfExplicitDestination

newly created PdfExplicitDestination

Remarks

Creates PdfExplicitDestination . The designated page will be displayed with its contents magnified just enough to fit the entire height of its bounding box within the window.

CreateFitH(PdfPage, float)

Creates PdfExplicitDestination.

public static PdfExplicitDestination CreateFitH(PdfPage page, float top)

Parameters

page PdfPage

the destination page

top float

the Y coordinate of the upper edge of the destination rectangle

Returns

PdfExplicitDestination

newly created PdfExplicitDestination

Remarks

Creates PdfExplicitDestination . The designated page will be displayed with its contents magnified just enough to fit the entire width of the page within the window.

CreateFitR(PdfPage, float, float, float, float)

Creates PdfExplicitDestination.

public static PdfExplicitDestination CreateFitR(PdfPage page, float left, float bottom, float right, float top)

Parameters

page PdfPage

the destination page

left float

the X coordinate of the left edge of the destination rectangle

bottom float

the Y coordinate of the lower edge of the destination rectangle

right float

the X coordinate of the right edge of the destination rectangle

top float

the Y coordinate of the upper edge of the destination rectangle

Returns

PdfExplicitDestination

newly created PdfExplicitDestination

Remarks

Creates PdfExplicitDestination . The designated page will be displayed with its contents magnified just enough to fit the rectangle specified by the coordinates left, bottom, right, and top entirely within the window both horizontally and vertically.

CreateFitV(PdfPage, float)

Creates PdfExplicitDestination.

public static PdfExplicitDestination CreateFitV(PdfPage page, float left)

Parameters

page PdfPage

the destination page

left float

the X coordinate of the left edge of the destination rectangle

Returns

PdfExplicitDestination

newly created PdfExplicitDestination

Remarks

Creates PdfExplicitDestination . The designated page will be displayed with its contents magnified just enough to fit the entire height of the page within the window.

CreateXYZ(PdfPage, float, float, float)

Creates PdfExplicitDestination.

public static PdfExplicitDestination CreateXYZ(PdfPage page, float left, float top, float zoom)

Parameters

page PdfPage

the destination page

left float

the X coordinate of the left edge of the destination rectangle

top float

the Y coordinate of the upper edge of the destination rectangle

zoom float

zoom factor

Returns

PdfExplicitDestination

newly created PdfExplicitDestination

Remarks

Creates PdfExplicitDestination . The designated page will be displayed with its contents magnified by the factor zoom and positioned at the upper-left corner of the window.

GetDestinationPage(IPdfNameTreeAccess)

public override PdfObject GetDestinationPage(IPdfNameTreeAccess names)

Parameters

names IPdfNameTreeAccess

Returns

PdfObject

IsWrappedObjectMustBeIndirect()

protected override bool IsWrappedObjectMustBeIndirect()

Returns

bool