www.tenman.info

Adobe Acrobat 7.0

PDF Open Parameters

July 11, 2005

Adobe Solutions Network -- http://partners.adobe.com

Copyright 2004 Adobe Systems Incorporated. All rights reserved. NOTICE: All information contained herein is the property of Adobe Systems Incorporated. No part of this publication (whether in hardcopy or electronic form) may be reproduced or transmitted, in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without the prior written consent of the Adobe Systems Incorporated. PostScript is a registered trademark of Adobe Systems Incorporated. All instances of the name PostScript in the text are references to the PostScript language as defined by Adobe Systems Incorporated unless otherwise stated. The name PostScript also is used as a product trademark for Adobe Systems' implementation of the PostScript language interpreter. Except as otherwise stated, any reference to a "PostScript printing device," "PostScript display device," or similar item refers to a printing device, display device or item (respectively) that contains PostScript technology created or licensed by Adobe Systems Incorporated and not to devices or items that purport to be merely compatible with the PostScript language. Adobe, the Adobe logo, Acrobat, the Acrobat logo, Acrobat Capture, Distiller, PostScript, the PostScript logo and Reader are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries. Apple, Macintosh, and Power Macintosh are trademarks of Apple Computer, Inc., registered in the United States and other countries. PowerPC is a registered trademark of IBM Corporation in the United States. ActiveX, Microsoft, Windows, and Windows NT are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. Verity is a registered trademark of Verity, Incorporated. UNIX is a registered trademark of The Open Group. Verity is a trademark of Verity, Inc. Lextek is a trademark of Lextek International. All other trademarks are the property of their respective owners. This publication and the information herein is furnished AS IS, is subject to change without notice, and should not be construed as a commitment by Adobe Systems Incorporated. Adobe Systems Incorporated assumes no responsibility or liability for any errors or inaccuracies, makes no warranty of any kind (express, implied, or statutory) with respect to this publication, and expressly disclaims any and all warranties of merchantability, fitness for particular purposes, and noninfringement of third party rights.

Preface

Description

This document describes PDF Open parameters for Acrobat 7.0, that allow you to open a PDF file using a URL or command that specifies both the file to be opened plus actions to be performed once the file is opened.

Resources

The following resources provide further information about how to use the PDF Open parameters described in this document.

Acrobat and PDF Library API Reference. Provides a detailed description of the Acrobat and PDF Library APIs. Acrobat Online Collaboration: Setup and Administraton. Explains how to configure a collaboration store and networking issues related to Acrobat. PDF Reference, fifth edition, version 1.6 describes PDF version 1.6 in detail, including PDF object types, file format, and document structure.

Conventions Used in This Book

The Acrobat documentation uses text styles according to the following conventions. Font monospaced Used for Paths and filenames Code examples set off from plain text monospaced bold Code items within plain text Parameter names and literal values in reference documents monospaced italic Pseudocode Placeholders in code examples Examples

C:\templates\mytmpl.fm

These are variable declarations:

AVMenu commandMenu,helpMenu;

The GetExtensionID method ... The enumeration terminates if proc returns false.

ACCB1 void ACCB2 ExeProc(void) { do something } AFSimple_Calculate(cFunction, cFields)

PDF Open Parameters

3

Preface

Conventions Used in This Book

Font blue

Used for Live links to Web pages Live links to sections within this document Live links to code items within this document

Examples The Acrobat Solutions Network URL is: http://partners.adobe.com/asn/ See Using the SDK. Test whether an ASAtom exists. The setpagedevice operator

bold

PostScript language and PDF operators, keywords, dictionary key names User interface names

The File menu Acrobat and PDF Library API Overview User space specifies coordinates for... filename deletefile

italic

Document titles that are not live links New terms PostScript variables

4

PDF Open Parameters

Open Parameters for PDF

Adobe defines parameters that allow you to open a PDF document with a command or URL that specifies exactly what to display (a named destination or specific page), and how to display it (using such characteristics as a specific view, scrollbars, bookmarks, annotations, or highlighting). The PDF Open parameters for URLs, described in the table below, are supported through the Netscape and Internet Explorer browsers, and can also be used when opening PDF documents programmatically:

Many of these parameters can be passed to the following core API functions (see the Acrobat and PDF Library API Reference for details):

AVDocOpenFromFileWithParamString AVDocOpenFromASFileWithParamString AVDocOpenFromPDDocWithParamString

When opening a PDF document from a command shell, you can pass the parameters to the open command using the /A switch using the following syntax:  /A "=OpenActions" "" For example:

Acrobat.exe /A "zoom=1000=OpenActions" "C:\example.pdf"

When opening a PDF document with an Apple Event on a Macintosh operating system, you can optionally pass the PDF Open parameters.

PDF Open Parameters

The following table lists and describes the available PDF open parameters. Italics indicate user-specified variables. Syntax Description Specifies a named destination in the PDF. Specifies a numbered page in the document, using an integer value. The document's first page has a pagenum value of 1. Specifies a comment on a given page in the PDF. Use the page command before this command; for example:

#page=1&comment=452fde0e-fd22-457c-84aa2cf5bed5a349

nameddest=name page=pagenum

comment=commentID

PDF Open Parameters

5

Open Parameters for PDF

PDF Open Parameters

Syntax

Description Sets the collaboration store to be used to supply and store comments for the document. This overrides the default comment server for the review or the default preference. setting is of the form store_type@location, where valid values for store_type are: DAVFDF (webDAV) FSFDF (Network store) DB (ADBC) For example:

#collab=DAVFDF@http://review_server/Collab/user1

collab=setting

For more information, see Acrobat Online Collaboration: Administration and Setup.

zoom=scale zoom=scale,left,top

Sets the zoom and scroll factors, using float or integer values. For example, a scale value of 100 indicates a zoom value of 100%. Scroll values left and top are in a coordinate system where 0,0 represents the top left corner of the visible page, regardless of document rotation. Set the view of the displayed page, using the keyword values defined in the PDF language specification. See the PDF Reference. Scroll values left and top are floats or integers in a coordinate system where 0,0 represents the top left corner of the visible page, regardless of document rotation. Use the page command before this command.

NOTE:

view=Fit view=FitH view=FitH,top view=FitV view=FitV,left view=FitB view=FitBH view=FitBH,top view=FitBV view=FitBV,left viewrect=left,top,wd,ht

Not supported on the command line.

Sets the view rectangle using float or integer values in a coordinate system where 0,0 represents the top left corner of the visible page, regardless of document rotation. Use the page command before this command.

NOTE:

Not supported on the command line.

pagemode=bookmarks pagemode=thumbs pagemode=none (default) scrollbar=1 |0

Displays bookmarks or thumbnails.

Turns scrollbars on or off.

6

PDF Open Parameters

Open Parameters for PDF

Specifying PDF Open Parameters in a URL

Syntax

Description Opens the Search UI and performs a search for the specified word list in the document. Matching words are highlighted in the document. The words must be enclosed in quotes and separated by spaces; for example:

#search="word1 word2"

search=wordList

toolbar=1 |0 statusbar=1 |0 messages=1 |0 navpanes=1 |0 highlight=lt,rt,top,btm

Turns the toolbar on or off. Turns the status bar on or off. Turns the document message bar on or off. Turns the navigation panes and tabs on or off. Highlights a specified rectangle on the displayed page. (Use the page command before this command.) The rectangle values are integers in a coordinate system where 0,0 represents the top left corner of the visible page, regardless of document rotation. Used only when opening a file from the command line or an Apple Event. Opens the document in the Help window, with the specified navigation panel selected. Specifies an FDF file to be used to populate form fields in the PDF file being opened. For example:

#fdf=http://example.org/doc.fdf

NOTE:

help=index |contents |search

fdf=URL

The fdf parameter should be specifed last in the URL.

Specifying PDF Open Parameters in a URL

You can specify multiple PDF Open parameters in a single URL. Each parameter is separated from the others with either an ampersand (&) or a pound (#) character. Actions are processed and executed from left to right as they appear on the URL command line. Because all specified actions are executed, it is possible that later actions will override the effects of previous actions, so it is important to be aware of the order. For example, page actions should appear before zoom actions. Commands are not case sensitive (except for the value of a named destination). There can be no spaces in the URL line.

PDF Open Parameters

7

Open Parameters for PDF

Specifying PDF Open Parameters in a URL

URL Examples

http://example.org/doc.pdf#nameddest=Chapter6 http://example.org/doc.pdf#page=3 http://example.org/doc.pdf#page=3&zoom=200,250,100 http://example.org/doc.pdf#zoom=50 http://example.org/doc.pdf#page=72&view=fitH,100 http://example.org/doc.pdf#view=fitb&nameddest=Chapter3 http://example.org/doc.pdf#pagemode=none http://example.org/doc.pdf#pagemode=bookmarks&page=2 http://example.org/doc.pdf#page=3&pagemode=thumbs http://example.org/doc.pdf#collab=DAVFDF@http://review_server/Collab/use r1 http://example.org/doc.pdf#page=1&comment=452fde0e-fd22-457c-84aa2cf5bed5a349 http://example.org/doc.pdf#fdf=http://example.org/doc.fdf

URL Limitations

Only one digit following a decimal point is retained for float values. Individual parameters, together with their values (separated by & or #), can be no greater then 32 characters in length. You cannot use the reserved characters=, #, and &. There is no way to escape these special characters. If you turn bookmarks off using a URL parameter when a document had previously been saved with bookmarks on, the bookmark scrollbars are displayed at first, and only disappear once Acrobat obtains enough streamed information to render the full page.

8

PDF Open Parameters