Class PdfExplicitRemoteGoToDestination

Namespace

iText.Kernel.Pdf.Navigation

Assembly

itext.kernel.dll

This class shall be used for creation of destinations, associated Remote Go-To and Embedded Go-To actions only, i.e. the destination point is in another PDF.

public class PdfExplicitRemoteGoToDestination : PdfDestination

Inheritance

object

PdfObjectWrapper<PdfObject>

PdfDestination

PdfExplicitRemoteGoToDestination

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 Remote Go-To and Embedded Go-To actions only, i.e. the destination point is in another PDF. If you need to create a destination, associated with an object inside current PDF, you should use PdfExplicitDestination class instead.

Constructors

PdfExplicitRemoteGoToDestination()

public PdfExplicitRemoteGoToDestination()

PdfExplicitRemoteGoToDestination(PdfArray)

public PdfExplicitRemoteGoToDestination(PdfArray pdfObject)

Parameters

pdfObject PdfArray

Methods

Create(int, PdfName, float, float, float, float, float)

Creates a PdfExplicitRemoteGoToDestination associated with an object in another PDF document.

public static PdfExplicitRemoteGoToDestination Create(int pageNum, PdfName type, float left, float bottom, float right, float top, float zoom)

Parameters

pageNum int

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

PdfExplicitRemoteGoToDestination

newly created PdfExplicitDestination

CreateFit(int)

Creates PdfExplicitRemoteGoToDestination.

public static PdfExplicitRemoteGoToDestination CreateFit(int pageNum)

Parameters

pageNum int

the destination page

Returns

PdfExplicitRemoteGoToDestination

newly created PdfExplicitRemoteGoToDestination

Remarks

Creates PdfExplicitRemoteGoToDestination . 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(int)

Creates PdfExplicitRemoteGoToDestination.

public static PdfExplicitRemoteGoToDestination CreateFitB(int pageNum)

Parameters

pageNum int

the destination page

Returns

PdfExplicitRemoteGoToDestination

newly created PdfExplicitRemoteGoToDestination

Remarks

Creates PdfExplicitRemoteGoToDestination . 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(int, float)

Creates PdfExplicitRemoteGoToDestination.

public static PdfExplicitRemoteGoToDestination CreateFitBH(int pageNum, float top)

Parameters

pageNum int

the destination page

top float

the Y coordinate of the upper edge of the destination rectangle

Returns

PdfExplicitRemoteGoToDestination

newly created PdfExplicitRemoteGoToDestination

Remarks

Creates PdfExplicitRemoteGoToDestination . 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(int, float)

Creates PdfExplicitRemoteGoToDestination.

public static PdfExplicitRemoteGoToDestination CreateFitBV(int pageNum, float left)

Parameters

pageNum int

the destination page

left float

the X coordinate of the left edge of the destination rectangle

Returns

PdfExplicitRemoteGoToDestination

newly created PdfExplicitRemoteGoToDestination

Remarks

Creates PdfExplicitRemoteGoToDestination . 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(int, float)

Creates PdfExplicitRemoteGoToDestination.

public static PdfExplicitRemoteGoToDestination CreateFitH(int pageNum, float top)

Parameters

pageNum int

the destination page

top float

the Y coordinate of the upper edge of the destination rectangle

Returns

PdfExplicitRemoteGoToDestination

newly created PdfExplicitRemoteGoToDestination

Remarks

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

CreateFitR(int, float, float, float, float)

Creates PdfExplicitRemoteGoToDestination.

public static PdfExplicitRemoteGoToDestination CreateFitR(int pageNum, float left, float bottom, float right, float top)

Parameters

pageNum int

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

PdfExplicitRemoteGoToDestination

newly created PdfExplicitRemoteGoToDestination

Remarks

Creates PdfExplicitRemoteGoToDestination . 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(int, float)

Creates PdfExplicitRemoteGoToDestination.

public static PdfExplicitRemoteGoToDestination CreateFitV(int pageNum, float left)

Parameters

pageNum int

the destination page

left float

the X coordinate of the left edge of the destination rectangle

Returns

PdfExplicitRemoteGoToDestination

newly created PdfExplicitRemoteGoToDestination

Remarks

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

CreateXYZ(int, float, float, float)

Creates PdfExplicitRemoteGoToDestination.

public static PdfExplicitRemoteGoToDestination CreateXYZ(int pageNum, float left, float top, float zoom)

Parameters

pageNum int

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

PdfExplicitRemoteGoToDestination

newly created PdfExplicitRemoteGoToDestination

Remarks

Creates PdfExplicitRemoteGoToDestination . 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