Skip to main content

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Documentation Search all OfficeIMO/

API Reference

Class

PdfOpenActionOptions

Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Source revision c8404474f9f2 with working tree changes
Modifiers sealed

Defines the initial destination a PDF viewer should open when displaying a generated document.

Inheritance

  • Object
  • PdfOpenActionOptions

Usage

Explore 1 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 1

Constructors

public PdfOpenActionOptions(Int32 pageNumber = 1, Double? destinationTop = null, PdfOpenActionDestinationMode destinationMode = Xyz, Double? destinationLeft = null, Double? destinationBottom = null, Double? destinationRight = null) #

Creates a generated document open action targeting a one-based page number.

Parameters

pageNumber System.Int32 = 1 optionalposition: 0
destinationTop System.Double? = null optionalposition: 1
destinationMode OfficeIMO.Pdf.PdfOpenActionDestinationMode = Xyz optionalposition: 2
destinationLeft System.Double? = null optionalposition: 3
destinationBottom System.Double? = null optionalposition: 4
destinationRight System.Double? = null optionalposition: 5

Properties

public Int32 PageNumber { get; } #

One-based generated page number to show when the document opens.

public Double? DestinationTop { get; } #

Optional top coordinate for the destination. When omitted, the generated page top is used.

public Double? DestinationLeft { get; } #

Optional left coordinate for destination modes that use a left or rectangle coordinate.

public Double? DestinationBottom { get; } #

Optional bottom coordinate for rectangle destinations.

public Double? DestinationRight { get; } #

Optional right coordinate for rectangle destinations.

public PdfOpenActionDestinationMode DestinationMode { get; } #

Viewer destination mode emitted for the open action.