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

Inheritance diagram for iText.Kernel.Pdf.Navigation.PdfExplicitDestination:

Public Member Functions
	PdfExplicitDestination (PdfArray pdfObject)

override PdfObject	GetDestinationPage (IPdfNameTreeAccess names)

Public Member Functions inherited from iText.Kernel.Pdf.PdfObjectWrapper< PdfObject >
virtual T	GetPdfObject ()

virtual iText.Kernel.Pdf.PdfObjectWrapper< T >	MakeIndirect (PdfDocument document, PdfIndirectReference reference)
	Marks object behind wrapper to be saved as indirect. More...

virtual iText.Kernel.Pdf.PdfObjectWrapper< T >	MakeIndirect (PdfDocument document)
	Marks object behind wrapper to be saved as indirect. More...

virtual iText.Kernel.Pdf.PdfObjectWrapper< T >	SetModified ()

virtual void	Flush ()

virtual bool	IsFlushed ()

Static Public Member Functions
static iText.Kernel.Pdf.Navigation.PdfExplicitDestination	CreateXYZ (PdfPage page, float left, float top, float zoom)
	Creates PdfExplicitDestination. More...

static iText.Kernel.Pdf.Navigation.PdfExplicitDestination	CreateFit (PdfPage page)
	Creates PdfExplicitDestination. More...

static iText.Kernel.Pdf.Navigation.PdfExplicitDestination	CreateFitH (PdfPage page, float top)
	Creates PdfExplicitDestination. More...

static iText.Kernel.Pdf.Navigation.PdfExplicitDestination	CreateFitV (PdfPage page, float left)
	Creates PdfExplicitDestination. More...

static iText.Kernel.Pdf.Navigation.PdfExplicitDestination	CreateFitR (PdfPage page, float left, float bottom, float right, float top)
	Creates PdfExplicitDestination. More...

static iText.Kernel.Pdf.Navigation.PdfExplicitDestination	CreateFitB (PdfPage page)
	Creates PdfExplicitDestination. More...

static iText.Kernel.Pdf.Navigation.PdfExplicitDestination	CreateFitBH (PdfPage page, float top)
	Creates PdfExplicitDestination. More...

static iText.Kernel.Pdf.Navigation.PdfExplicitDestination	CreateFitBV (PdfPage page, float left)
	Creates PdfExplicitDestination. More...

static iText.Kernel.Pdf.Navigation.PdfExplicitDestination	Create (PdfPage page, PdfName type, float left, float bottom, float right, float top, float zoom)
	Creates a PdfExplicitDestination associated with an object inside current PDF document. More...

Static Public Member Functions inherited from iText.Kernel.Pdf.Navigation.PdfDestination
static iText.Kernel.Pdf.Navigation.PdfDestination	MakeDestination (PdfObject pdfObject)

Package Functions
override bool	IsWrappedObjectMustBeIndirect ()
	Defines if the object behind this wrapper must be an indirect object in the resultant document. More...

Package Functions inherited from iText.Kernel.Pdf.Navigation.PdfDestination
	PdfDestination (PdfObject pdfObject)

Package Functions inherited from iText.Kernel.Pdf.PdfObjectWrapper< PdfObject >
	PdfObjectWrapper (T pdfObject)

virtual void	SetPdfObject (T pdfObject)

virtual void	SetForbidRelease ()

virtual void	UnsetForbidRelease ()

virtual void	EnsureUnderlyingObjectHasIndirectReference ()

Additional Inherited Members
Static Package Functions inherited from iText.Kernel.Pdf.PdfObjectWrapper< PdfObject >
static void	MarkObjectAsIndirect (PdfObject pdfObject)

static void	EnsureObjectIsAddedToDocument (PdfObject @object)
	Some wrappers use object's indirect reference to obtain the `PdfDocument` to which the object belongs to. More...

Detailed Description

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

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.

Member Function Documentation

◆ Create()

static iText.Kernel.Pdf.Navigation.PdfExplicitDestination iText.Kernel.Pdf.Navigation.PdfExplicitDestination.Create	(	PdfPage	page,
		PdfName	type,
		float	left,
		float	bottom,
		float	right,
		float	top,
		float	zoom
	)

inlinestatic

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

Parameters

page	the destination page
type	a iText.Kernel.Pdf.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	the X coordinate of the left edge of the destination rectangle
bottom	the Y coordinate of the lower edge of the destination rectangle
right	the X coordinate of the right edge of the destination rectangle
top	the Y coordinate of the upper edge of the destination rectangle
zoom	zoom factor

Returns: newly created PdfExplicitDestination

◆ CreateFit()

static iText.Kernel.Pdf.Navigation.PdfExplicitDestination iText.Kernel.Pdf.Navigation.PdfExplicitDestination.CreateFit ( PdfPage page )

inlinestatic

Creates PdfExplicitDestination.

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.

Parameters

page	the destination page

Returns: newly created PdfExplicitDestination

◆ CreateFitB()

static iText.Kernel.Pdf.Navigation.PdfExplicitDestination iText.Kernel.Pdf.Navigation.PdfExplicitDestination.CreateFitB ( PdfPage page )

inlinestatic

Creates PdfExplicitDestination.

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.

Parameters

page	the destination page

Returns: newly created PdfExplicitDestination

◆ CreateFitBH()

static iText.Kernel.Pdf.Navigation.PdfExplicitDestination iText.Kernel.Pdf.Navigation.PdfExplicitDestination.CreateFitBH	(	PdfPage	page,
		float	top
	)

inlinestatic

Creates PdfExplicitDestination.

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.

Parameters

page	the destination page
top	the Y coordinate of the upper edge of the destination rectangle

Returns: newly created PdfExplicitDestination

◆ CreateFitBV()

static iText.Kernel.Pdf.Navigation.PdfExplicitDestination iText.Kernel.Pdf.Navigation.PdfExplicitDestination.CreateFitBV	(	PdfPage	page,
		float	left
	)

inlinestatic

Creates PdfExplicitDestination.

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.

Parameters

page	the destination page
left	the X coordinate of the left edge of the destination rectangle

Returns: newly created PdfExplicitDestination

◆ CreateFitH()

static iText.Kernel.Pdf.Navigation.PdfExplicitDestination iText.Kernel.Pdf.Navigation.PdfExplicitDestination.CreateFitH	(	PdfPage	page,
		float	top
	)

inlinestatic

Creates PdfExplicitDestination.

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.

Parameters

page	the destination page
top	the Y coordinate of the upper edge of the destination rectangle

Returns: newly created PdfExplicitDestination

◆ CreateFitR()

static iText.Kernel.Pdf.Navigation.PdfExplicitDestination iText.Kernel.Pdf.Navigation.PdfExplicitDestination.CreateFitR	(	PdfPage	page,
		float	left,
		float	bottom,
		float	right,
		float	top
	)

inlinestatic

Creates PdfExplicitDestination.

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.

Parameters

page	the destination page
left	the X coordinate of the left edge of the destination rectangle
bottom	the Y coordinate of the lower edge of the destination rectangle
right	the X coordinate of the right edge of the destination rectangle
top	the Y coordinate of the upper edge of the destination rectangle

Returns: newly created PdfExplicitDestination

◆ CreateFitV()

static iText.Kernel.Pdf.Navigation.PdfExplicitDestination iText.Kernel.Pdf.Navigation.PdfExplicitDestination.CreateFitV	(	PdfPage	page,
		float	left
	)

inlinestatic

Creates PdfExplicitDestination.

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.

Parameters

page	the destination page
left	the X coordinate of the left edge of the destination rectangle

Returns: newly created PdfExplicitDestination

◆ CreateXYZ()

static iText.Kernel.Pdf.Navigation.PdfExplicitDestination iText.Kernel.Pdf.Navigation.PdfExplicitDestination.CreateXYZ	(	PdfPage	page,
		float	left,
		float	top,
		float	zoom
	)

inlinestatic

Creates PdfExplicitDestination.

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.

Parameters

page	the destination page
left	the X coordinate of the left edge of the destination rectangle
top	the Y coordinate of the upper edge of the destination rectangle
zoom	zoom factor

Returns: newly created PdfExplicitDestination

◆ IsWrappedObjectMustBeIndirect()

override bool iText.Kernel.Pdf.Navigation.PdfExplicitDestination.IsWrappedObjectMustBeIndirect ( )

inlinepackagevirtual

Defines if the object behind this wrapper must be an indirect object in the resultant document.

Defines if the object behind this wrapper must be an indirect object in the resultant document.

If this method returns true it doesn't necessarily mean that object must be in the indirect state at any moment, but rather defines that when the object will be written to the document it will be transformed into indirect object if it's not indirect yet.

Return value of this method shouldn't depend on any logic, it should return always true or false.

Returns: true if in the resultant document the object behind the wrapper must be indirect, otherwise false.

Implements iText.Kernel.Pdf.PdfObjectWrapper< PdfObject >.

Public Member Functions

Static Public Member Functions

Package Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ Create()

◆ CreateFit()

◆ CreateFitB()

◆ CreateFitBH()

◆ CreateFitBV()

◆ CreateFitH()

◆ CreateFitR()

◆ CreateFitV()

◆ CreateXYZ()

◆ IsWrappedObjectMustBeIndirect()