[]
产品首页 在线Demo 产品文档 API 参考 技术社区
立即试用
(Showing Draft Content)

GrapeCity.Documents.Pdf.Destination

Class Destination

Namespace
GrapeCity.Documents.Pdf
Assembly
GcDocs.Pdf.dll

The abstract base class for types representing a destination that defines a particular view of a document. A destination consists of:

  • The page of the document to be displayed.
  • The location of the document window on that page.
  • The magnification (zoom factor) to use when displaying the page.

Important note about vertical coordinates:

In PDFs, all coordinates are specified relative to the bottom left corner, with the Y axis going up. GcPdf uses the more common coordinate system with the origin in the top left corner, with the Y axis going down. In most situations the Y coordinates are automatically converted by GcPdf. In classes derived from Destination this is also done if the destination's target page is specified as the Page object. But if the destination's target page is specified by index, automatic conversion of the Y coordinate cannot be done, and it should be specified relative to the bottom left corner as per the PDF spec.

When the Y coordinate is specified relative to the page bottom, it is noted in the parameter's description. (It is recommended that constructors accepting a Page object are used instead.)

All properties defining the Y coordinate has linked property with "Pdf" prefix, for example Y and PdfY, the property with "Pdf" prefix contains a value relative to the bottom left corner with the Y axis going up. 

public abstract class Destination : DestinationBase, IPdfArray, IDestination
Inheritance
object
Destination
Implements
Inherited Members
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Extension Methods

Properties

Page

Gets this destination's target Page object. Returns null if the target page was specified by index.

public Page Page { get; }

Property Value

Page

PageIndex

Gets the index of this destination's target page. Returns null if the target page was specified as a Page object.

Note that if this property is not null, then any Y coordinate is relative to the bottom left corner (see Destination description for details). 

public int? PageIndex { get; }

Property Value

int?

PdfObject

Gets the underlying GrapeCity.Documents.Pdf.Spec.IPdfObject.

public override IPdfObject PdfObject { get; }

Property Value

GrapeCity.Documents.Pdf.Spec.IPdfObject