Click or drag to resize
Pdftools logo

LocationZoomDestination Class

A destination that points to a specific location on the target page, using a specified zoom factor. The location is displayed in the top left corner of the viewport (if possible).
Inheritance Hierarchy
SystemObject
  PdfTools.Toolbox.InternalNativeBase
    PdfTools.Toolbox.InternalNativeObject
      PdfTools.Toolbox.Pdf.NavigationDestination
        PdfTools.Toolbox.Pdf.NavigationDirectDestination
          PdfTools.Toolbox.Pdf.NavigationLocationZoomDestination

Namespace: PdfTools.Toolbox.Pdf.Navigation
Assembly: PdfTools.Toolbox (in PdfTools.Toolbox.dll) Version: 1.3.0+2e7887cb8ae45c4d911ad975ad001ac2f1f257d8
Syntax
C#
public class LocationZoomDestination : DirectDestination

The LocationZoomDestination type exposes the following members.

Properties
 NameDescription
Public propertyLeft

The location of the page that is displayed at the left border of the viewport (if possible).

If the property is , the value from before the jump is retained.

Note: Due to the current zoom factor, it is usually not possible for viewers to scroll as far to the right side, as would be necessary to place the location at the left corner of the viewport. However, viewers will ensure, that the location is at least visible.

In practice this means, that this value is mostly irrelevant.

Public propertyPage The page in the document that this destination is pointing to.
(Inherited from DirectDestination)
Public propertyTarget

The target destination

For direct destinations, this is just the destination itself.
(Inherited from Destination)
Public propertyTop

The location of the page that is displayed at the top of the viewport (if possible).

If the property is , the value from before the jump is retained.

Public propertyZoom

The zoom factor that is applied when jumping to the destination.

A value of means that the current zoom level is retained.

Note: Many PDF viewers support different viewing modes like "fit page" or "fit width".

A LocationZoomDestination with a Zoom value of will usually not change the current viewing mode in most viewers.

For other Zoom values however, the viewer must switch to the standard mode, i.e. deactivate special modes like "fit page" or "fit width".

Because of this, using a Zoom value other than is discouraged.

Top
Methods
 NameDescription
Public methodStatic memberCreate

Create a new LocationZoomDestination

The returned object is not yet used on any page, but it is associated with the given target document.
Public methodEquals
(Inherited from NativeObject)
Public methodGetHashCode
(Inherited from NativeObject)
Top
See Also