Class PdfNamedDestinationParameters

Namespace

PdfSharp.Pdf.Advanced

Assembly

PdfSharp.dll

Creates the named destination parameters.

public class PdfNamedDestinationParameters

Inheritance

object

PdfNamedDestinationParameters

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

CreateFit()

Creates a PdfNamedDestinationParameters object for a named destination. Moving to this destination will move to the destination page, displaying the whole page.

public static PdfNamedDestinationParameters CreateFit()

Returns

PdfNamedDestinationParameters

CreateFitBoundingBox()

Creates a PdfNamedDestinationParameters object for a named destination. Moving to this destination will move to the destination page. The page’s bounding box is fitted to the window.

public static PdfNamedDestinationParameters CreateFitBoundingBox()

Returns

PdfNamedDestinationParameters

CreateFitBoundingBoxHorizontally(double?)

Creates a PdfNamedDestinationParameters object for a named destination. Moving to this destination will move to the desired top value on the destination page. The page’s bounding box width is fitted to the window. Null values are retained unchanged.

public static PdfNamedDestinationParameters CreateFitBoundingBoxHorizontally(double? top)

Parameters

top double?

The top value of the displayed area in PDF world space units.

Returns

PdfNamedDestinationParameters

CreateFitBoundingBoxVertically(double?)

Creates a PdfNamedDestinationParameters object for a named destination. Moving to this destination will move to the desired left value on the destination page. The page’s bounding box height is fitted to the window. Null values are retained unchanged.

public static PdfNamedDestinationParameters CreateFitBoundingBoxVertically(double? left)

Parameters

left double?

The left value of the displayed area in PDF world space units.

Returns

PdfNamedDestinationParameters

CreateFitHorizontally(double?)

Creates a PdfNamedDestinationParameters object for a named destination. Moving to this destination will move to the desired top value on the destination page. The page width is fitted to the window. Null values are retained unchanged.

public static PdfNamedDestinationParameters CreateFitHorizontally(double? top)

Parameters

top double?

The top value of the displayed area in PDF world space units.

Returns

PdfNamedDestinationParameters

CreateFitRectangle(XPoint, XPoint)

Creates a PdfNamedDestinationParameters object for a named destination. Moving to this destination will move to the destination page. The given rectangle is fitted to the window.

public static PdfNamedDestinationParameters CreateFitRectangle(XPoint point1, XPoint point2)

Parameters

point1 XPoint

The first XPoint representing the rectangle to display in PDF world space units.

point2 XPoint

The second XPoint representing the rectangle to display in PDF world space units.

Returns

PdfNamedDestinationParameters

CreateFitRectangle(XRect)

Creates a PdfNamedDestinationParameters object for a named destination. Moving to this destination will move to the destination page. The given rectangle is fitted to the window.

public static PdfNamedDestinationParameters CreateFitRectangle(XRect rect)

Parameters

rect XRect

The XRect representing the rectangle to display in PDF world space units.

Returns

PdfNamedDestinationParameters

CreateFitRectangle(double, double, double, double)

Creates a PdfNamedDestinationParameters object for a named destination. Moving to this destination will move to the destination page. The given rectangle is fitted to the window.

public static PdfNamedDestinationParameters CreateFitRectangle(double left, double top, double right, double bottom)

Parameters

left double

The left value of the rectangle to display in PDF world space units.

top double

The top value of the rectangle to display in PDF world space units.

right double

The right value of the rectangle to display in PDF world space units.

bottom double

The bottom value of the rectangle to display in PDF world space units.

Returns

PdfNamedDestinationParameters

CreateFitVertically(double?)

Creates a PdfNamedDestinationParameters object for a named destination. Moving to this destination will move to the desired left value on the destination page. The page height is fitted to the window. Null values are retained unchanged.

public static PdfNamedDestinationParameters CreateFitVertically(double? left)

Parameters

left double?

The left value of the displayed area in PDF world space units.

Returns

PdfNamedDestinationParameters

CreatePosition(XPoint, double?)

Creates a PdfNamedDestinationParameters object for a named destination. Moving to this destination will move to the desired left and top value and the optional zoom value on the destination page. Null values are retained unchanged.

public static PdfNamedDestinationParameters CreatePosition(XPoint position, double? zoom = null)

Parameters

position XPoint

An XPoint defining the left and top value of the displayed area in PDF world space units.

zoom double?

Optional: The zoom value for the displayed area. 1 = 100%, 2 = 200% etc.

Returns

PdfNamedDestinationParameters

CreatePosition(double?, double?, double?)

Creates a PdfNamedDestinationParameters object for a named destination. Moving to this destination will move to the desired left and top value and the optional zoom value on the destination page. Null values are retained unchanged.

public static PdfNamedDestinationParameters CreatePosition(double? left, double? top, double? zoom = null)

Parameters

left double?

The left value of the displayed area in PDF world space units.

top double?

The top value of the displayed area in PDF world space units.

zoom double?

Optional: The zoom value for the displayed area. 1 = 100%, 2 = 200% etc.

Returns

PdfNamedDestinationParameters

CreateUnchangedPosition()

Creates a PdfNamedDestinationParameters object for a named destination. Moving to this destination will only move to the destination page, without changing the left, top and zoom values for the displayed area.

public static PdfNamedDestinationParameters CreateUnchangedPosition()

Returns

PdfNamedDestinationParameters

CreateVerticalPosition(double?, double?)

Creates a PdfNamedDestinationParameters object for a named destination. Moving to this destination will move to the desired top value and the optional zoom value on the destination page. The left value for the displayed area and null values are retained unchanged.

public static PdfNamedDestinationParameters CreateVerticalPosition(double? top, double? zoom = null)

Parameters

top double?

The top value of the displayed area in PDF world space units.

zoom double?

Optional: The zoom value for the displayed area. 1 = 100%, 2 = 200% etc.

Returns

PdfNamedDestinationParameters

ToString()

Returns the parameters string for the named destination.

public override string ToString()

Returns

string