GrapeCity.Documents.Pdf.DestinationXYZ

Class DestinationXYZ

Namespace

GrapeCity.Documents.Pdf

Assembly

GcDocs.Pdf.dll

Display the page designated by page, with the coordinates (left, top) positioned at the upper-left corner of the window and the contents of the page magnified by the factor zoom. A null value for any of the parameters left, top, or zoom specifies that the current value of that parameter is to be retained unchanged. A zoom value of 0 has the same meaning as a null value.

public class DestinationXYZ : Destination, IPdfArray, IDestination

Inheritance

object

PdfWrapperBase

DocAction

DestinationBase

Destination

DestinationXYZ

Implements

IPdfArray

IDestination

Inherited Members

Destination.PdfObject

Destination.PageIndex

Destination.Page

PdfWrapperBase.GetPdfStream()

PdfWrapperBase.GetPdfStreamInfo()

PdfWrapperBase.GetPdfStreamData()

PdfWrapperBase.ObjID

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

IPdfArrayExt.Add(IPdfArray, IPdfObject)

IPdfArrayExt.AddString(IPdfArray, string)

IPdfArrayExt.AsArray<T>(IPdfArray)

IPdfArrayExt.AsBoolArray(IPdfArray)

IPdfArrayExt.AsDictArray(IPdfArray)

IPdfArrayExt.AsFloatArray(IPdfArray)

IPdfArrayExt.AsIntArray(IPdfArray)

IPdfArrayExt.AsNameArray(IPdfArray)

IPdfArrayExt.AsNameArrayStr(IPdfArray)

IPdfArrayExt.AsRefArray(IPdfArray, bool)

IPdfArrayExt.AsStringArray(IPdfArray)

IPdfArrayExt.Clear(IPdfArray)

IPdfArrayExt.Count(IPdfArray)

IPdfArrayExt.Get<T>(IPdfArray, int, bool)

IPdfArrayExt.GetArray<T>(IPdfArray, int, bool, bool, bool)

IPdfArrayExt.GetEnum<T>(IPdfArray, int, T)

IPdfArrayExt.GetEnum<T>(IPdfArray, int, T?)

IPdfArrayExt.GetFloat(IPdfArray, int, float?)

IPdfArrayExt.GetFloat(IPdfArray, int, float)

IPdfArrayExt.GetFloatArray(IPdfArray, int, bool)

IPdfArrayExt.GetInt(IPdfArray, int, int)

IPdfArrayExt.GetInt(IPdfArray, int, int?)

IPdfArrayExt.GetIntArray(IPdfArray, int, bool)

IPdfArrayExt.GetItem(IPdfArray, int)

IPdfArrayExt.GetName(IPdfArray, int, string)

IPdfArrayExt.GetNameArray(IPdfArray, int, bool)

IPdfArrayExt.GetNameArrayStr(IPdfArray, int, bool)

IPdfArrayExt.GetPdfStringBytes(IPdfArray, int)

IPdfArrayExt.GetString(IPdfArray, int, string)

IPdfArrayExt.Insert(IPdfArray, int, IPdfObject)

IPdfArrayExt.RemoveAt(IPdfArray, int)

IPdfArrayExt.RemoveRange(IPdfArray, int, int)

IPdfArrayExt.Set(IPdfArray, int, IPdfObject)

IPdfArrayExt.SetCount(IPdfArray, int)

IPdfArrayExt.SetPdfStringBytes(IPdfArray, int, byte[])

IPdfArrayExt.SetSilent(IPdfArray, int, IPdfObject)

IPdfArrayExt.TryAsArray<T>(IPdfArray, out T[], bool, bool)

IPdfArrayExt.TryAsRect(IPdfArray, out IPdfNumber, out IPdfNumber, out IPdfNumber, out IPdfNumber)

IPdfArrayExt.TryGet<T>(IPdfArray, int, out T, bool)

IPdfArrayExt.TryGet<T>(IPdfArray, int, out T, out bool, bool)

IPdfArrayExt.TryGetArray<T>(IPdfArray, int, out T[], bool, bool, bool)

IPdfArrayExt.TryGetArray<T>(IPdfArray, int, out T[], bool)

IPdfArrayExt.TryGetBool(IPdfArray, int, out bool)

IPdfArrayExt.TryGetEnum<T>(IPdfArray, int, out T)

IPdfArrayExt.TryGetFloat(IPdfArray, int, out float?, bool)

IPdfArrayExt.TryGetFloat(IPdfArray, int, out float, bool)

IPdfArrayExt.TryGetFloatArray(IPdfArray, int, out float[], bool)

IPdfArrayExt.TryGetInt(IPdfArray, int, out int, bool)

IPdfArrayExt.TryGetIntArray(IPdfArray, int, out int[], bool)

IPdfArrayExt.TryGetName(IPdfArray, int, out string)

IPdfArrayExt.TryGetNameArray(IPdfArray, int, out PdfName[], bool)

IPdfArrayExt.TryGetNameArrayStr(IPdfArray, int, out string[], bool)

IPdfArrayExt.TryGetString(IPdfArray, int, out string)

Constructors

DestinationXYZ(Page, float?, float?, float?)

Initializes a new instance of the DestinationXYZ class.

public DestinationXYZ(Page page, float? left, float? top, float? zoom)

Parameters

page Page

The target page.

left float?

The left coordinate of the document window.

top float?

The top coordinate of the document window.

zoom float?

The zoom factor of the document window.

DestinationXYZ(Page, float?, float?)

Initializes a new instance of the DestinationXYZ class.

public DestinationXYZ(Page page, float? left, float? top)

Parameters

page Page

The target page.

left float?

The left coordinate of the document window.

top float?

The top coordinate of the document window.

DestinationXYZ(Page, float?)

Initializes a new instance of the DestinationXYZ class.

public DestinationXYZ(Page page, float? top)

Parameters

page Page

The target page.

top float?

The top coordinate of the document window.

DestinationXYZ(Page)

Initializes a new instance of the DestinationXYZ class.

public DestinationXYZ(Page page)

Parameters

page Page

The target page.

DestinationXYZ(int, float?, float?, float?)

Initializes a new instance of the DestinationXYZ class.

Note that if a destination is created using this constructor then all Y coordinates should be specified relative to the bottom of the page, see Destination description for details.

public DestinationXYZ(int pageIndex, float? left, float? pdfTop, float? zoom)

Parameters

pageIndex int

The target page index.

left float?

The left coordinate of the document window.

pdfTop float?

The top coordinate of the document window relative to the bottom of the page.

zoom float?

The zoom factor of the document window.

DestinationXYZ(int, float?, float?)

Initializes a new instance of the DestinationXYZ class.

Note that if a destination is created using this constructor then all Y coordinates should be specified relative to the bottom of the page, see Destination description for details.

public DestinationXYZ(int pageIndex, float? left, float? pdfTop)

Parameters

pageIndex int

The target page index.

left float?

The left coordinate of the document window.

pdfTop float?

The top coordinate of the document window relative to the bottom of the page.

DestinationXYZ(int, float?)

Initializes a new instance of the DestinationXYZ class.

Note that if a destination is created using this constructor then all Y coordinates should be specified relative to the bottom of the page, see Destination description for details.

public DestinationXYZ(int pageIndex, float? pdfTop)

Parameters

pageIndex int

The target page index.

pdfTop float?

The top coordinate of the document window relative to the bottom of the page.

DestinationXYZ(int)

Initializes a new instance of the DestinationXYZ class.

Note that if a destination is created using this constructor then all Y coordinates should be specified relative to the bottom of the page, see Destination description for details.

public DestinationXYZ(int pageIndex)

Parameters

pageIndex int

The target page index.

Properties

Left

Gets the left coordinate of the document window, if null then unchanged.

public float? Left { get; }

Property Value

float?

PdfTop

Gets the top coordinate of the document window relative to the bottom left corner, unchanged if null.

public float? PdfTop { get; }

Property Value

float?

Top

Gets the top coordinate of the document window, if null then unchanged.

If the target page of this destination was specified as an index (see PageIndex), then this property returns the Y coordinate relative to the page bottom. If the target page was specified as a page object (see Page), then this property returns the Y coordinate relative to the page top. See Destination description for details.

public float? Top { get; }

Property Value

float?

Zoom

Gets the zoom factor of the document window, unchanged if null or zero.

public float? Zoom { get; }

Property Value

float?