Interapplication Communication API Reference

Interapplication Communication API Reference
bc
Interapplication Communication
API Reference
Adobe® Acrobat® SDK
November 2006
Version 8.0
© 2006 Adobe Systems Incorporated. All rights reserved.
Adobe® Acrobat® SDK 8.0 Interapplication Communication API Reference for Microsoft® Windows® and Mac OS®.
Edition 1.0, November 2006
If this guide is distributed with software that includes an end user agreement, this guide, as well as the software described in it, is furnished
under license and may be used or copied only in accordance with the terms of such license. Except as permitted by any such license, no part
of this guide may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, recording,
or otherwise, without the prior written permission of Adobe Systems Incorporated. Please note that the content in this guide is protected
under copyright law even if it is not distributed with software that includes an end user license agreement.
The content of this guide is furnished for informational use only, 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 that may appear in the informational content contained in this guide.
Please remember that existing artwork or images that you may want to include in your project may be protected under copyright law. The
unauthorized incorporation of such material into your new work could be a violation of the rights of the copyright owner. Please be sure to
obtain any permission required from the copyright owner.
Any references to company names and company logos in sample material are for demonstration purposes only and are not intended to refer
to any actual organization.
Adobe, the Adobe logo, Acrobat, PostScript, and Reader are either registered trademarks or trademarks of Adobe Systems Incorporated in
the United States and/or other countries.
Apple and Mac OS are trademarks of Apple Computer, Inc., registered in the United States and other countries.
JavaScript is a trademark or registered trademark of Sun Microsystems, Inc. in the United States and other countries.
Microsoft and Windows are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.
UNIX is a registered trademark of The Open Group in the United States and other countries.
All other trademarks are the property of their respective owners.
Adobe Systems Incorporated, 345 Park Avenue, San Jose, California 95110, USA.
Notice to U.S. Government End Users. The Software and Documentation are “Commercial Items,” as that term is defined at 48 C.F.R. §2.101,
consisting of “Commercial Computer Software” and “Commercial Computer Software Documentation,” as such terms are used in 48 C.F.R.
§12.212 or 48 C.F.R. §227.7202, as applicable. Consistent with 48 C.F.R. §12.212 or 48 C.F.R. §§227.7202-1 through 227.7202-4, as applicable,
the Commercial Computer Software and Commercial Computer Software Documentation are being licensed to U.S. Government end users
(a) only as Commercial Items and (b) with only those rights as are granted to all other end users pursuant to the terms and conditions herein.
Unpublished-rights reserved under the copyright laws of the United States. Adobe Systems Incorporated, 345 Park Avenue, San Jose, CA
95110-2704, USA. For U.S. Government End Users, Adobe agrees to comply with all applicable equal opportunity laws including, if
appropriate, the provisions of Executive Order 11246, as amended, Section 402 of the Vietnam Era Veterans Readjustment Assistance Act of
1974 (38 USC 4212), and Section 503 of the Rehabilitation Act of 1973, as amended, and the regulations at 41 CFR Parts 60-1 through 60-60,
60-250, and 60-741. The affirmative action clause and regulations contained in the preceding sentence shall be incorporated by reference.
Contents
Preface ........................................................................................................................................ 12
What’s in this guide? ...................................................................................................................................................................12
Who should read this guide? ...................................................................................................................................................12
Related documentation .............................................................................................................................................................12
1
OLE Automation......................................................................................................................... 14
AcroExch.App ................................................................................................................................................................................14
CloseAllDocs ............................................................................................................................................................................16
Exit ...............................................................................................................................................................................................16
GetActiveDoc...........................................................................................................................................................................17
GetActiveTool..........................................................................................................................................................................17
GetAVDoc..................................................................................................................................................................................18
GetFrame ..................................................................................................................................................................................18
GetInterface .............................................................................................................................................................................19
GetLanguage ...........................................................................................................................................................................19
GetNumAVDocs......................................................................................................................................................................20
GetPreference..........................................................................................................................................................................20
GetPreferenceEx.....................................................................................................................................................................21
Hide.............................................................................................................................................................................................21
Lock.............................................................................................................................................................................................21
Minimize....................................................................................................................................................................................22
Maximize ...................................................................................................................................................................................23
MenuItemExecute..................................................................................................................................................................23
MenuItemIsEnabled ..............................................................................................................................................................24
MenuItemIsMarked ...............................................................................................................................................................24
MenuItemRemove .................................................................................................................................................................25
Restore .......................................................................................................................................................................................25
SetActiveTool...........................................................................................................................................................................26
SetFrame ...................................................................................................................................................................................26
SetPreference ..........................................................................................................................................................................27
SetPreferenceEx......................................................................................................................................................................27
Show ...........................................................................................................................................................................................28
ToolButtonIsEnabled ............................................................................................................................................................28
ToolButtonRemove ...............................................................................................................................................................29
Unlock ........................................................................................................................................................................................29
UnlockEx....................................................................................................................................................................................30
AcroExch.AVDoc ...........................................................................................................................................................................30
BringToFront............................................................................................................................................................................31
ClearSelection .........................................................................................................................................................................32
Close ...........................................................................................................................................................................................32
FindText.....................................................................................................................................................................................33
GetAVPageView......................................................................................................................................................................33
GetFrame ..................................................................................................................................................................................34
GetPDDoc .................................................................................................................................................................................34
GetTitle.......................................................................................................................................................................................35
3
Adobe Acrobat SDK
Interapplication Communication API Reference
1
Contents
4
OLE Automation (Continued)
AcroExch.AVDoc (Continued)
GetViewMode..........................................................................................................................................................................35
IsValid .........................................................................................................................................................................................35
Maximize ...................................................................................................................................................................................36
Open ...........................................................................................................................................................................................36
OpenInWindow ......................................................................................................................................................................37
OpenInWindowEx..................................................................................................................................................................38
PrintPages.................................................................................................................................................................................40
PrintPagesEx ............................................................................................................................................................................40
PrintPagesSilent .....................................................................................................................................................................41
PrintPagesSilentEx.................................................................................................................................................................42
SetFrame ...................................................................................................................................................................................43
SetTextSelection.....................................................................................................................................................................44
SetTitle .......................................................................................................................................................................................45
SetViewMode ..........................................................................................................................................................................45
ShowTextSelect ......................................................................................................................................................................46
AcroExch.AVPageView ...............................................................................................................................................................47
DevicePointToPage...............................................................................................................................................................47
DoGoBack .................................................................................................................................................................................48
DoGoForward..........................................................................................................................................................................48
GetAperture .............................................................................................................................................................................49
GetAVDoc..................................................................................................................................................................................49
GetDoc .......................................................................................................................................................................................49
GetPage .....................................................................................................................................................................................50
GetPageNum ...........................................................................................................................................................................50
GetZoom ...................................................................................................................................................................................51
GetZoomType .........................................................................................................................................................................51
Goto ............................................................................................................................................................................................52
PointToDevice.........................................................................................................................................................................53
ReadPageDown ......................................................................................................................................................................53
ReadPageUp ............................................................................................................................................................................54
ScrollTo ......................................................................................................................................................................................54
ZoomTo .....................................................................................................................................................................................55
AcroExch.HiliteList .......................................................................................................................................................................56
Add..............................................................................................................................................................................................56
AcroExch.PDAnnot.......................................................................................................................................................................56
GetColor ....................................................................................................................................................................................57
GetContents.............................................................................................................................................................................58
GetDate......................................................................................................................................................................................58
GetRect ......................................................................................................................................................................................58
GetSubtype ..............................................................................................................................................................................59
GetTitle.......................................................................................................................................................................................59
IsEqual ........................................................................................................................................................................................60
IsOpen ........................................................................................................................................................................................60
IsValid .........................................................................................................................................................................................61
Perform ......................................................................................................................................................................................62
SetColor .....................................................................................................................................................................................62
SetContents..............................................................................................................................................................................63
Adobe Acrobat SDK
Interapplication Communication API Reference
1
Contents
5
OLE Automation (Continued)
AcroExch.PDAnnot (Continued)
SetDate ......................................................................................................................................................................................63
SetOpen.....................................................................................................................................................................................64
SetRect .......................................................................................................................................................................................64
SetTitle .......................................................................................................................................................................................65
AcroExch.PDBookmark...............................................................................................................................................................66
Destroy.......................................................................................................................................................................................66
GetByTitle..................................................................................................................................................................................67
GetTitle.......................................................................................................................................................................................67
IsValid .........................................................................................................................................................................................68
Perform ......................................................................................................................................................................................68
SetTitle .......................................................................................................................................................................................69
AcroExch.PDDoc ...........................................................................................................................................................................69
AcquirePage.............................................................................................................................................................................71
ClearFlags..................................................................................................................................................................................71
Close ...........................................................................................................................................................................................72
Create .........................................................................................................................................................................................72
CreateTextSelect ....................................................................................................................................................................73
CreateThumbs.........................................................................................................................................................................74
CropPages.................................................................................................................................................................................74
DeletePages .............................................................................................................................................................................75
DeleteThumbs.........................................................................................................................................................................75
GetFileName ............................................................................................................................................................................76
GetFlags.....................................................................................................................................................................................76
GetInfo .......................................................................................................................................................................................77
GetInstanceID..........................................................................................................................................................................77
GetJSObject..............................................................................................................................................................................78
GetNumPages .........................................................................................................................................................................78
GetPageMode..........................................................................................................................................................................79
GetPermanentID.....................................................................................................................................................................79
InsertPages ...............................................................................................................................................................................79
MovePage .................................................................................................................................................................................80
Open ...........................................................................................................................................................................................81
OpenAVDoc .............................................................................................................................................................................81
ReplacePages...........................................................................................................................................................................82
Save.............................................................................................................................................................................................83
SetFlags......................................................................................................................................................................................84
SetInfo ........................................................................................................................................................................................85
SetPageMode ..........................................................................................................................................................................85
AcroExch.PDPage .........................................................................................................................................................................86
AddAnnot .................................................................................................................................................................................87
AddNewAnnot ........................................................................................................................................................................88
CopyToClipboard...................................................................................................................................................................88
CreatePageHilite.....................................................................................................................................................................89
CreateWordHilite....................................................................................................................................................................90
CropPage...................................................................................................................................................................................91
Draw............................................................................................................................................................................................91
DrawEx .......................................................................................................................................................................................92
Adobe Acrobat SDK
Interapplication Communication API Reference
1
Contents
6
OLE Automation (Continued)
AcroExch.PDPage (Continued)
GetAnnot...................................................................................................................................................................................93
GetAnnotIndex .......................................................................................................................................................................93
GetDoc .......................................................................................................................................................................................94
GetNumAnnots.......................................................................................................................................................................94
GetNumber...............................................................................................................................................................................95
GetRotate ..................................................................................................................................................................................95
GetSize .......................................................................................................................................................................................96
RemoveAnnot .........................................................................................................................................................................96
SetRotate...................................................................................................................................................................................97
AcroExch.PDTextSelect ..............................................................................................................................................................98
Destroy.......................................................................................................................................................................................98
GetBoundingRect...................................................................................................................................................................99
GetNumText.............................................................................................................................................................................99
GetPage .................................................................................................................................................................................. 100
GetText.................................................................................................................................................................................... 101
AcroExch.Point ........................................................................................................................................................................... 102
X................................................................................................................................................................................................. 102
Y................................................................................................................................................................................................. 102
AcroExch.Rect ............................................................................................................................................................................. 102
Bottom .................................................................................................................................................................................... 103
Left............................................................................................................................................................................................ 103
Right......................................................................................................................................................................................... 103
Top............................................................................................................................................................................................ 104
AcroExch.Time............................................................................................................................................................................ 104
Date.......................................................................................................................................................................................... 104
Hour ......................................................................................................................................................................................... 105
Millisecond ............................................................................................................................................................................ 105
Minute..................................................................................................................................................................................... 105
Month...................................................................................................................................................................................... 105
Second .................................................................................................................................................................................... 106
Year .......................................................................................................................................................................................... 106
AxAcroPDFLib.AxAcroPDF ..................................................................................................................................................... 106
GetVersions ........................................................................................................................................................................... 108
GoBackwardStack ............................................................................................................................................................... 108
GoForwardStack .................................................................................................................................................................. 108
GotoFirstPage....................................................................................................................................................................... 108
GotoLastPage ....................................................................................................................................................................... 109
GotoNextPage...................................................................................................................................................................... 109
GotoPreviousPage .............................................................................................................................................................. 109
LoadFile .................................................................................................................................................................................. 110
Print.......................................................................................................................................................................................... 110
PrintAll..................................................................................................................................................................................... 110
PrintAllFit ............................................................................................................................................................................... 111
PrintPages.............................................................................................................................................................................. 111
PrintPagesFit......................................................................................................................................................................... 112
PrintWithDialog ................................................................................................................................................................... 113
SetCurrentHighlight........................................................................................................................................................... 113
Adobe Acrobat SDK
Interapplication Communication API Reference
1
Contents
7
OLE Automation (Continued)
AxAcroPDFLib.AxAcroPDF (Continued)
SetCurrentPage.................................................................................................................................................................... 113
SetLayoutMode ................................................................................................................................................................... 114
SetNamedDest ..................................................................................................................................................................... 114
SetPageMode ....................................................................................................................................................................... 115
SetShowScrollbars .............................................................................................................................................................. 115
SetShowToolbar .................................................................................................................................................................. 116
SetView ................................................................................................................................................................................... 116
SetViewRect .......................................................................................................................................................................... 117
SetViewScroll ........................................................................................................................................................................ 117
SetZoom................................................................................................................................................................................. 118
SetZoomScroll...................................................................................................................................................................... 118
Src ............................................................................................................................................................................................. 119
2
DDE Messages ..........................................................................................................................120
AppExit.......................................................................................................................................................................................... 121
AppHide........................................................................................................................................................................................ 122
AppShow...................................................................................................................................................................................... 122
CloseAllDocs................................................................................................................................................................................ 122
DocClose....................................................................................................................................................................................... 123
DocDeletePages ........................................................................................................................................................................ 123
DocFind......................................................................................................................................................................................... 124
DocGoTo....................................................................................................................................................................................... 125
DocGoToNameDest.................................................................................................................................................................. 125
DocInsertPages .......................................................................................................................................................................... 125
DocOpen ...................................................................................................................................................................................... 126
DocPageDown............................................................................................................................................................................ 127
DocPageLeft................................................................................................................................................................................ 127
DocPageRight............................................................................................................................................................................. 128
DocPageUp.................................................................................................................................................................................. 128
DocPrint ........................................................................................................................................................................................ 129
DocReplacePages...................................................................................................................................................................... 129
DocSave ........................................................................................................................................................................................ 130
DocSaveAs ................................................................................................................................................................................... 130
DocScrollTo.................................................................................................................................................................................. 131
DocSetViewMode...................................................................................................................................................................... 132
DocZoomTo................................................................................................................................................................................. 132
FileOpen ....................................................................................................................................................................................... 133
FileOpenEx................................................................................................................................................................................... 133
FilePrint ......................................................................................................................................................................................... 134
FilePrintEx .................................................................................................................................................................................... 135
FilePrintSilent.............................................................................................................................................................................. 135
FilePrintSilentEx ......................................................................................................................................................................... 136
FilePrintTo .................................................................................................................................................................................... 137
FilePrintToEx ............................................................................................................................................................................... 137
FullMenus..................................................................................................................................................................................... 138
HideToolbar................................................................................................................................................................................. 138
MenuitemExecute..................................................................................................................................................................... 139
ShortMenus ................................................................................................................................................................................. 139
ShowToolbar............................................................................................................................................................................... 140
Adobe Acrobat SDK
Interapplication Communication API Reference
3
Contents
8
Apple Event Objects and Apple Events..................................................................................141
Objects .......................................................................................................................................................................................... 141
annotation ............................................................................................................................................................................. 141
application............................................................................................................................................................................. 143
AVPageView.......................................................................................................................................................................... 145
bookmark............................................................................................................................................................................... 145
conversion ............................................................................................................................................................................. 147
document .............................................................................................................................................................................. 147
EPS Conversion .................................................................................................................................................................... 149
Link Annotation ................................................................................................................................................................... 149
menu........................................................................................................................................................................................ 149
menu item ............................................................................................................................................................................. 150
page ......................................................................................................................................................................................... 151
PDAnnot ................................................................................................................................................................................. 151
PDBookMark ......................................................................................................................................................................... 152
PDLinkAnnot......................................................................................................................................................................... 152
PDPage.................................................................................................................................................................................... 152
PDTextAnnot ........................................................................................................................................................................ 152
PDF Window ......................................................................................................................................................................... 152
PostScript Conversion ....................................................................................................................................................... 153
Text Annotation................................................................................................................................................................... 154
Required suite events .............................................................................................................................................................. 155
open......................................................................................................................................................................................... 155
print.......................................................................................................................................................................................... 155
quit ........................................................................................................................................................................................... 155
run ............................................................................................................................................................................................ 156
Core suite events ....................................................................................................................................................................... 156
close ......................................................................................................................................................................................... 156
count........................................................................................................................................................................................ 157
delete....................................................................................................................................................................................... 157
exists ........................................................................................................................................................................................ 158
get............................................................................................................................................................................................. 158
make ........................................................................................................................................................................................ 159
move........................................................................................................................................................................................ 159
open......................................................................................................................................................................................... 160
quit ........................................................................................................................................................................................... 160
save .......................................................................................................................................................................................... 161
set ............................................................................................................................................................................................. 161
Acrobat application events.................................................................................................................................................... 162
bring to front ........................................................................................................................................................................ 163
clear selection....................................................................................................................................................................... 163
close all docs......................................................................................................................................................................... 163
create thumbs ...................................................................................................................................................................... 164
delete pages ......................................................................................................................................................................... 165
delete thumbs...................................................................................................................................................................... 165
execute ................................................................................................................................................................................... 166
find next note ....................................................................................................................................................................... 166
find text................................................................................................................................................................................... 167
Adobe Acrobat SDK
Interapplication Communication API Reference
3
Contents
9
Apple Event Objects and Apple Events (Continued)
Acrobat application events (Continued)
get info.................................................................................................................................................................................... 168
go backward ......................................................................................................................................................................... 168
go forward ............................................................................................................................................................................. 169
goto.......................................................................................................................................................................................... 170
goto next................................................................................................................................................................................ 170
goto previous ....................................................................................................................................................................... 171
insert pages........................................................................................................................................................................... 172
is toolbutton enabled........................................................................................................................................................ 172
maximize................................................................................................................................................................................ 173
perform................................................................................................................................................................................... 174
print pages ............................................................................................................................................................................ 174
read page down .................................................................................................................................................................. 175
read page up......................................................................................................................................................................... 175
remove toolbutton............................................................................................................................................................. 176
replace pages ....................................................................................................................................................................... 176
scroll......................................................................................................................................................................................... 177
select text............................................................................................................................................................................... 178
set info..................................................................................................................................................................................... 179
zoom........................................................................................................................................................................................ 179
Miscellaneous events............................................................................................................................................................... 180
do script.................................................................................................................................................................................. 180
4
Acrobat Catalog Plug-In ..........................................................................................................181
Catalog Windows messages.................................................................................................................................................. 181
Catalog DDE methods ............................................................................................................................................................. 181
AppExit.................................................................................................................................................................................... 181
AppFront ................................................................................................................................................................................ 181
FileBuild .................................................................................................................................................................................. 182
FileOpen ................................................................................................................................................................................. 182
FilePurge ................................................................................................................................................................................ 182
5
Acrobat Forms Plug-In ............................................................................................................183
Forms plug-in OLE automation............................................................................................................................................ 183
Exceptions.................................................................................................................................................................................... 183
AFormApp.................................................................................................................................................................................... 184
Field................................................................................................................................................................................................ 184
Methods ................................................................................................................................................................................. 184
PopulateListOrComboBox......................................................................................................................................... 185
SetBackgroundColor ................................................................................................................................................... 185
SetBorderColor .............................................................................................................................................................. 186
SetButtonCaption......................................................................................................................................................... 187
SetButtonIcon ................................................................................................................................................................ 187
SetExportValues ............................................................................................................................................................ 188
SetForegroundColor.................................................................................................................................................... 189
SetJavaScriptAction ..................................................................................................................................................... 190
SetResetFormAction.................................................................................................................................................... 191
SetSubmitFormAction ................................................................................................................................................ 192
Adobe Acrobat SDK
Interapplication Communication API Reference
5
Contents
10
Acrobat Forms Plug-In (Continued)
Field (Continued)
Properties............................................................................................................................................................................... 192
Alignment........................................................................................................................................................................ 193
BorderStyle...................................................................................................................................................................... 194
BorderWidth ................................................................................................................................................................... 194
ButtonLayout ................................................................................................................................................................. 195
CalcOrderIndex.............................................................................................................................................................. 195
CharLimit ......................................................................................................................................................................... 196
DefaultValue................................................................................................................................................................... 196
Editable............................................................................................................................................................................. 196
Highlight .......................................................................................................................................................................... 197
IsHidden ........................................................................................................................................................................... 197
IsMultiline ........................................................................................................................................................................ 198
IsPassword....................................................................................................................................................................... 198
IsReadOnly ...................................................................................................................................................................... 198
IsRequired........................................................................................................................................................................ 199
IsTerminal ........................................................................................................................................................................ 199
Name ................................................................................................................................................................................. 199
NoViewFlag..................................................................................................................................................................... 199
PrintFlag........................................................................................................................................................................... 200
Style ................................................................................................................................................................................... 200
TextFont ........................................................................................................................................................................... 201
TextSize ............................................................................................................................................................................ 201
Type ................................................................................................................................................................................... 201
Value.................................................................................................................................................................................. 202
Fields .............................................................................................................................................................................................. 202
Methods ................................................................................................................................................................................. 203
Add..................................................................................................................................................................................... 203
AddDocJavascript......................................................................................................................................................... 204
ExecuteThisJavascript ................................................................................................................................................. 205
ExportAsFDF ................................................................................................................................................................... 205
ExportAsHtml ................................................................................................................................................................. 206
ImportAnFDF.................................................................................................................................................................. 207
Remove............................................................................................................................................................................. 207
Properties............................................................................................................................................................................... 207
Count................................................................................................................................................................................. 207
Item.................................................................................................................................................................................... 208
_NewEnum...................................................................................................................................................................... 208
6
Acrobat Search Plug-in............................................................................................................209
Search plug-in using DDE....................................................................................................................................................... 209
Simple query item............................................................................................................................................................... 209
Query item............................................................................................................................................................................. 209
Query options ................................................................................................................................................................ 210
Query language type constants .............................................................................................................................. 211
Word option bit-flag constants ............................................................................................................................... 211
Manipulating indexes through DDE ............................................................................................................................ 212
Options............................................................................................................................................................................. 212
Index operation selectors .......................................................................................................................................... 212
Adobe Acrobat SDK
Interapplication Communication API Reference
6
Contents
11
Acrobat Search Plug-in (Continued)
Search plug-in using Apple events ..................................................................................................................................... 213
SearchAddIndex .................................................................................................................................................................. 213
SearchCountIndexList ....................................................................................................................................................... 213
SearchDoQuery.................................................................................................................................................................... 214
SearchGetIndexByPath ..................................................................................................................................................... 215
SearchGetIndexFlags ......................................................................................................................................................... 216
SearchGetIndexList............................................................................................................................................................. 216
SearchGetIndexPath .......................................................................................................................................................... 216
SearchGetIndexTitle........................................................................................................................................................... 217
SearchGetNthIndex............................................................................................................................................................ 217
SearchRemoveIndex .......................................................................................................................................................... 218
SearchSetIndexFlags.......................................................................................................................................................... 218
Search lists ................................................................................................................................................................................... 219
Menu names ......................................................................................................................................................................... 219
Menu item names ............................................................................................................................................................... 219
Toolbar button names ...................................................................................................................................................... 220
7
Coordinate Systems.................................................................................................................221
User space .................................................................................................................................................................................... 221
Device space ............................................................................................................................................................................... 222
Index .........................................................................................................................................223
Preface
The Adobe® Acrobat® Software Development Kit (SDK) provides a set of Acrobat core API calls for creating
plug-ins and other programs. You can use a subset of these calls for implementing interapplication
communication (IAC) functionality and PDF browser controls. These Acrobat calls support OLE
automation, DDE interapplication interfaces, and Apple events, including the use of AppleScript.
What’s in this guide?
This document provides a detailed reference of all the calls needed for OLE, DDE, and Apple events.
There is no IAC support for the UNIX® versions of Acrobat. There is no IAC support in the Japanese version
of Acrobat.
Who should read this guide?
This guide is for developers that want to communicate with Acrobat from another application or render
Adobe PDF files in their own application, or who are writing plug-ins that need to communicate with or
use multiple applications.
You should already be familiar with at least one of OLE, DDE, Apple events, or AppleScript. You should also
be familiar with the Acrobat core API. Many of the IAC capabilities are actually a subset of those provided
in the Acrobat core API, and many of the IAC messages are similar to core API methods.
Related documentation
For information about
See
A guide to the documentation in the Acrobat SDK
Acrobat SDK Documentation Roadmap
A guide to the sections of the Acrobat SDK that pertain to
Adobe Reader®
Developing for Adobe Reader
A guide to the sample code included with the Acrobat SDK
Guide to SDK Samples
Prototyping code without the overhead of writing and
verifying a complete plug-in or application
Snippet Runner Cookbook
Using DDE, OLE, Apple events, and AppleScript to control
Acrobat and Adobe Reader and to render PDF documents
Developing Applications Using
Interapplication Communication
Using JavaScript™ to develop and enhance standard
workflows in Acrobat and Adobe Reader
Developing Acrobat Applications Using
JavaScript
Detailed descriptions of JavaScript APIs for developing
and enhancing workflows in Acrobat and Adobe Reader
JavaScript for Acrobat API Reference
12
Adobe Acrobat SDK
Preface
Interapplication Communication API Reference
Related documentation
For information about
See
A detailed description of the PDF file format
PDF Reference
Developing plug-ins for Acrobat and Adobe Reader, as
well as for PDF Library applications
Developing Plug-ins and Applications
Detailed descriptions of the APIs for Acrobat and
Adobe Reader plug-ins, as well as for PDF Library
applications
Acrobat and PDF Library API Reference
13
1
OLE Automation
This chapter describes the objects, data types, and methods in the OLE automation interface.
The names AcroExch.App and AxAcroPDFLib.AxAcroPDF are the external strings OLE clients use to
create objects of certain types. The Acrobat developer type libraries call them CAcro.App and
AcroPDFLib, respectively.
Acrobat supports dual interfaces, so the methods all have a return type of HResult.
The following table summarize the available objects and data types.
Object
Description
AcroExch.App
The application itself.
AcroExch.AVDoc
A document as seen in the user interface.
AcroExch.PDDoc
The underlying PDF representation of a document.
AcroExch.HiliteList
An entry in a highlight list.
AcroExch.AVPageView
The area of the window that displays the contents of a page.
AcroExch.PDPage
A single page in the PDF representation of a document.
AcroExch.PDAnnot
An annotation on a page in the PDF file.
AcroExch.PDBookmark
A bookmark in a PDF file.
AcroExch.PDTextSelect
A selection of text on a single page.
AxAcroPDFLib.AxAcroPDF
An object containing PDF browser controls.
AcroExch.Point
A point, specified by its x–coordinate and y–coordinate.
AcroExch.Rect
A rectangle, specified by the top-left and bottom-right points.
AcroExch.Time
A specified time, accurate to the millisecond.
AcroExch.App
The Acrobat application itself. This is a creatable interface. From the application layer, you can control the
appearance of Acrobat, whether Acrobat appears, and the size of the application window. This object
provides access to the menu bar and the toolbar, as well as the visual representation of a PDF file on the
screen (through an AVDoc object).
14
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
AcroExch.App
15
Methods
The App object has the following methods.
Method
Description
CloseAllDocs
Closes all open documents.
Exit
Exits Acrobat.
GetActiveDoc
Gets the frontmost document.
GetActiveTool
Gets the name of the currently active tool.
GetAVDoc
Gets an AcroExch.AVDoc object via its index within the list of open
AVDoc objects.
GetFrame
Gets the window’s frame.
GetInterface
Gets an IDispatch interface for a named object, typically a third-party
plug-in.
GetLanguage
Gets a code that specifies which language the Acrobat application’s user
interface is using.
GetNumAVDocs
Gets the number of open AcroExch.AVDoc objects.
GetPreference
Gets a value from the preferences file.
GetPreferenceEx
Gets the specified application preference, using the VARIANT type to pass
values.
Hide
Hides the Acrobat application.
Lock
Locks the Acrobat application.
Minimize
Minimizes the Acrobat application.
Maximize
Maximizes the Acrobat application.
MenuItemExecute
Executes the menu item whose language-independent menu item name is
specified.
MenuItemIsEnabled
Determines whether the specified menu item is enabled.
MenuItemIsMarked
Determines whether the specified menu item is marked.
MenuItemRemove
Removes the menu item whose language-independent menu item is
specified.
Restore
Restores the main window of the Acrobat application.
SetActiveTool
Sets the active tool according to the specified name, and determines
whether the tool is to be used only once or should remain active after
being used (persistent).
SetFrame
Sets the window’s frame to the specified rectangle.
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
CloseAllDocs
Method
Description
SetPreference
Sets a value in the preferences file.
SetPreferenceEx
Sets the application preference specified by nType to the value stored at
pVal.
Show
Shows the Acrobat application.
ToolButtonIsEnabled
Determines whether the specified toolbar button is enabled.
ToolButtonRemove
Removes the specified button from the toolbar.
Unlock
Unlocks the Acrobat application if it was previously locked.
UnlockEx
Unlocks the Acrobat application if it was previously locked.
16
CloseAllDocs
Closes all open documents. You can close each individual AVDoc object by calling AVDoc.Close.
You must explicitly close all documents or call App.CloseAllDocs. Otherwise, the process never exits.
Syntax
VARIANT_BOOL CloseAllDocs();
Returns
-1 if successful, 0 if not.
Related methods
AVDoc.Close
AVDoc.Open
AVDoc.OpenInWindow
AVDoc.OpenInWindowEx
PDDoc.Close
PDDoc.Open
PDDoc.OpenAVDoc
Exit
Exits Acrobat. Applications should call App.Exit before exiting.
Note: Use App.CloseAllDocs to close all the documents before calling this method.
Adobe Acrobat SDK
Interapplication Communication API Reference
OLE Automation
GetActiveDoc
17
Syntax
VARIANT_BOOL Exit();
Returns
Returns -1 if the entire shutdown process succeeded. This includes closing any open documents,
releasing OLE references, and finally exiting the application. If any step fails, the function returns 0, and the
application continues running. This method does not work if the application is visible (if the user is in
control of the application). In such cases, if the Show method had previously been called, you can call
Hide and then Exit.
Related methods
App.CloseAllDocs
GetActiveDoc
Gets the frontmost document.
Syntax
LPDISPATCH GetActiveDoc();
Returns
The LPDISPATCH for the frontmost AcroExch.AVDoc object. If there are no documents open, it returns
NULL.
Related methods
App.GetAVDoc
GetActiveTool
Gets the name of the currently active tool.
Syntax
BSTR GetActiveTool();
Returns
Returns NULL if there is no active tool. Returns the name of the currently active tool otherwise. See the
Acrobat and PDF Library API Reference for a list of tool names.
Related methods
App.SetActiveTool
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
GetAVDoc
18
GetAVDoc
Gets an AcroExch.AVDoc object from its index within the list of open AVDoc objects. Use
App.GetNumAVDocs to determine the number of AcroExch.AVDoc objects.
Syntax
LPDISPATCH GetAVDoc(long nIndex);
Parameters
nIndex
The index of the document to get.
Returns
The LPDISPATCH for the specified AcroExch.AVDoc document, or NULL if nIndex is greater than the
number of open documents.
Related methods
App.GetActiveTool
GetFrame
Gets the window’s frame.
GetFrame is not useful when the PDF file was opened with AVDoc.OpenInWindow. GetFrame returns the
application window’s frame (not the document window’s frame). However, the application’s window is
hidden when a document is opened using OpenInWindow, and does not change in size as document
windows are moved and resized.
This method is also not useful if the Acrobat application is in single document interface (SDI) mode.
Syntax
LPDISPATCH GetFrame();
Returns
The LPDISPATCH for the window’s frame, specified as an AcroExch.Rect.
If the Acrobat application is in SDI mode, a [0,0,0,0] Rect is returned.
Related methods
App.Maximize
App.SetFrame
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
GetInterface
19
GetInterface
Gets an IDispatch interface for a named object, typically a third-party plug-in. This is an entry point to
functionality that is undefined and which must be provided by the plug-in author. If you are accessing
third-party functionality through GetInterface, ask the author for additional information.
Syntax
LPDISPATCH GetInterface (BSTR szName);
Parameters
szName
Name of the object.
Returns
The LPDISPATCH for the objects’s interface or NULL if the object was not found.
GetLanguage
Gets a code that specifies which language the Acrobat application’s user interface is using.
Syntax
BSTR GetLanguage();
Returns
String containing a three-letter language code. Must be one of the following:
●
DEU – German
●
ENU – English
●
ESP – Spanish
●
FRA – French
●
ITA – Italian
●
NLD – Dutch
●
SVE – Swedish
Related methods
App.GetPreference
App.SetPreference
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
GetNumAVDocs
20
GetNumAVDocs
Gets the number of open AcroExch.AVDoc objects. The maximum number of documents the Acrobat
application can open at a time is specified by the avpMaxOpenDocuments preference, which can be
obtained with App.GetPreferenceEx and set by App.SetPreferenceEx.
Syntax
long GetNumAVDocs();
Returns
The number of open AcroExch.AVDoc objects.
Related methods
App.GetActiveDoc
App.GetAVDoc
GetPreference
Note: This method is deprecated; use GetPreferenceEx instead. GetPreference is unable to accept
important data types such as strings, but GetPreferenceEx can convert many data types into
acceptable formats.
Gets a value from the preferences file. Zoom values (used in avpDefaultZoomScale and
avpMaxPageCacheZoom) are returned as percentages (for example, 1.00 is returned as 100). Colors (used
in avpNoteColor -- PDcolorValue) are automatically converted to RGB values from the representation
used in the preferences file.
Syntax
long GetPreference(short nType);
Parameters
nType
The preferences item whose value is set. See the Acrobat and PDF Library API Reference
for a list of preference items.
Returns
The value of the specified preference item.
Related methods
App.GetLanguage
App.SetPreference
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
GetPreferenceEx
21
GetPreferenceEx
Gets the specified application preference, using the VARIANT type to pass values.
Syntax
VARIANT GetPreferenceEx(short nType);
Parameters
nType
The name of the preferences item whose value is obtained.
Returns
The value of the specified preference item.
Related methods
App.GetLanguage
App.SetPreferenceEx
Hide
Hides the Acrobat application. When the viewer is hidden, the user has no control over it, and the Acrobat
application exits when the last automation object is closed.
Syntax
VARIANT_BOOL Hide();
Returns
-1 if successful, 0 if not.
Related methods
App.Show
Lock
Locks the Acrobat application. Typically, this method is called when using AVDoc.OpenInWindowEx to
draw into another application’s window. If you call App.Lock, you should call App.UnlockEx when you
are done using OLE automation.
There are some advantages and disadvantages of locking the viewer when using
AVDoc.OpenInWindowEx. You must consider these before deciding whether to lock the viewer:
●
Locking prevents problems that can sometimes occur if two processes are trying to open a file at the
same time.
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
Minimize
22
●
Locking prevents a user from using Acrobat’s user interface (such as adding annotations) in your
application’s window.
●
Locking can prevent any other application, including the Acrobat application, from opening PDF files.
This problem can be minimized by calling App.UnlockEx as soon as the file has been opened.
Syntax
VARIANT_BOOL Lock(BSTR szLockedBy);
Parameters
A string that is used as the name of the application that has locked the Acrobat
application.
szLockedBy
Returns
-1 if the Acrobat application was locked successfully, 0 otherwise. Locking fails if the Acrobat application
is visible.
Related methods
App.UnlockEx
Minimize
Minimizes the Acrobat application.
Syntax
VARIANT_BOOL Minimize(long BMinimize);
Parameters
BMinimize
If a positive number, the Acrobat application is minimized. If 0, the Acrobat
application is returned to its normal state.
Returns
-1 if successful, 0 if not.
Related methods
App.GetFrame
App.SetFrame
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
Maximize
23
Maximize
Maximizes the Acrobat application.
Syntax
VARIANT_BOOL Maximize(long bMaximize);
Parameters
bMaximize
If a positive number, the Acrobat application is maximized. If 0, the Acrobat
application is returned to its normal state.
Returns
-1 if successful, 0 if not.
Related methods
App.GetFrame
App.SetFrame
MenuItemExecute
Executes the menu item whose language-independent menu item name is specified.
Syntax
VARIANT_BOOL MenuItemExecute(BSTR szMenuItemName);
Parameters
szMenuItemName
The language-independent name of the menu item to execute. See the Acrobat
and PDF Library API Reference for a list of menu item names.
Returns
Returns -1 if the menu item executes successfully, or 0 if the menu item is missing or is not enabled.
Related methods
App.MenuItemIsEnabled
App.MenuItemIsMarked
App.MenuItemRemove
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
MenuItemIsEnabled
MenuItemIsEnabled
Determines whether the specified menu item is enabled.
Syntax
VARIANT_BOOL MenuItemIsEnabled(BSTR szMenuItemName);
Parameters
szMenuItemName
The language-independent name of the menu item whose enabled state is
obtained. See the Acrobat and PDF Library API Reference for a list of menu item
names.
Returns
-1 if the menu item is enabled, 0 if it is disabled or does not exist.
Related methods
App.MenuItemExecute
App.MenuItemIsMarked
App.MenuItemRemove
MenuItemIsMarked
Determines whether the specified menu item is marked.
Syntax
VARIANT_BOOL MenuItemIsMarked(BSTR szMenuItemName);
Parameters
szMenuItemName
The language-independent name of the menu item whose marked state is
obtained. See the Acrobat and PDF Library API Reference for a list of menu item
names.
Returns
-1 if the menu item is marked, 0 if it is not marked or does not exist.
Related methods
App.MenuItemExecute
App.MenuItemIsEnabled
App.MenuItemRemove
24
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
MenuItemRemove
25
MenuItemRemove
Removes the menu item whose language-independent menu item is specified.
Syntax
VARIANT_BOOL MenuItemRemove(BSTR szMenuItemName);
Parameters
szMenuItemName
The language-independent name of the menu item to remove. See the Acrobat
and PDF Library API Reference for a list of menu item names.
Returns
-1 if the menu item was removed, 0 if the menu item does not exist.
Related methods
App.MenuItemExecute
App.MenuItemIsEnabled
App.MenuItemIsMarked
Restore
Restores the main window of the Acrobat application. Calling this with bRestore set to a positive number
causes the main window to be restored to its original size and position and to become active.
Syntax
VARIANT_BOOL Restore(long bRestore);
Parameters
bRestore
Returns
-1 if successful, 0 if not.
Related methods
App.GetFrame
App.SetFrame
If a positive number, the Acrobat application is restored, 0 otherwise.
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
SetActiveTool
26
SetActiveTool
Sets the active tool according to the specified name, and determines whether the tool is to be used only
once or should remain active after being used (persistent).
Syntax
VARIANT_BOOL SetActiveTool(BSTR szButtonName,
long bPersistent);
Parameters
szButtonName
The name of the tool to set as the active tool. See the Acrobat and PDF Library API
Reference for a list of tool names.
bPersistent
A request indicating whether the tool should be persistent. A positive number
indicates a request to the Acrobat application for the tool to remain active after
it has been used. If 0 is specified, the Acrobat application reverts to the
previously active tool after this tool is used once.
Returns
-1 if the tool was set, 0 otherwise.
Related methods
App.GetActiveTool
App.ToolButtonIsEnabled
App.ToolButtonRemove
SetFrame
Sets the window’s frame to the specified rectangle. This method has no effect if the Acrobat application is
in single document interface (SDI) mode.
Syntax
VARIANT_BOOL SetFrame(LPDISPATCH iAcroRect);
Parameters
iAcroRect
The LPDISPATCH for an AcroExch.Rect specifying the window frame.
iAcroRect contains the instance variable m_lpDispatch, which contains the
LPDISPATCH.
Returns
-1 if the frame was set, 0 if iAcroRect is not of type AcroExch.Rect.
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
SetPreference
27
Related methods
App.GetFrame
App.Maximize
SetPreference
Note: This method is deprecated; use SetPreferenceEx instead. SetPreference is unable to accept
important data types such as strings, but SetPreferenceEx can convert many data types into
acceptable formats.
Sets a value in the preferences file. Zoom values (used in avpDefaultZoomScale and
avpMaxPageCacheZoom) must be passed as percentages and are automatically converted to fixed point
numbers (for example, 100 is automatically converted to 1.0). Colors (used in avpHighlightColor or
avpNoteColor) are automatically converted from RGB values to the representation used in the
preferences file.
Syntax
VARIANT_BOOL SetPreference(short nType, long nValue);
Parameters
nType
The preferences item whose value is set. See the Acrobat and PDF Library API Reference
for a list of preference items.
nValue
The value to set.
Returns
-1 if successful, 0 if not.
Related methods
App.GetLanguage
App.GetPreferenceEx
SetPreferenceEx
Sets the application preference specified by nType to the value stored at pVal. If pVal has a
non-conforming VARTYPE, SetPreferenceEx performs type conversion. For example, a string
representation of an integer is converted to an actual integer.
Syntax
VARIANT_BOOL SetPreferenceEx(short nType, VARIANT* pVal);
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
Show
28
Parameters
nType
The preferences item whose value is set. See the Acrobat and PDF Library API Reference
for a list of preference items.
pVal
The value to set.
Returns
Returns -1 if nType is a supported type or the type conversion is successful, 0 otherwise.
Related methods
App.GetLanguage
App.GetPreferenceEx
Show
Shows the Acrobat application. When the viewer is shown, the user is in control, and the Acrobat
application does not automatically exit when the last automation object is destroyed. However, it will exit
if no documents are being displayed.
Syntax
VARIANT_BOOL Show();
Returns
-1 if successful, 0 if not.
Related methods
App.Hide
ToolButtonIsEnabled
Determines whether the specified toolbar button is enabled.
Syntax
VARIANT_BOOL ToolButtonIsEnabled(BSTR szButtonName);
Parameters
szButtonName
The name of the button whose enabled state is checked. See the Acrobat and
PDF Library API Reference for a list of toolbar button names.
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
ToolButtonRemove
Returns
-1 if the button is enabled, 0 if it is not enabled or does not exist.
Related methods
App.GetActiveTool
App.SetActiveTool
App.ToolButtonRemove
ToolButtonRemove
Removes the specified button from the toolbar.
Syntax
VARIANT_BOOL ToolButtonRemove(BSTR szButtonName);
Parameters
szButtonName
The name of the button to remove. See the Acrobat and PDF Library API
Reference for a list of toolbar button names.
Returns
-1 if the button was removed, 0 otherwise.
Related methods
App.GetActiveTool
App.SetActiveTool
App.ToolButtonIsEnabled
Unlock
Note: In version 4.0 or later, use App.UnlockEx instead.
Unlocks the Acrobat application if it was previously locked. This method clears a flag that indicates the
viewer is locked. If you called App.Lock, you should call App.Unlock when you are done using OLE
automation.
Use App.Lock and App.UnlockEx if you call OpenInWindow.
Typically, you call App.Lock when your application initializes and App.Unlock in your application’s
destructor method.
29
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
UnlockEx
Syntax
VARIANT_BOOL Unlock();
Returns
-1 if successful, 0 if not.
Related methods
App.Lock
App.UnlockEx
UnlockEx
Unlocks the Acrobat application if it was previously locked.
Syntax
VARIANT_BOOL UnlockEx (BSTR szLockedBy);
Parameters
szLockedBy
A string indicating the name of the application to be unlocked.
Returns
-1 if successful, 0 if not.
Related methods
App.Lock
AcroExch.AVDoc
A view of a PDF document in a window. This is a creatable interface. There is one AVDoc object per
displayed document. Unlike a PDDoc object, an AVDoc object has a window associated with it.
Methods
The AVDoc object has the following methods.
Method
Description
BringToFront
Brings the window to the front.
ClearSelection
Clears the current selection.
Close
Closes a document.
30
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
BringToFront
31
Method
Description
FindText
Finds the specified text, scrolls so that it is visible, and highlights it.
GetAVPageView
Gets the AcroExch.AVPageView associated with an AcroExch.AVDoc.
GetFrame
Gets the rectangle specifying the window’s size and location.
GetPDDoc
Gets the AcroExch.PDDoc associated with an AcroExch.AVDoc.
GetTitle
Gets the window’s title.
GetViewMode
Gets the current document view mode (pages only, pages and thumbnails,
or pages and bookmarks).
IsValid
Determines whether the AcroExch.AVDoc is still valid.
Maximize
Maximizes the window if bMaxSize is a positive number.
Open
Opens a file.
OpenInWindow
Opens a PDF file and displays it in a user-specified window.
OpenInWindowEx
Opens a PDF file and displays it in a user-specified window.
PrintPages
Prints a specified range of pages displaying a print dialog box.
PrintPagesEx
Prints a specified range of pages, displaying a print dialog box.
PrintPagesSilent
Prints a specified range of pages without displaying any dialog box.
PrintPagesSilentEx
Prints a specified range of pages without displaying any dialog box.
SetFrame
Sets the window’s size and location.
SetTextSelection
Sets the document’s selection to the specified text selection.
SetTitle
Sets the window’s title.
SetViewMode
Sets the mode in which the document will be viewed (pages only, pages
and thumbnails, or pages and bookmarks)
ShowTextSelect
Changes the view so that the current text selection is visible.
BringToFront
Brings the window to the front.
Syntax
VARIANT_BOOL BringToFront();
Returns
Returns 0 if no document is open, -1 otherwise.
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
ClearSelection
ClearSelection
Clears the current selection.
Syntax
VARIANT_BOOL ClearSelection();
Returns
Returns -1 if the selection was cleared, 0 if no document is open or the selection could not be cleared.
Related methods
AVDoc.SetTextSelection
AVDoc.ShowTextSelect
PDDoc.CreateTextSelect
PDPage.CreatePageHilite
PDPage.CreateWordHilite
PDTextSelect.Destroy
PDTextSelect.GetBoundingRect
PDTextSelect.GetNumText
PDTextSelect.GetPage
PDTextSelect.GetText
Close
Closes a document. You can close all open AVDoc objects by calling App.CloseAllDocs.
To reuse an AVDoc object, close it with AVDoc.Close, then use the AVDoc object’s LPDISPATCH for
AVDoc.OpenInWindow.
Syntax
VARIANT_BOOL Close(long bNoSave);
Parameters
bNoSave
If a positive number, the document is closed without saving it. If 0 and the document
has been modified, the user is asked whether or not the file should be saved.
32
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
FindText
33
Returns
Always returns -1, even if no document is open.
Related methods
App.CloseAllDocs
AVDoc.Open
AVDoc.OpenInWindow
AVDoc.OpenInWindowEx
PDDoc.Close
PDDoc.Open
PDDoc.OpenAVDoc
FindText
Finds the specified text, scrolls so that it is visible, and highlights it.
Syntax
VARIANT_BOOL FindText(BSTR szText, long bCaseSensitive, long bWholeWordsOnly,
long bReset);
Parameters
szText
The text to be found.
bCaseSensitive
If a positive number, the search is case-sensitive. If 0, it is case-insensitive.
bWholeWordsOnly
If a positive number, the search matches only whole words. If 0, it matches
partial words.
bReset
If a positive number, the search begins on the first page of the document. If 0, it
begins on the current page.
Returns
-1 if the text was found, 0 otherwise.
GetAVPageView
Gets the AcroExch.AVPageView associated with an AcroExch.AVDoc.
Syntax
LPDISPATCH GetAVPageView();
Adobe Acrobat SDK
Interapplication Communication API Reference
OLE Automation
GetFrame
Returns
The LPDISPATCH for the AcroExch.AVPageView or NULL if no document is open.
Related methods
AVDoc.GetPDDoc
AVDoc.SetViewMode
AVPageView.GetAVDoc
AVPageView.GetDoc
GetFrame
Gets the rectangle specifying the window’s size and location.
Syntax
LPDISPATCH GetFrame();
Returns
The LPDISPATCH for an AcroExch.Rect containing the frame, or NULL if no document is open.
Related methods
AVDoc.SetFrame
GetPDDoc
Gets the AcroExch.PDDoc associated with an AcroExch.AVDoc.
Syntax
LPDISPATCH GetPDDoc();
Returns
The LPDISPATCH for the AcroExch.PDDoc or NULL if no document is open.
Related methods
AVDoc.GetAVPageView
AVPageView.GetAVDoc
AVPageView.GetDoc
34
Adobe Acrobat SDK
Interapplication Communication API Reference
OLE Automation
GetTitle
GetTitle
Gets the window’s title.
Syntax
BSTR GetTitle();
Returns
The window’s title or NULL if no document is open.
Related methods
AVDoc.Open
AVDoc.SetTitle
PDDoc.OpenAVDoc
GetViewMode
Gets the current document view mode (pages only, pages and thumbnails, or pages and bookmarks).
Syntax
long GetViewMode();
Returns
The current document view mode or 0 if no document is open. The return value is one of the following:
PDDontCare: 0 — leave the view mode as it is
PDUseNone: 1 — display without bookmarks or thumbnails
PDUseThumbs: 2 — display using thumbnails
PDUseBookmarks: 3 — display using bookmarks
PDFullScreen: 4 — display in full screen mode
Related methods
AVDoc.GetAVPageView
AVDoc.SetViewMode
IsValid
Determines whether the AcroExch.AVDoc is still valid. This method only checks if the document has
been closed or deleted; it does not check the internal structure of the document.
Syntax
VARIANT_BOOL IsValid();
35
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
Maximize
36
Returns
-1 if the document can still be used, 0 otherwise.
Related methods
App.GetAVDoc
AVPageView.GetAVDoc
Maximize
Maximizes the window if bMaxSize is a positive number.
Syntax
VARIANT_BOOL Maximize(long bMaxSize);
Parameters
bMaxSize
Indicates whether the window should be maximized.
Returns
-1 if a document is open, 0 otherwise.
Related methods
AVDoc.GetFrame
AVDoc.SetFrame
Open
Opens a file. A new instance of AcroExch.AVDoc must be created for each displayed PDF file.
Note: An application must explicitly close any AVDoc that it opens by calling AVDoc.Close (the
destructor for the AcroExch.AVDoc class does not call AVDoc.Close).
Syntax
VARIANT_BOOL Open(BSTR szFullPath, BSTR szTempTitle);
Parameters
szFullPath
The full path of the file to open.
szTempTitle
An optional title for the window in which the file is opened. If szTempTitle is
NULL or the empty string, it is ignored. Otherwise, szTempTitle is used as the
window title.
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
OpenInWindow
37
Returns
-1 if the file was opened successfully, 0 otherwise.
Related methods
App.CloseAllDocs
AVDoc.Close
AVDoc.GetTitle
AVDoc.OpenInWindow
AVDoc.OpenInWindowEx
AVDoc.SetTitle
PDDoc.Close
PDDoc.Open
PDDoc.OpenAVDoc
OpenInWindow
Note: As of Acrobat 3.0, this method simply returns false. Use the method AVDoc.OpenInWindowEx
instead.
Syntax
VARIANT_BOOL OpenInWindow(BSTR fileName, short hWnd);
Parameters
fileName
The full path of the file to open.
hWnd
Handle for the window in which the file is displayed.
Returns
-1
Related methods
App.CloseAllDocs
AVDoc.Close
AVDoc.Open
AVDoc.OpenInWindowEx
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
OpenInWindowEx
38
PDDoc.Close
PDDoc.Open
PDDoc.OpenAVDoc
OpenInWindowEx
Opens a PDF file and displays it in a user-specified window. The default Windows file system is used to
open the file.
Note: Acrobat uses only its built-in implementation of the file opening code—not any replacement file
system version that a developer might have added with a plug-in.
An application must explicitly close any AVDoc that it opens by calling AVDoc.Close (the destructor for
the AcroExch.AVDoc class does not call AVDoc.Close).
Do not set the view mode to Close with AVDoc.SetViewMode when using AVDoc.OpenInWindowEx;
this will cause the viewer and application to hang.
If you use a view mode of AV_PAGE_VIEW, the pagemode parameter will be ignored.
See AVApp.Lock for a discussion of whether to lock the viewer before making this call.
Syntax
VARIANT_BOOL OpenInWindowEx(LPCTSTR szFullPath, long hWnd,
long openFlags, long useOpenParams
long pgNum, short pageMode,
short zoomType, long zoom, short top,
short left);
Parameters
szFullPath
The full path of the file to open.
hWnd
Handle for the window in which the file is displayed.
openFlags
Type of window view. Must be one of the following:
AV_EXTERNAL_VIEW — Display the AVPageView, scrollbars, toolbar, and
bookmark or thumbnails pane. Annotations are active.
AV_DOC_VIEW — Display the AVPageView, scrollbars, and bookmark or
thumbnails pane. Annotations are active.
AV_PAGE_VIEW — Display only the AVPageView (the window that displays
the PDF file). Do not display scrollbars, the toolbar, and bookmark or
thumbnails pane. Annotations are active.
Note: Use either AV_DOC_VIEW or AV_PAGE_VIEW whenever possible. Use
AV_EXTERNAL_VIEW only if you do not want the application to display
its own toolbar. Use AV_PAGE_VIEW to open the file with no scrollbars
and no status window at the bottom of the page.
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
useOpenParams
OpenInWindowEx
0 indicates that the open action of the file is used; a positive number indicates
that the action is overridden with the parameters that follow.
pgNum
Page number at which the file is to be opened if useOpenParams is a positive
number. The first page is zero.
pageMode
Specifies page view mode if useOpenParams is a positive number. Possible
values:
PDDontCare: 0 — leave the view mode as it is
PDUseNone: 1 — display without bookmarks or thumbnails
PDUseThumbs: 2 — display using thumbnails
PDUseBookmarks: 3 — display using bookmarks
PDFullScreen: 4 — display in full screen mode
zoomType
Zoom type of the page view if useOpenParams is a positive number. Possible
values are:
AVZoomFitHeight — Fits the page’s height in the window.
AVZoomFitPage — Fits the page in the window.
AVZoomFitVisibleWidth — Fits the page’s visible content into the
window.
AVZoomFitWidth — Fits the page’s width into the window.
AVZoomNoVary — A fixed zoom, such as 100%.
zoom
Zoom factor, used only for AVZoomNoVary if useOpenParams is a positive
number.
top
Used for certain zoom types (such as AVZoomNoVary) if useOpenParams is a
positive number. See the PDF Reference for information on views.
left
Used for certain zoom types (such as AVZoomNoVary) if useOpenParams is a
positive number. See the PDF Reference for information on views.
Returns
-1 if the document was opened successfully, 0 otherwise.
Related methods
App.CloseAllDocs
AVDoc.Close
AVDoc.Open
AVDoc.OpenInWindow
PDDoc.Close
PDDoc.Open
PDDoc.OpenAVDoc
39
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
PrintPages
40
PrintPages
Prints a specified range of pages displaying a print dialog box. PrintPages always uses the default
printer setting.
Syntax
VARIANT_BOOL PrintPages(long nFirstPage,
long nLastPage,long nPSLevel,
long bBinaryOk, long bShrinkToFit);
Parameters
nFirstPage
The first page to be printed. The first page in a PDDoc object is page 0.
nLastPage
The last page to be printed.
nPSLevel
Valid values are 2 and 3. If 2, PostScript® Level 2 operators are used. If 3,
PostScript Language Level 3 operators are also used.
bBinaryOk
If a positive number, binary data can be included in the PostScript program. If 0,
all data is encoded as 7-bit ASCII.
bShrinkToFit
If a positive number, the page is shrunk (if necessary) to fit within the imageable
area of the printed page. If 0, it is not.
Returns
0 if there were any exceptions while printing or if no document was open, -1 otherwise.
Related methods
AVDoc.PrintPagesEx
AVDoc.PrintPagesSilent
AVDoc.PrintPagesSilentEx
PrintPagesEx
Prints a specified range of pages, displaying a print dialog box. PrintPagesEx has more parameters than
PrintPages. PrintPagesEx always uses the default printer setting.
Syntax
VARIANT_BOOL printPagesEx(long nFirstPage,long nLastPage,
long nPSLevel, long bBinaryOk,
long bShrinkToFit, long bReverse,
long bFarEastFontOpt, long bEmitHalftones,
long iPageOption);
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
PrintPagesSilent
41
Parameters
nFirstPage
The first page to be printed. The first page in a PDDoc object is page 0.
nLastPage
The last page to be printed.
nPSLevel
If 2, PostScript Level 2 operators are used. If 3, PostScript Language Level 3
operators are also used.
bBinaryOk
If a positive number, binary data may be included in the PostScript program. If 0,
all data is encoded as 7-bit ASCII.
bShrinkToFit
If a positive number, the page is shrunk (if necessary) to fit within the imageable
area of the printed page. If 0, it is not.
bReverse
(PostScript printing only) If a positive number, print the pages in reverse order. If
false, print the pages in the regular order.
bFarEastFontOpt
(PostScript printing only) Set to a positive number if the destination printer has
multibyte fonts; set to 0 otherwise.
bEmitHalftones
(PostScript printing only) If a positive number, emit the halftones specified in
the document. If 0, do not.
iPageOption
Pages in the range to print. Must be one of: PDAllPages, PDEvenPagesOnly,
or PDOddPagesOnly.
Returns
0 if there were any exceptions while printing or if no document was open, -1 otherwise.
Related methods
AVDoc.PrintPages
AVDoc.PrintPagesSilent
AVDoc.PrintPagesSilentEx
PrintPagesSilent
Prints a specified range of pages without displaying any dialog box. This method is identical to
AVDoc.PrintPages except for not displaying the dialog box. PrintPagesSilent always uses the
default printer setting.
Syntax
VARIANT_BOOL PrintPagesSilent(long nFirstPage, long nLastPage,
long nPSLevel, long bBinaryOk,
long bShrinkToFit);
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
PrintPagesSilentEx
42
Parameters
nFirstPage
The first page to be printed. The first page in a PDDoc object is page 0.
nLastPage
The last page to be printed.
nPSLevel
If 2, PostScript Level 2 operators are used. If 3, PostScript Language Level 3
operators are also used.
bBinaryOk
If a positive number, binary data may be included in the PostScript program. If 0,
all data is encoded as 7-bit ASCII.
bShrinkToFit
If a positive number, the page is shrunk (if necessary) to fit within the imageable
area of the printed page. If 0, it is not.
Returns
0 if there were any exceptions while printing or if no document was open, -1 otherwise.
Related methods
AVDoc.PrintPages
AVDoc.PrintPagesEx
AVDoc.PrintPagesSilentEx
PrintPagesSilentEx
Prints a specified range of pages without displaying any dialog box. This method is identical to
AVDoc.PrintPagesEx except for not displaying the dialog box. PrintPagesSilentEx has more
parameters than PrintPagesSilent. PrintPagesSilentEx always uses the default printer setting.
Syntax
VARIANT_BOOL PrintPagesSilentEx(long nFirstPage,
long nLastPage,
long nPSLevel, long bBinaryOk,
long bShrinkToFit, long bReverse,
long bFarEastFontOpt,
long bEmitHalftones,
long iPageOption);
Parameters
nFirstPage
The first page to be printed.
nLastPage
The last page to be printed.
nPSLevel
If 2, PostScript Level 2 operators are used. If 3, PostScript Language Level 3
operators are also used.
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
SetFrame
43
bBinaryOk
If a positive number, binary data may be included in the PostScript program. If 0,
all data is encoded as 7-bit ASCII.
bShrinkToFit
If a positive number, the page is shrunk (if necessary) to fit within the imageable
area of the printed page. If 0, it is not.
bReverse
(PostScript printing only) If a positive number, print the pages in reverse order. If
false, print the pages in the regular order.
bFarEastFontOpt
(PostScript printing only) Set to a positive number if the destination printer has
multibyte fonts; set to 0 otherwise.
bEmitHalftones
(PostScript printing only) If a positive number, emit the halftones specified in
the document. If 0, do not.
iPageOption
Pages in the range to print. Must be one of: PDAllPages, PDEvenPagesOnly,
or PDOddPagesOnly.
Returns
0 if there were any exceptions while printing, -1 otherwise.
Related methods
AVDoc.PrintPages
AVDoc.PrintPagesEx
AVDoc.PrintPagesSilentEx
SetFrame
Sets the window’s size and location.
Syntax
VARIANT_BOOL SetFrame(LPDISPATCH iAcroRect);
Parameters
iAcroRect
Returns
Always returns -1.
Related methods
AVDoc.GetFrame
The LPDISPATCH for an AcroExch.Rect specifying the window frame.
iAcroRect’s instance variable m_lpDispatch contains this LPDISPATCH.
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
SetTextSelection
SetTextSelection
Sets the document’s selection to the specified text selection. Before calling this method, use one of the
following to create the text selection:
PDDoc.CreateTextSelect — Creates from a rectangle.
PDPage.CreatePageHilite — Creates from a list of character offsets and counts.
PDPage.CreateWordHilite — Creates from a list of word offsets and counts.
After calling this method, use AVDoc.ShowTextSelect to show the selection.
Syntax
VARIANT_BOOL SetTextSelection(LPDISPATCH iAcroPDTextSelect);
Parameters
iAcroPDTextSelect
The LPDISPATCH for the text selection to use. iAcroPDTextSelect
contains the instance variable m_lpDispatch, which contains the
LPDISPATCH.
Returns
Returns -1 if successful. Returns 0 if no document is open or the LPDISPATCH is not a PDTextSelect
object.
Related methods
AVDoc.ClearSelection
AVDoc.ShowTextSelect
PDDoc.CreateTextSelect
PDPage.CreatePageHilite
PDPage.CreateWordHilite
PDTextSelect.Destroy
PDTextSelect.GetBoundingRect
PDTextSelect.GetNumText
PDTextSelect.GetPage
PDTextSelect.GetText
44
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
SetTitle
SetTitle
Sets the window’s title.
Syntax
VARIANT_BOOL SetTitle(BSTR szTitle);
Parameters
The title to be set. This method cannot be used for document windows, but only for
windows created by plug-ins.
szTitle
Returns
Returns 0 if no document is open, -1 otherwise.
Related methods
AVDoc.GetTitle
AVDoc.Open
PDDoc.OpenAVDoc
SetViewMode
Sets the mode in which the document will be viewed (pages only, pages and thumbnails, or pages and
bookmarks).
Syntax
VARIANT_BOOL SetViewMode(long nType);
Parameters
nType
The view mode to be set. Possible values:
PDDontCare: 0 — leave the view mode as it is
PDUseNone: 1 — display without bookmarks or thumbnails
PDUseThumbs: 2 — display using thumbnails
PDUseBookmarks: 3 — display using bookmarks
Note: Do not set the view mode to Close with AVDoc.SetViewMode when using
AVDoc.OpenInWindowEx; this will cause the viewer and application to hang.
Returns
0 if an error occurred while setting the view mode or if no document was open, -1 otherwise.
45
Adobe Acrobat SDK
Interapplication Communication API Reference
Related methods
AVDoc.GetAVPageView
AVDoc.GetViewMode
ShowTextSelect
Changes the view so that the current text selection is visible.
Syntax
VARIANT_BOOL ShowTextSelect();
Returns
Returns 0 if no document is open, -1 otherwise.
Related methods
AVDoc.ClearSelection
AVDoc.SetTextSelection
PDDoc.CreateTextSelect
PDPage.CreatePageHilite
PDPage.CreateWordHilite
PDTextSelect.Destroy
PDTextSelect.GetBoundingRect
PDTextSelect.GetNumText
PDTextSelect.GetPage
PDTextSelect.GetText
OLE Automation
ShowTextSelect
46
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
AcroExch.AVPageView
47
AcroExch.AVPageView
The area of the Acrobat application’s window that displays the contents of a document’s page. This is a
non-creatable interface. Every AVDoc object has an AVPageView object and vice versa. The object
provides access to the PDDoc and PDPage objects for the document being displayed.
Methods
The AVPageView object has the following methods.
Method
Description
DevicePointToPage
Converts the coordinates of a point from device space to user space.
DoGoBack
Goes to the previous view on the view history stack, if any.
DoGoForward
Goes to the next view on the view history stack, if any.
GetAperture
Gets the aperture of the specified page view.
GetAVDoc
Gets the AcroExch.AVDoc associated with the current page.
GetDoc
Gets the AcroExch.PDDoc corresponding to the current page.
GetPage
Gets the AcroExch.PDPage corresponding to the current page.
GetPageNum
Gets the page number of the current page.
GetZoom
Gets the current zoom factor, specified as a percent.
GetZoomType
Gets the current zoom type.
Goto
Goes to the specified page.
PointToDevice
Deprecated. Converts the coordinates of a point from user space to device
space.
ReadPageDown
Scrolls forward through the document by one screen area.
ReadPageUp
Scrolls backward through the document by one screen area.
ScrollTo
Scrolls to the specified location on the current page.
ZoomTo
Zooms to the specified magnification.
DevicePointToPage
Converts the coordinates of a point from device space to user space.
Syntax
LPDISPATCH DevicePointToPage(LPDISPATCH iAcroPoint);
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
DoGoBack
48
Parameters
iAcroPoint
The LPDISPATCH for the AcroExch.Point whose coordinates are converted.
iAcroPoint contains the instance variable m_lpDispatch, which contains
the LPDISPATCH.
Returns
The LPDISPATCH for an AcroExch.Point containing the converted coordinates.
Related methods
AVPageView.PointToDevice
DoGoBack
Goes to the previous view on the view history stack, if any.
Syntax
VARIANT_BOOL DoGoBack();
Returns
Always returns -1.
Related methods
AVPageView.DoGoForward
DoGoForward
Goes to the next view on the view history stack, if any.
Syntax
VARIANT_BOOL DoGoForward();
Returns
Always returns -1.
Related methods
AVPageView.DoGoBack
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
GetAperture
GetAperture
Gets the aperture of the specified page view. The aperture is the rectangular region of the window in
which the document is drawn, measured in device space units.
Syntax
CAcroRect* GetAperture();
Returns
A pointer to the aperture rectangle. Its coordinates are specified in device space.
Related methods
AVDoc.GetAVPageView
AVPageView.GetAVDoc
AVPageView.GetDoc
AVPageView.GetPage
AVPageView.GetZoomType
GetAVDoc
Gets the AcroExch.AVDoc associated with the current page.
Syntax
LPDISPATCH GetAVDoc();
Returns
The LPDISPATCH for the AcroExch.AVDoc.
Related methods
AVDoc.GetAVPageView
AVDoc.GetPDDoc
AVPageView.GetDoc
GetDoc
Gets the AcroExch.PDDoc corresponding to the current page.
Syntax
LPDISPATCH GetDoc();
49
Adobe Acrobat SDK
Interapplication Communication API Reference
Returns
The LPDISPATCH for the AcroExch.PDDoc.
Related methods
AVDoc.GetAVPageView
AVDoc.GetPDDoc
AVPageView.GetAVDoc
GetPage
Gets the AcroExch.PDPage corresponding to the current page.
Syntax
LPDISPATCH GetPage();
Returns
The LPDISPATCH for the AcroExch.PDPage.
Related methods
AVPageView.GetPageNum
PDDoc.AcquirePage
PDDoc.GetNumPages
PDPage.GetDoc
PDPage.GetNumber
PDPage.GetRotate
PDPage.GetSize
PDTextSelect.GetPage
GetPageNum
Gets the page number of the current page. The first page in a document is page zero.
Syntax
long GetPageNum();
OLE Automation
GetPage
50
Adobe Acrobat SDK
Interapplication Communication API Reference
OLE Automation
GetZoom
Returns
The current page’s page number.
Related methods
AVPageView.GetPage
PDDoc.AcquirePage
PDDoc.GetNumPages
PDPage.GetDoc
PDPage.GetNumber
PDPage.GetRotate
PDPage.GetSize
PDTextSelect.GetPage
GetZoom
Gets the current zoom factor, specified as a percent. For example, 100 is returned if the magnification
is 1.0.
Syntax
long GetZoom();
Returns
The current zoom factor.
Related methods
App.GetPreference
AVPageView.GetZoomType
AVPageView.ZoomTo
GetZoomType
Gets the current zoom type.
Syntax
short GetZoomType();
51
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
Returns
Zoom type. The value is one of the following:
AVZoomFitHeight — Fits the page’s height in the window.
AVZoomFitPage — Fits the page in the window.
AVZoomFitVisibleWidth — Fits the page’s visible content into the window.
AVZoomFitWidth — Fits the page’s width into the window.
AVZoomNoVary — A fixed zoom, such as 100%.
Related methods
App.GetPreference
AVPageView.GetZoomType
AVPageView.ZoomTo
Goto
Goes to the specified page.
Syntax
VARIANT_BOOL GoTo(long nPage);
Parameters
nPage
Page number of the destination page. The first page in a PDDoc object is page 0.
Returns
-1 if the Acrobat application successfully went to the page, 0 otherwise.
Related methods
AVPageView.DoGoBack
AVPageView.DoGoForward
AVPageView.ReadPageDown
AVPageView.ReadPageUp
AVPageView.ScrollTo
AVPageView.ZoomTo
Goto
52
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
PointToDevice
PointToDevice
Converts the coordinates of a point from user space to device space.
Note: Deprecated. Do not use this method.
Syntax
LPDISPATCH PointToDevice(LPDISPATCH iAcroPoint);
Parameters
iAcroPoint
The LPDISPATCH for the AcroExch.Point whose coordinates are converted.
iAcroPoint contains the instance variable m_lpDispatch, which contains this
LPDISPATCH.
Returns
The LPDISPATCH for an AcroExch.Point containing the converted coordinates.
Related methods
AVPageView.DevicePointToPage
ReadPageDown
Scrolls forward through the document by one screen area.
Syntax
VARIANT_BOOL ReadPageDown();
Returns
Always returns -1.
Related methods
AVPageView.DoGoBack
AVPageView.DoGoForward
AVPageView.Goto
AVPageView.ReadPageUp
AVPageView.ScrollTo
AVPageView.ZoomTo
53
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
ReadPageUp
ReadPageUp
Scrolls backward through the document by one screen area.
Syntax
VARIANT_BOOL ReadPageUp();
Returns
Always returns -1.
Related methods
AVPageView.DoGoBack
AVPageView.DoGoForward
AVPageView.Goto
AVPageView.ReadPageDown
AVPageView.ScrollTo
AVPageView.ZoomTo
ScrollTo
Scrolls to the specified location on the current page.
Syntax
VARIANT_BOOL ScrollTo(short nX, short nY);
Parameters
nX
The x–coordinate of the destination.
nY
The y–coordinate of the destination.
Returns
-1 if the Acrobat application successfully scrolled to the specified location, 0 otherwise.
Related methods
AVPageView.DoGoBack
AVPageView.DoGoForward
AVPageView.Goto
54
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
ZoomTo
AVPageView.ReadPageDown
AVPageView.ReadPageUp
AVPageView.ZoomTo
ZoomTo
Zooms to the specified magnification.
Syntax
VARIANT_BOOL ZoomTo(short nType, short nScale);
Parameters
nType
Zoom type. Possible values are:
AVZoomFitHeight — Fits the page’s height into the window.
AVZoomFitPage — Fits the page into the window.
AVZoomFitVisibleWidth — Fits the page’s visible content into the
window.
AVZoomFitWidth — Fits the page’s width into the window.
AVZoomNoVary — A fixed zoom, such as 100%.
nScale
The desired zoom factor, expressed as a percentage. For example, 100 is a
magnification of 1.0.
Returns
-1 if the magnification was set successfully, 0 otherwise.
Related methods
AVPageView.GetZoomType
AVPageView.Goto
AVPageView.ScrollTo
55
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
AcroExch.HiliteList
56
AcroExch.HiliteList
A highlighted region of text in a PDF document, which may include one or more contiguous groups of
characters or words on a single page. This is a creatable interface. This object has a single method, Add,
and is used by the PDPage object to create PDTextSelect objects.
Add
Adds the highlight specified by nOffset and nLength to the current highlight list. Highlight lists are
used to highlight one or more contiguous groups of characters or words on a single page.
Highlight lists are used both for character-based and word-based highlighting, although a single highlight
list cannot contain a mixture of character and word highlights. After creating a highlight list, use
PDPage.CreatePageHilite or PDPage.CreateWordHilite (depending on whether the highlight
list is used for characters or words) to create a text selection from the highlight list.
Syntax
VARIANT_BOOL Add(short nOffset, short nLength);
Parameters
nOffset
Offset of the first word or character to be highlighted, the first of which has an
offset of zero.
nLength
The number of consecutive words or characters to be highlighted.
Returns
Always returns -1.
Related methods
PDPage.CreatePageHilite
PDPage.CreateWordHilite
AcroExch.PDAnnot
An annotation on a page in a PDF file. This is a non-creatable interface. Acrobat applications have two
built-in annotation types: PDTextAnnot and PDLinkAnnot. The object provides access to the physical
attributes of the annotation. Plug-ins may add movie and Widget (form field) annotations, and developers
can define new annotation subtypes by creating new annotation handlers.
Methods
The PDAnnot object has the following methods.
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
GetColor
Method
Description
GetColor
Gets an annotation’s color.
GetContents
Gets a text annotation’s contents.
GetDate
Gets an annotation’s date.
GetRect
Gets an annotation’s bounding rectangle.
GetSubtype
Gets an annotation’s subtype.
GetTitle
Gets a text annotation’s title.
IsEqual
Determines whether an annotation is the same as the specified annotation.
IsOpen
Tests whether a text annotation is open.
IsValid
Tests whether an annotation is still valid.
Perform
Performs a link annotation’s action.
SetColor
Sets an annotation’s color.
SetContents
Sets a text annotation’s contents.
SetDate
Sets an annotation’s date.
SetOpen
Opens or closes a text annotation.
SetRect
Sets an annotation’s bounding rectangle.
SetTitle
Sets a text annotation’s title.
57
GetColor
Gets an annotation’s color.
Syntax
long GetColor();
Returns
The annotation’s color, a long value of the form 0x00BBGGRR where the first byte from the right (RR) is a
relative value for red, the second byte (GG) is a relative value for green, and the third byte (BB) is a relative
value for blue. The high-order byte must be 0.
Related methods
PDAnnot.SetColor
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
GetContents
GetContents
Gets a text annotation’s contents.
Syntax
BSTR GetContents();
Returns
The annotation’s contents.
Related methods
PDAnnot.SetContents
PDAnnot.GetDate
PDAnnot.GetRect
PDAnnot.GetSubtype
PDAnnot.GetTitle
GetDate
Gets an annotation’s date.
Syntax
LPDISPATCH GetDate();
Returns
The LPDISPATCH for an AcroExch.Time object containing the date.
Related methods
PDAnnot.GetContents
PDAnnot.GetRect
PDAnnot.GetSubtype
PDAnnot.GetTitle
PDAnnot.SetDate
GetRect
Gets an annotation’s bounding rectangle.
58
Adobe Acrobat SDK
Interapplication Communication API Reference
OLE Automation
GetSubtype
Syntax
LPDISPATCH GetRect();
Returns
The LPDISPATCH for an AcroExch.Rect containing the annotation’s bounding rectangle.
Related methods
PDAnnot.GetContents
PDAnnot.GetDate
PDAnnot.GetSubtype
PDAnnot.GetTitle
PDAnnot.SetRect
GetSubtype
Gets an annotation’s subtype.
Syntax
BSTR GetSubtype();
Returns
The annotation’s subtype. The built-in subtypes are Text and Link.
Related methods
PDAnnot.GetContents
PDAnnot.GetDate
PDAnnot.GetRect
PDAnnot.GetTitle
GetTitle
Gets a text annotation’s title.
Syntax
BSTR GetTitle();
59
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
IsEqual
60
Returns
The annotation’s title.
Related methods
PDAnnot.GetContents
PDAnnot.GetDate
PDAnnot.GetRect
PDAnnot.GetSubtype
PDAnnot.SetTitle
IsEqual
Determines whether an annotation is the same as the specified annotation.
Syntax
VARIANT_BOOL IsEqual(LPDISPATCH PDAnnot);
Parameters
PDAnnot
The LPDISPATCH for the AcroExch.PDAnnot to be tested. PDAnnot contains
the instance variable m_lpDispatch, which contains the LPDISPATCH.
Returns
-1 if the annotations are the same, 0 otherwise.
Related methods
PDAnnot.GetContents
PDAnnot.GetDate
PDAnnot.GetRect
PDAnnot.GetSubtype
PDAnnot.GetTitle
PDAnnot.IsOpen
PDAnnot.IsValid
IsOpen
Tests whether a text annotation is open.
Adobe Acrobat SDK
Interapplication Communication API Reference
OLE Automation
IsValid
61
Syntax
VARIANT_BOOL IsOpen();
Returns
-1 if open, 0 otherwise.
Related methods
PDAnnot.GetContents
PDAnnot.GetDate
PDAnnot.GetRect
PDAnnot.GetSubtype
PDAnnot.GetTitle
PDAnnot.IsEqual
PDAnnot.IsValid
PDAnnot.SetOpen
IsValid
Tests whether an annotation is still valid. This method is intended only to test whether the annotation has
been deleted, not whether it is a completely valid annotation object.
Syntax
VARIANT_BOOL IsValid();
Returns
-1 if the annotation is valid, 0 otherwise.
Related methods
PDAnnot.GetContents
PDAnnot.GetDate
PDAnnot.GetRect
PDAnnot.GetSubtype
PDAnnot.GetTitle
PDAnnot.IsEqual
PDAnnot.IsOpen
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
Perform
62
Perform
Performs a link annotation’s action.
Syntax
VARIANT_BOOL Perform(LPDISPATCH iAcroAVDoc);
Parameters
iAcroAVDoc
The LPDISPATCH for the AcroExch.AVDoc in which the annotation is located.
iAcroAVDoc contains the instance variable m_lpDispatch, which contains
the LPDISPATCH.
Returns
-1 if the action was executed successfully, 0 otherwise.
Related methods
PDAnnot.IsValid
SetColor
Sets an annotation’s color.
Syntax
VARIANT_BOOL SetColor(long nRGBColor);
Parameters
nRGBColor
The color to use for the annotation.
Returns
-1 if the annotation’s color was set, 0 if the Acrobat application does not support editing.
nRGBColor is a long value with the form 0x00BBGGRR where the first byte from the right (RR) is a relative
value for red, the second byte (GG) is a relative value for green, and the third byte (BB) is a relative value for
blue. The high-order byte must be 0.
Related methods
PDAnnot.GetColor
PDAnnot.SetContents
PDAnnot.SetDate
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
SetContents
PDAnnot.SetOpen
PDAnnot.SetRect
PDAnnot.SetTitle
SetContents
Sets a text annotation’s contents.
Syntax
VARIANT_BOOL SetContents(BSTR szContents);
Parameters
szContents
The contents to use for the annotation.
Returns
0 if the Acrobat application does not support editing, -1 otherwise.
Related methods
PDAnnot.GetContents
PDAnnot.SetColor
PDAnnot.SetDate
PDAnnot.SetOpen
PDAnnot.SetRect
PDAnnot.SetTitle
SetDate
Sets an annotation’s date.
Syntax
VARIANT_BOOL SetDate(LPDISPATCH iAcroTime);
Parameters
iAcroTime
The LPDISPATCH for the date and time to use for the annotation.
iAcroTime’s instance variable m_lpDispatch contains this LPDISPATCH.
63
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
SetOpen
Returns
-1 if the date was set, 0 if the Acrobat application does not support editing.
Related methods
PDAnnot.GetTitle
PDAnnot.SetColor
PDAnnot.SetContents
PDAnnot.SetOpen
PDAnnot.SetRect
PDAnnot.SetTitle
SetOpen
Opens or closes a text annotation.
Syntax
VARIANT_BOOL SetOpen(long bIsOpen);
Parameters
bIsOpen
If a positive number, the annotation is open. If 0, the annotation is closed.
Returns
Always returns -1.
Related methods
PDAnnot.IsOpen
PDAnnot.SetColor
PDAnnot.SetContents
PDAnnot.SetDate
PDAnnot.SetRect
PDAnnot.SetTitle
SetRect
Sets an annotation’s bounding rectangle.
64
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
SetTitle
65
Syntax
VARIANT_BOOL SetRect(LPDISPATCH iAcroRect);
Parameters
iAcroRect
The LPDISPATCH for the bounding rectangle (AcroExch.Rect) to set.
iAcroRect contains the instance variable m_lpDispatch, which contains the
LPDISPATCH.
Returns
-1 if a rectangle was supplied, 0 otherwise.
Related methods
PDAnnot.GetRect
PDAnnot.SetColor
PDAnnot.SetContents
PDAnnot.SetDate
PDAnnot.SetOpen
PDAnnot.SetTitle
SetTitle
Sets a text annotation’s title.
Syntax
VARIANT_BOOL SetTitle(BSTR szTitle);
Parameters
szTitle
The title to use.
Returns
-1 if the title was set, 0 if the Acrobat application does not support editing.
Related methods
PDAnnot.GetByTitle
PDAnnot.SetColor
PDAnnot.SetContents
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
AcroExch.PDBookmark
66
PDAnnot.SetDate
PDAnnot.SetOpen
PDAnnot.SetRect
AcroExch.PDBookmark
A bookmark for a page in a PDF file. This is a creatable interface. Each bookmark has a title that appears on
screen, and an action that specifies what happens when a user clicks on the bookmark.
Bookmarks can either be created interactively by the user through the Acrobat application’s user interface
or programmatically generated. The typical action for a user-created bookmark is to move to another
location in the current document, although any action can be specified. It is not possible to create a
bookmark with OLE—only to destroy one.
Methods
The PDBookmark object has the following methods.
Method
Description
Destroy
Destroys a bookmark.
GetByTitle
Gets the bookmark that has the specified title.
GetTitle
Gets a bookmark’s title.
IsValid
Determines whether the bookmark is valid.
Perform
Performs a bookmark’s action.
SetTitle
Sets a bookmark’s title.
Destroy
Destroys a bookmark.
Syntax
VARIANT_BOOL Destroy();
Returns
0 if the Acrobat application does not support editing (making it impossible to delete the bookmark), -1
otherwise.
Related methods
PDBookmark.IsValid
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
GetByTitle
67
GetByTitle
Gets the bookmark that has the specified title. The AcroExch.PDBookmark object is set to the specified
bookmark as a side effect of the method; it is not the method’s return value. You cannot enumerate
bookmark titles with this method.
Syntax
VARIANT_BOOL GetByTitle(LPDISPATCH iAcroPDDoc,
BSTR bookmarkTitle);
Parameters
iAcroPDDoc
The LPDISPATCH for the document (AcroExch.PDDoc object) containing the
bookmark. iAcroPDDoc contains the instance variable m_lpDispatch, which
contains the LPDISPATCH.
bookmarkTitle
The title of the bookmark to get. The capitalization of the title must match that
in the bookmark.
Returns
-1 if the specified bookmark exists (the method determines this using the PDBookmark.IsValid
method), 0 otherwise.
Related methods
PDBookmark.GetTitle
PDBookmark.SetTitle
Example
CAcroPDBookmark* bookmark = new CAcroPDBookmark;
bookmark->CreateDispatch("AcroExch.PDBookmark");
bookmark->GetByTitle(m_pAcroAVDoc->GetPDDoc(), "Name of Bookmark");
if (bookmark->IsValid())
bookmark->Perform(m_pAcroAVDoc->m_lpDispatch);
else
AfxMessageBox("Bookmark not valid");
GetTitle
Gets a bookmark’s title.
Syntax
BSTR GetTitle();
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
IsValid
68
Returns
The title.
Related methods
PDBookmark.GetByTitle
PDBookmark.SetTitle
IsValid
Determines whether the bookmark is valid. This method only checks whether the bookmark has been
deleted; it does not thoroughly check the bookmark’s data structures.
Syntax
VARIANT_BOOL IsValid();
Returns
-1 if the bookmark is valid, 0 otherwise.
Related methods
PDBookmark.Destroy
Syntax
Perform
Performs a bookmark’s action.
Syntax
VARIANT_BOOL Perform(LPDISPATCH iAcroAVDoc);
Parameters
iAcroAVDoc
The LPDISPATCH for the AcroExch.AVDoc in which the bookmark is located.
iAcroAVDoc contains the instance variable m_lpDispatch, which contains
the LPDISPATCH.
Returns
-1 if the action was executed successfully, 0 otherwise.
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
SetTitle
69
Related methods
PDBookmark.IsValid
SetTitle
Sets a bookmark’s title.
Syntax
VARIANT_BOOL SetTitle(BSTR szNewTitle);
Parameters
szNewTitle
The title to set.
Returns
0 if the Acrobat application does not support editing, -1 otherwise.
Related methods
PDBookmark.GetByTitle
PDBookmark.GetTitle
AcroExch.PDDoc
The underlying PDF representation of a document. This is a creatable interface. There is a correspondence
between a PDDoc object and an ASFile object (an opaque representation of an open file made available
through an interface encapsulating Acrobat’s access to file services), and the PDDoc object is the hidden
object behind every AVDoc object. An ASFile object may have zero or more underlying files, so a PDF file
does not always correspond to a single disk file. For example, an ASFile object may provide access to PDF
data in a database.
Through PDDoc objects, your application can perform most of the Document menu items from Acrobat
(delete pages, replace pages, and so on), create and delete thumbnails, and set and retrieve document
information fields.
Methods
The PDDoc object has the following methods.
Method
Description
AcquirePage
Acquires the specified page.
ClearFlags
Clears a document’s flags.
Close
Closes a file.
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
AcroExch.PDDoc
70
Method
Description
Create
Creates a new AcroExch.PDDoc.
CreateTextSelect
Creates a text selection from the specified rectangle on the specified page.
CreateThumbs
Creates thumbnail images for the specified page range in a document.
CropPages
Crops the pages in a specified range in a document.
DeletePages
Deletes pages from a file.
DeleteThumbs
Deletes thumbnail images from the specified pages in a document.
GetFileName
Gets the name of the file associated with this AcroExch.PDDoc.
GetFlags
Gets a document’s flags.
GetInfo
Gets the value of a specified key in the document’s Info dictionary.
GetInstanceID
Gets the instance ID (the second element) from the ID array in the
document’s trailer.
GetJSObject
Gets a dual interface to the JavaScript object associated with the PDDoc.
GetNumPages
Gets the number of pages in a file.
GetPageMode
Gets a value indicating whether the Acrobat application is currently
displaying only pages, pages and thumbnails, or pages and bookmarks.
GetPermanentID
Gets the permanent ID (the first element) from the ID array in the
document’s trailer.
InsertPages
Inserts the specified pages from the source document after the indicated
page within the current document.
MovePage
Moves a page to another location within the same document.
Open
Opens a file.
OpenAVDoc
Opens a window and displays the document in it.
ReplacePages
Replaces the indicated pages in the current document with those specified
from the source document.
Save
Saves a document.
SetFlags
Sets a document’s flags indicating whether the document has been
modified, whether the document is a temporary document and should be
deleted when closed, and the version of PDF used in the file.
SetInfo
Sets the value of a key in a document’s Info dictionary.
SetPageMode
Sets the page mode in which a document is to be opened: display only
pages, pages and thumbnails, or pages and bookmarks.
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
AcquirePage
71
AcquirePage
Acquires the specified page.
Syntax
LPDISPATCH AcquirePage(long nPage);
Parameters
nPage
The number of the page to acquire. The first page is page 0.
Returns
The LPDISPATCH for the AcroExch.PDPage object for the acquired page. Returns NULL if the page
could not be acquired.
Related methods
AVPageView.GetPage
AVPageView.GetPageNum
PDDoc.GetNumPages
PDPage.GetDoc
PDPage.GetNumber
PDPage.GetRotate
PDPage.GetSize
PDTextSelect.GetPage
ClearFlags
Clears a document’s flags. The flags indicate whether the document has been modified, whether the
document is a temporary document and should be deleted when closed, and the version of PDF used in
the file. This method can be used only to clear, not to set, the flag bits.
Syntax
VARIANT_BOOL ClearFlags(long nFlags);
Parameters
nFlags
Flags to be cleared. See PDDoc.GetFlags for a description of the flags. The flags
PDDocWasRepaired, PDDocNewMajorVersion, PDDocNewMinorVersion, and
PDDocOldVersion are read-only and cannot be cleared.
Adobe Acrobat SDK
Interapplication Communication API Reference
OLE Automation
Close
Returns
Always returns -1.
Related methods
PDDoc.GetFlags
PDDoc.SetFlags
Close
Closes a file.
Note: If PDDoc and AVDoc are constructed with the same file, PDDoc.Close destroys both objects
(which closes the document in the viewer).
Syntax
VARIANT_BOOL Close();
Returns
-1 if the document was closed successfully, 0 otherwise.
Related methods
App.CloseAllDocs
AVDoc.Close
AVDoc.Open
AVDoc.OpenInWindow
AVDoc.OpenInWindowEx
PDDoc.Open
PDDoc.OpenAVDoc
Create
Creates a new AcroExch.PDDoc.
Syntax
VARIANT_BOOL Create();
72
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
CreateTextSelect
73
Returns
-1 if the document is created successfully, 0 if it is not or if the Acrobat application does not support
editing.
CreateTextSelect
Creates a text selection from the specified rectangle on the specified page. After creating the text
selection, use the AVDoc.SetTextSelection method to use it as the document’s selection, and use
AVDoc.ShowTextSelect to show the selection.
Syntax
LPDISPATCH CreateTextSelect(long nPage, LPDISPATCH iAcroRect);
Parameters
nPage
The page on which the selection is created. The first page in a PDDoc object is
page 0.
iAcroRect
The LPDISPATCH for the AcroExch.Rect enclosing the region to select.
iAcroRect contains the instance variable m_lpDispatch, which contains the
LPDISPATCH.
Returns
The LPDISPATCH for an AcroExch.PDTextSelect containing the text selection. Returns NULL if the
text selection was not created successfully.
Related methods
AVDoc.ClearSelection
AVDoc.SetTextSelection
AVDoc.ShowTextSelect
PDPage.CreatePageHilite
PDPage.CreateWordHilite
PDTextSelect.Destroy
PDTextSelect.GetBoundingRect
PDTextSelect.GetNumText
PDTextSelect.GetPage
PDTextSelect.GetText
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
CreateThumbs
74
CreateThumbs
Creates thumbnail images for the specified page range in a document.
Syntax
VARIANT_BOOL CreateThumbs(long nFirstPage, long nLastPage);
Parameters
nFirstPage
First page for which thumbnail images are created. The first page in a PDDoc
object is page 0.
nLastPage
Last page for which thumbnail images are created.
Returns
-1 if thumbnail images were created successfully, 0 if they were not or if the Acrobat application does not
support editing.
Related methods
PDDoc.DeleteThumbs
CropPages
Crops the pages in a specified range in a document. This method ignores the request if either the width or
height of the crop box is less than 72 points (one inch).
Syntax
VARIANT_BOOL CropPages(long nStartPage, long nEndPage,
short nEvenOrOddPagesOnly,
LPDISPATCH iAcroRect);
Parameters
nStartPage
First page that is cropped. The first page in a PDDoc object is page 0.
nEndPage
Last page that is cropped.
nEvenOrOddPagesOnly
Value indicating which pages in the range are cropped. Must be one of the
following:
0 — crop all pages in the range
1 — crop only odd pages in the range
2 — crop only even pages in the range
iAcroRect
An LPDISPATCH for a CAcroRect specifying the cropping rectangle,
which is specified in user space.
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
DeletePages
75
Returns
-1 if the pages were cropped successfully, 0 otherwise.
Related methods
PDPage.CropPages
DeletePages
Deletes pages from a file.
Syntax
VARIANT_BOOL DeletePages(long nStartPage, long nEndPage);
Parameters
nStartPage
The first page to be deleted. The first page in a PDDoc object is page 0.
nEndPage
The last page to be deleted.
Returns
-1 if the pages were successfully deleted. Returns 0 if they were not or if the Acrobat application does not
support editing.
Related methods
PDDoc.AcquirePage
PDDoc.DeletePages
PDDoc.GetNumPages
PDDoc.InsertPages
PDDoc.MovePage
PDDoc.ReplacePages
DeleteThumbs
Deletes thumbnail images from the specified pages in a document.
Syntax
VARIANT_BOOL DeleteThumbs(long nStartPage, long nEndPage);
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
GetFileName
76
Parameters
nStartPage
First page whose thumbnail image is deleted. The first page in a PDDoc object is
page 0.
nEndPage
Last page whose thumbnail image is deleted.
Returns
-1 if the thumbnails were deleted, 0 if they were not deleted or if the Acrobat application does not
support editing.
Related methods
PDDoc.CreateThumbs
GetFileName
Gets the name of the file associated with this AcroExch.PDDoc.
Syntax
BSTR GetFileName();
Returns
The file name, which can currently contain up to 256 characters.
Related methods
PDDoc.Save
GetFlags
Gets a document’s flags. The flags indicate whether the document has been modified, whether the
document is a temporary document and should be deleted when closed, and the version of PDF used in
the file.
Syntax
long GetFlags();
Returns
The document’s flags, containing an OR of the following:
Flag
Description
PDDocNeedsSave
Document has been modified and needs to be saved.
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
GetInfo
PDDocRequiresFullSave
Document cannot be saved incrementally; it must be written using
PDSaveFull.
PDDocIsModified
Document has been modified slightly (such as bookmarks or text
annotations have been opened or closed), but not in a way that
warrants saving.
PDDocDeleteOnClose
Document is based on a temporary file that must be deleted when
the document is closed or saved.
PDDocWasRepaired
Document was repaired when it was opened.
PDDocNewMajorVersion
Document’s major version is newer than current.
PDDocNewMinorVersion
Document’s minor version is newer than current.
PDDocOldVersion
Document’s version is older than current.
PDDocSuppressErrors
Don’t display errors.
77
Related methods
PDDoc.ClearFlags
PDDoc.SetFlags
GetInfo
Gets the value of a specified key in the document’s Info dictionary. A maximum of 512 bytes are returned.
Syntax
BSTR GetInfo(BSTR szInfoKey);
Parameters
szInfoKey
The key whose value is obtained.
Returns
The string if the value was read successfully. Returns an empty string if the key does not exist or its value
cannot be read.
Related methods
PDDoc.SetInfo
GetInstanceID
Gets the instance ID (the second element) from the ID array in the document’s trailer.
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
GetJSObject
Syntax
BSTR GetInstanceID();
Returns
A string whose maximum length is 32 characters, containing the document’s instance ID.
Related methods
PDDoc.GetPermanentID
GetJSObject
Gets a dual interface to the JavaScript object associated with the PDDoc. This allows automation clients
full access to both built-in and user-defined JavaScript methods available in the document. For more
information on working with JavaScript, see Developing Applications Using Interapplication
Communication.
Syntax
LDispatch* GetJSObject();
Returns
The interface to the JavaScript object if the call succeeded, NULL otherwise.
GetNumPages
Gets the number of pages in a file.
Syntax
long GetNumPages();
Returns
The number of pages, or -1 if the number of pages cannot be determined.
Related methods
AVPageView.GetPage
AVPageView.GetPageNum
PDDoc.AcquirePage
PDPage.GetNumber
PDTextSelect.GetPage
78
Adobe Acrobat SDK
Interapplication Communication API Reference
OLE Automation
GetPageMode
GetPageMode
Gets a value indicating whether the Acrobat application is currently displaying only pages, pages and
thumbnails, or pages and bookmarks.
Syntax
long GetPageMode();
Returns
The current page mode. Will be one of the following values:
PDDontCare: 0 — leave the view mode as it is
PDUseNone: 1 — display without bookmarks or thumbnails
PDUseThumbs: 2 — display using thumbnails
PDUseBookmarks: 3 — display using bookmarks
PDFullScreen: 4 — display in full screen mode
Related methods
PDDoc.SetPageMode
GetPermanentID
Gets the permanent ID (the first element) from the ID array in the document’s trailer.
Syntax
BSTR GetPermanentID();
Returns
A string whose maximum length is 32 characters, containing the document’s permanent ID.
Related methods
PDDoc.GetInstanceID
InsertPages
Inserts the specified pages from the source document after the indicated page within the current
document.
Syntax
VARIANT_BOOL InsertPages(long nInsertPageAfter,
LPDISPATCH iPDDocSource,long nStartPage,
long nNumPages, long bBookmarks);
79
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
MovePage
80
Parameters
nInsertPageAfter
The page in the current document after which pages from the source
document are inserted. The first page in a PDDoc object is page 0.
iPDDocSource
The LPDISPATCH for the AcroExch.PDDoc containing the pages to
insert. iPDDocSource contains the instance variable m_lpDispatch,
which contains the LPDISPATCH.
nStartPage
The first page in iPDDocSource to be inserted into the current document.
nNumPages
The number of pages to be inserted.
bBookmarks
If a positive number, bookmarks are copied from the source document. If 0,
they are not.
Returns
-1 if the pages were successfully inserted. Returns 0 if they were not or if the Acrobat application does not
support editing.
Related methods
PDDoc.AcquirePage
PDDoc.DeletePages
PDDoc.GetNumPages
PDDoc.MovePage
PDDoc.ReplacePages
MovePage
Moves a page to another location within the same document.
Syntax
VARIANT_BOOL MovePage(long nMoveAfterThisPage,
long nPageToMove);
Parameters
nMoveAfterThisPage
The page being moved is placed after this page number. The first page in a
PDDoc object is page 0.
nPageToMove
Page number of the page to be moved.
Returns
0 if the Acrobat application does not support editing, -1 otherwise.
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
Related methods
PDDoc.AcquirePage
PDDoc.DeletePages
PDDoc.GetNumPages
PDDoc.InsertPages
PDDoc.ReplacePages
Open
Opens a file. A new instance of AcroExch.PDDoc must be created for each open PDF file.
Syntax
VARIANT_BOOL Open(BSTR szFullPath);
Parameters
szFullPath
Full path of the file to be opened.
Returns
-1 if the document was opened successfully, 0 otherwise.
Related methods
App.CloseAllDocs
AVDoc.Close
AVDoc.Open
AVDoc.OpenInWindow
AVDoc.OpenInWindowEx
PDDoc.Close
PDDoc.OpenAVDoc
OpenAVDoc
Opens a window and displays the document in it.
Syntax
LPDISPATCH OpenAVDoc(BSTR szTitle);
Open
81
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
ReplacePages
82
Parameters
szTitle
The title to be used for the window. A default title is used if szTitle is NULL or
an empty string.
Returns
The LPDISPATCH for the AcroExch.AVDoc that was opened, or NULL if the open fails.
Related methods
App.CloseAllDocs
AVDoc.Close
AVDoc.GetTitle
AVDoc.Open
AVDoc.OpenInWindow
AVDoc.OpenInWindowEx
AVDoc.SetTitle
PDDoc.Close
PDDoc.Open
ReplacePages
Replaces the indicated pages in the current document with those specified from the source document. No
links or bookmarks are copied from iPDDocSource, but text annotations may optionally be copied.
Syntax
VARIANT_BOOL ReplacePages(long nStartPage,
LPDISPATCH iPDDocSource,
long nStartSourcePage, long nNumPages,
long bMergeTextAnnotations);
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
Save
83
Parameters
nStartPage
The first page within the source file to be replaced. The first page in a
PDDoc object is page 0.
iPDDocSource
The LPDISPATCH for the AcroExch.PDDoc containing the new
copies of pages that are replaced. iPDDocSource contains the
instance variable m_lpDispatch, which contains the
LPDISPATCH.
nStartSourcePage
The first page in iPDDocSource to use as a replacement page.
nNumPages
The number of pages to be replaced.
bMergeTextAnnotations
If a positive number, text annotations from iPDDocSource are
copied. If 0, they are not.
Returns
-1 if the pages were successfully replaced. Returns 0 if they were not or if the Acrobat application does not
support editing.
Related methods
PDDoc.AcquirePage
PDDoc.DeletePages
PDDoc.GetNumPages
PDDoc.InsertPages
PDDoc.MovePage
Save
Saves a document.
Syntax
VARIANT_BOOL Save(short nType, BSTR szFullPath);
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
SetFlags
84
Parameters
nType
Specifies the way in which the file should be saved.
nType is a logical OR of one or more of the following flags:
PDSaveIncremental — Write changes only, not the complete file. This
will always result in a larger file, even if objects have been deleted.
PDSaveFull — Write the entire file to the filename specified by
szFullPath.
PDSaveCopy — Write a copy of the file into the file specified by
szFullPath, but keep using the old file. This flag can only be specified if
PDSaveFull is also used.
PDSaveCollectGarbage — Remove unreferenced objects; this often
reduces the file size, and its usage is encouraged. This flag can only be
specified if PDSaveFull is also used.
PDSaveLinearized — Save the file optimized for the web, providing hint
tables. This allows the PDF file to be byte-served. This flag can only be
specified if PDSaveFull is also used.
Note: If you save a file optimized for the web using the PDSaveLinearized
flag, you must follow this sequence:
1. Open the PDF file with PDDoc.Open.
2. Call PDDoc.Save using the PDSaveLinearized flag.
3. Call PDDoc.Close.
This allows batch optimization of files.
szFullPath
The new path to the file, if any.
Returns
-1 if the document was successfully saved. Returns 0 if it was not or if the Acrobat application does not
support editing.
Related methods
PDDoc.GetFileName
SetFlags
Sets a document’s flags indicating whether the document has been modified, whether the document is a
temporary document and should be deleted when closed, and the version of PDF used in the file. This
method can be used only to set, not to clear, the flag bits.
Syntax
VARIANT_BOOL SetFlags(long nFlags);
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
SetInfo
85
Parameters
nFlags
Flags to be set. See PDDoc.GetFlags for a description of the flags. The flags
PDDocWasRepaired, PDDocNewMajorVersion, PDDocNewMinorVersion,
and PDDocOldVersion are read-only and cannot be set.
Returns
Always returns -1.
Related methods
PDDoc.ClearFlags
PDDoc.GetFlags
SetInfo
Sets the value of a key in a document’s Info dictionary.
Syntax
VARIANT_BOOL SetInfo(BSTR szInfoKey, BSTR szBuffer);
Parameters
szInfoKey
The key whose value is set.
szBuffer
The value to be assigned to the key.
Returns
-1 if the value was added successfully, 0 if it was not or if the Acrobat application does not support
editing.
Related methods
PDDoc.GetInfo
SetPageMode
Sets the page mode in which a document is to be opened: display only pages, pages and thumbnails, or
pages and bookmarks.
Syntax
VARIANT_BOOL SetPageMode(long nPageMode);
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
AcroExch.PDPage
86
Parameters
nPageMode
The page mode to be set. Possible values:
PDDontCare: 0 — leave the view mode as it is
PDUseNone: 1 — display without bookmarks or thumbnails
PDUseThumbs: 2 — display using thumbnails
PDUseBookmarks: 3 — display using bookmarks
Returns
Always returns -1.
Related methods
PDDoc.GetPageMode
PDDoc.SetPageMode
AcroExch.PDPage
A single page in the PDF representation of a document. This is a non-creatable interface. Just as PDF files
are partially composed of their pages, PDDoc objects are composed of PDPage objects. A page contains a
series of objects representing the objects drawn on the page (PDGraphic objects), a list of resources used
in drawing the page, annotations (PDAnnot objects), an optional thumbnail image of the page, and the
threads used in any articles that occur on the page. The first page in a PDDoc object is page 0.
Methods
The PDPage object has the following methods.
Method
Description
AddAnnot
Adds a specified annotation at a specified location in the page’s annotation
array
AddNewAnnot
Creates a new text annotation and adds it to the page.
CopyToClipboard
Copies a PDF image to the clipboard without requiring an hWnd or hDC
from the client.
CreatePageHilite
Creates a text selection from a list of character offsets and character counts
on a single page.
CreateWordHilite
Creates a text selection from a list of word offsets and word counts on a
single page.
CropPage
Crops the page.
Draw
Deprecated. Draws page contents into a specified window.
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
AddAnnot
87
Method
Description
DrawEx
Draws page contents into a specified window.
GetAnnot
Gets the specified annotation from the page’s array of annotations.
GetAnnotIndex
Gets the index (within the page’s annotation array) of the specified
annotation.
GetDoc
Gets the AcroExch.PDDoc associated with the page.
GetNumAnnots
Gets the number of annotations on the page.
GetNumber
Gets the page number of the current page. The first page in a document is
page zero.
GetRotate
Gets the rotation value, in degrees, for the current page.
GetSize
Gets a page’s width and height in points.
RemoveAnnot
Removes the specified annotation from the page’s annotation array.
SetRotate
Sets the rotation, in degrees, for the current page.
AddAnnot
Adds a specified annotation at a specified location in the page’s annotation array.
Syntax
VARIANT_BOOL AddAnnot(long nIndexAddAfter,
LPDISPATCH iPDAnnot);
Parameters
nIndexAddAfter
Location in the page’s annotation array to add the annotation. The first
annotation on a page has an index of zero.
iPDAnnot
The LPDISPATCH for the AcroExch.PDAnnot to add. iPDAnnot contains the
instance variable m_lpDispatch, which contains the LPDISPATCH.
Returns
0 if the Acrobat application does not support editing, -1 otherwise.
Related methods
PDPage.AddNewAnnot
PDPage.RemoveAnnot
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
AddNewAnnot
88
AddNewAnnot
Creates a new text annotation and adds it to the page.
The newly-created text annotation is not complete until PDAnnot.SetContents has been called to fill in
the /Contents key.
Syntax
LPDISPATCH AddNewAnnot(long nIndexAddAfter, BSTR szSubType,
LPDISPATCH iAcroRect);
Parameters
nIndexAddAfter
Location in the page’s annotation array after which to add the annotation. The
first annotation on a page has an index of zero.
szSubType
Subtype of the annotation to be created. Must be text.
iAcroRect
The LPDISPATCH for the AcroExch.Rect bounding the annotation’s location
on the page. iAcroRect contains the instance variable m_lpDispatch, which
contains the LPDISPATCH.
Returns
The LPDISPATCH for an AcroExch.PDAnnot object, or NULL if the annotation could not be added.
Related methods
PDAnnot.SetContents
PDPage.AddAnnot
PDPage.RemoveAnnot
CopyToClipboard
Copies a PDF image to the clipboard without requiring an hWnd or hDC from the client. This method is only
available on 32-bit systems.
Syntax
VARIANT_BOOL CopyToClipboard(LPDISPATCH boundRect,
short nXOrigin,short nYOrigin,
short nZoom);
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
CreatePageHilite
89
Parameters
boundRect
The LPDISPATCH for the AcroExch.Rect bounding rectangle in device space
coordinates. boundRect contains the instance variable m_lpDispatch, which
contains the LPDISPATCH.
nXOrigin
The x–coordinate of the portion of the page to be copied.
nYOrigin
The y–coordinate of the portion of the page to be copied.
nZoom
Zoom factor at which the page is copied, specified as a percent. For example,
100 corresponds to a magnification of 1.0.
Returns
-1 if the page is successfully copied, 0 otherwise.
Related methods
PDPage.DrawEx
CreatePageHilite
Creates a text selection from a list of character offsets and character counts on a single page. The text
selection can then be set as the current selection using AVDoc.SetTextSelection, and the view can
be set to show the selection using AVDoc.ShowTextSelect.
Syntax
LPDISPATCH CreatePageHilite(LPDISPATCH iAcroHiliteList);
Parameters
iAcroHiliteList
The LPDISPATCH for the highlight list for which a text selection is created.
iAcroHiliteList contains the instance variable m_lpDispatch, which
contains the LPDISPATCH.
Use HiliteList.Add to create a highlight list.
Returns
The LPDISPATCH for the AcroExch.PDTextSelect containing the text selection, or NULL if the
selection could not be created.
Related methods
AVDoc.ClearSelection
AVDoc.SetTextSelection
AVDoc.ShowTextSelect
HiliteList.Add
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
CreateWordHilite
90
PDDoc.CreateTextSelect
PDPage.CreateWordHilite
PDTextSelect.Destroy
PDTextSelect.GetBoundingRect
PDTextSelect.GetNumText
PDTextSelect.GetPage
PDTextSelect.GetText
CreateWordHilite
Creates a text selection from a list of word offsets and word counts on a single page. The text selection can
then be set as the current selection using AVDoc.SetTextSelection, and the view can be set to show
the selection using AVDoc.ShowTextSelect.
Syntax
LPDISPATCH CreateWordHilite(LPDISPATCH iAcroHiliteList);
Parameters
iAcroHiliteList
The LPDISPATCH for the highlight list for which a text selection is created.
iAcroHiliteList contains the instance variable m_lpDispatch, which
contains the LPDISPATCH.
Use HiliteList.Add to create a highlight list.
Returns
The LPDISPATCH for the AcroExch.PDTextSelect, or NULL if the selection could not be created.
Related methods
AVDoc.ClearSelection
AVDoc.SetTextSelection
AVDoc.ShowTextSelect
HiliteList.Add
PDDoc.CreateTextSelect
PDPage.CreatePageHilite
PDTextSelect.Destroy
PDTextSelect.GetBoundingRect
PDTextSelect.GetNumText
PDTextSelect.GetPage
PDTextSelect.GetText
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
CropPage
91
CropPage
Crops the page. This method ignores the request if either the width or height of the crop box is less than
72 points (one inch).
Syntax
VARIANT_BOOL CropPage(LPDISPATCH iAcroRect);
Parameters
iAcroRect
An LPDISPATCH for a CAcroRect specifying the cropping rectangle, which is
specified in user space.
Returns
-1 if the page was cropped successfully, 0 otherwise.
Related methods
PDDoc.CropPages
Draw
Note: Deprecated. As of Acrobat 3.0, this method simply returns false. Use the method AVDoc.DrawEx
instead.
Syntax
VARIANT_BOOL Draw(short window, short displayContext,
short XOrigin,short YOrigin, short zoom);
Parameters
window
HWND into which the page is to be drawn.
displayContext
hDC to use for drawing. If NULL, the HDC for window is used.
displayContext cannot be reliably used as the hDC for a printer device. In
particular, Visual Basic applications cannot use Draw to print.
XOrigin
The x–coordinate of the portion of the page to be drawn.
YOrigin
The y–coordinate of the portion of the page to be drawn.
zoom
Zoom factor at which the page is to be drawn, specified as a percent. For
example, 100 corresponds to a magnification of 1.0.
Returns
-1 if the page is successfully drawn, 0 otherwise.
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
DrawEx
92
Related methods
PDPage.CopyToClipboard
PDPage.DrawEx
DrawEx
Draws page contents into a specified window.
You can use PDPage.CopyToClipboard to copy page contents to the clipboard without an hWnd or
hDC from the client.
Syntax
VARIANT_BOOL DrawEx(long window, long displayContext,
LPDISPATCH updateRect, short xOrigin,
short yOrigin, short zoom);
Parameters
window
Handle for the window (HWND) into which the page is drawn.
displayContext
This parameter is invalid; do not use it. Assign it a NULL value. If it is not assigned
NULL, an exception is thrown.
Note: displayContext cannot be reliably used as the hDC for a printer
device. In particular, Visual Basic applications cannot use DrawEx to
print.
updateRect
LPDISPATCH for an AcroExch.Rect to be drawn with user space coordinates.
updateRect contains the instance variable m_lpDispatch, which contains
the LPDISPATCH.
Any objects outside of updateRect are not drawn. All objects are drawn if
updateRect is NULL.
Use methods in the CAcroRect class to set the size of the rectangle. For
example:
CAcroRect* rect = new CAcroRect;
rect->CreateDispatch("AcroExch.Rect", &e);
if (rect) {
/* Set values for rect - increases from right to left and
bottom to top */
rect->SetLeft(100);
rect->SetTop(400);
rect->SetRight(400);
rect->SetBottom(100);
}
xOrigin
The x–coordinate of the portion of the page to be drawn.
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
GetAnnot
yOrigin
The y–coordinate of the portion of the page to be drawn.
zoom
Zoom factor at which the page is drawn, specified as a percent. For example,
100 corresponds to a magnification of 1.0.
Returns
A positive number if the page is successfully drawn, 0 otherwise.
Related methods
PDPage.CopyToClipboard
GetAnnot
Gets the specified annotation from the page’s array of annotations.
Syntax
LPDISPATCH GetAnnot(long nIndex);
Parameters
nIndex
Index (in the page’s annotation array) of the annotation to be retrieved. The first
annotation in the array has an index of zero.
Returns
The LPDISPATCH for the AcroExch.PDAnnot object.
Related methods
PDPage.GetAnnotIndex
PDPage.GetNumAnnots
GetAnnotIndex
Gets the index (within the page’s annotation array) of the specified annotation.
Syntax
long GetAnnotIndex(LPDISPATCH iPDAnnot);
Parameters
iPDAnnot
LPDISPATCH for the AcroExch.PDAnnot whose index is obtained. iPDAnnot
contains the instance variable m_lpDispatch, which contains the LPDISPATCH.
93
Adobe Acrobat SDK
Interapplication Communication API Reference
OLE Automation
GetDoc
Returns
The annotation’s index.
Related methods
PDPage.GetAnnot
PDPage.GetNumAnnots
GetDoc
Gets the AcroExch.PDDoc associated with the page.
Syntax
LPDISPATCH GetDoc();
Returns
The LPDISPATCH for the page’s AcroExch.PDDoc.
Related methods
AVPageView.GetPage
AVPageView.GetPageNum
PDDoc.AcquirePage
PDDoc.GetNumPages
PDPage.GetNumber
PDPage.GetRotate
PDPage.GetSize
PDTextSelect.GetPage
GetNumAnnots
Gets the number of annotations on the page.
Annotations that have associated pop-up windows, such as a strikeout, count as two annotations. Also
note that widget annotations (Acrobat form fields) are included.
Syntax
long GetNumAnnots();
94
Adobe Acrobat SDK
Interapplication Communication API Reference
Returns
The number of annotations on the page.
Related methods
PDPage.GetAnnot
PDPage.GetAnnotIndex
GetNumber
Gets the page number of the current page. The first page in a document is page zero.
Syntax
long GetNumber();
Returns
The page number of the current page. The first page in a PDDoc object is page 0.
Related methods
AVPageView.GetPage
AVPageView.GetPageNum
PDDoc.AcquirePage
PDDoc.GetNumPages
PDPage.GetDoc
PDPage.GetRotate
PDPage.GetSize
PDTextSelect.GetPage
GetRotate
Gets the rotation value, in degrees, for the current page.
Syntax
short GetRotate();
Returns
Rotation value.
OLE Automation
GetNumber
95
Adobe Acrobat SDK
Interapplication Communication API Reference
OLE Automation
GetSize
96
Related methods
AVPageView.GetPage
AVPageView.GetPageNum
PDDoc.AcquirePage
PDPage.GetNumber
PDPage.GetSize
PDPage.SetRotate
PDTextSelect.GetPage
GetSize
Gets a page’s width and height in points.
Syntax
LPDISPATCH GetSize();
Returns
The LPDISPATCH for an AcroExch.Point containing the width and height, measured in points. Point x
contains the width, point y the height.
Related methods
AVPageView.GetPage
AVPageView.GetPageNum
PDDoc.AcquirePage
PDPage.GetNumber
PDPage.GetRotate
PDTextSelect.GetPage
RemoveAnnot
Removes the specified annotation from the page’s annotation array.
Syntax
VARIANT_BOOL RemoveAnnot(long nIndex);
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
SetRotate
Parameters
nIndex
Index within the page’s annotation array of the annotation to be deleted. The first
annotation on a page has an index of zero.
Returns
0 if the Acrobat application does not support editing, a positive number otherwise.
Related methods
PDPage.AddAnnot
PDPage.AddNewAnnot
PDPage.GetAnnotIndex
SetRotate
Sets the rotation, in degrees, for the current page.
Syntax
VARIANT_BOOL SetRotate(short nRotate);
Parameters
nRotate
Rotation value of 0, 90, 180, or 270.
Returns
0 if the Acrobat application does not support editing, -1 otherwise.
Related methods
PDPage.GetRotate
97
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
AcroExch.PDTextSelect
AcroExch.PDTextSelect
A selection of text on a single page that may contain more than one disjointed group of words. This is a
non-creatable interface. A text selection is specified by one or more ranges of text, with each range
containing the word numbers of the selected words. Each range specifies a start and end word, where
“start” is the number of the first word of a series of selected words and “end” is the number of the next
word after the last word in the selection.
Methods
The PDTextSelect object has the following methods.
Method
Description
Destroy
Destroys a text selection object.
GetBoundingRect
Gets a text selection’s bounding rectangle.
GetNumText
Gets the number of text elements in a text selection.
GetPage
Gets the page number on which the text selection is located.
GetText
Gets the text from the specified element of a text selection.
Destroy
Destroys a text selection object.
Syntax
VARIANT_BOOL Destroy();
Returns
Always returns -1.
Related methods
AVDoc.ClearSelection
AVDoc.SetTextSelection
AVDoc.ShowTextSelect
PDDoc.CreateTextSelect
PDPage.CreatePageHilite
PDPage.CreateWordHilite
PDTextSelect.GetBoundingRect
PDTextSelect.GetNumText
98
Adobe Acrobat SDK
Interapplication Communication API Reference
OLE Automation
GetBoundingRect
99
PDTextSelect.GetPage
PDTextSelect.GetText
GetBoundingRect
Gets a text selection’s bounding rectangle.
Syntax
LPDISPATCH GetBoundingRect();
Returns
The LPDISPATCH for an AcroExch.Rect corresponding to the text selection’s bounding rectangle.
Related methods
AVDoc.ClearSelection
AVDoc.SetTextSelection
AVDoc.ShowTextSelect
PDDoc.CreateTextSelect
PDPage.CreatePageHilite
PDPage.CreateWordHilite
PDTextSelect.Destroy
PDTextSelect.GetNumText
PDTextSelect.GetPage
PDTextSelect.GetText
GetNumText
Gets the number of text elements in a text selection. Use this method to determine how many times to call
the PDTextSelect.GetText method to obtain all of a text selection’s text.
Note: A text element is not necessarily a word. A text element consists of characters of the same font, size
and style; therefore, there may be more than one text element in a word.
Syntax
long GetNumText();
Returns
The number of elements in the text selection.
Adobe Acrobat SDK
Interapplication Communication API Reference
Related methods
AVDoc.ClearSelection
AVDoc.SetTextSelection
AVDoc.ShowTextSelect
PDDoc.CreateTextSelect
PDPage.CreatePageHilite
PDPage.CreateWordHilite
PDTextSelect.Destroy
PDTextSelect.GetBoundingRect
PDTextSelect.GetPage
PDTextSelect.GetText
GetPage
Gets the page number on which the text selection is located.
Syntax
long GetPage();
Returns
The text selection’s page number. The first page in a PDDoc object is page 0.
Related methods
AVDoc.ClearSelection
AVDoc.SetTextSelection
AVDoc.ShowTextSelect
AVPageView.GetPage
AVPageView.GetPageNum
PDDoc.CreateTextSelect
PDDoc.GetNumPages
PDPage.CreatePageHilite
PDPage.CreateWordHilite
PDPage.GetNumber
OLE Automation
GetPage
100
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
GetText
101
PDTextSelect.Destroy
PDTextSelect.GetBoundingRect
PDTextSelect.GetNumText
PDTextSelect.GetText
GetText
Gets the text from the specified element of a text selection. To obtain all the text within the text selection,
use PDTextSelect.GetNumText to determine the number of elements in the text selection, then call
this method in a loop to obtain each of the elements.
Syntax
BSTR GetText(long nTextIndex);
Parameters
nTextIndex
The element of the text selection to get.
Returns
The text, or an empty string if nTextIndex is greater than the number of elements in the text selection.
Related methods
AVDoc.ClearSelection
AVDoc.SetTextSelection
AVDoc.ShowTextSelect
PDPage.CreatePageHilite
PDDoc.CreateTextSelect
PDPage.CreateWordHilite
PDTextSelect.Destroy
PDTextSelect.GetBoundingRect
PDTextSelect.GetNumText
PDTextSelect.GetPage
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
AcroExch.Point
AcroExch.Point
Defines the location of an AcroPoint.
Properties
The Point object has the following properties.
Property
Description
X
Gets or sets the x-coordinate of an AcroPoint.
Y
Gets or sets the y-coordinate of an AcroPoint.
X
Gets or sets the x-coordinate of an AcroPoint.
Syntax
[get/set] Short
Return
The x-coordinate of the AcroPoint.
Y
Gets or sets the y-coordinate of an AcroPoint.
Syntax
[get/set] Short
Returns
The y-coordinate of the AcroPoint.
AcroExch.Rect
Defines the location of an AcroRect.
The Rect object has the following properties.
102
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
Bottom
Properties
Property
Description
Bottom
Gets or sets the bottom y-coordinate of an AcroRect.
Left
Gets or sets the left x-coordinate of an AcroRect.
Right
Gets or sets the right x-coordinate of an AcroRect.
Top
Gets or sets the top y-coordinate of an AcroRect.
Bottom
Gets or sets the bottom y-coordinate of an AcroRect.
Syntax
[get/set] Short
Returns
The y-coordinate of the bottom of the AcroRect.
Left
Gets or sets left x-coordinate of an AcroRect.
Syntax
[get/set] Short
Returns
The x-coordinate of the left side of the AcroRect.
Right
Gets or sets the right x-coordinate of an AcroRect.
Syntax
[get/set] Short
Returns
The x-coordinate of the right side of the AcroRect.
103
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
Top
Top
Gets or sets the top y-coordinate of an AcroRect.
Syntax
[get/set] Short
Returns
The y-coordinate of the top of the AcroRect.
AcroExch.Time
Defines a specified time, accurate to the millisecond.
Properties
The Time object has the following properties.
Property
Description
Date
Gets or sets the date from an AcroTime.
Hour
Gets or sets the hour from an AcroTime.
Millisecond
Gets or sets the milliseconds from an AcroTime.
Minute
Gets or sets the minutes from an AcroTime.
Month
Gets or sets the month from an AcroTime.
Second
Gets or sets the seconds from an AcroTime.
Year
Gets or sets the year from an AcroTime.
Date
Gets or sets the date from an AcroTime.
Syntax
[get/set] Short
Returns
The date from the AcroTime. The date runs from 1 to 31.
104
Adobe Acrobat SDK
Interapplication Communication API Reference
OLE Automation
Hour
Hour
Gets or sets the hour from an AcroTime.
Syntax
[get/set] Short
Returns
The hour from the AcroTime. The hour runs from 0 to 23.
Millisecond
Gets or sets the milliseconds from an AcroTime.
Syntax
[get/set] Short
Returns
The milliseconds from the AcroTime. Milliseconds run from 0 to 999.
Minute
Gets or sets the minutes from an AcroTime.
Syntax
[get/set] Short
Returns
The minutes from the AcroTime. Minutes run from 0 to 59.
Month
Gets or sets the month from an AcroTime.
Syntax
[get/set] Short
Returns
The month from the AcroTime. The month runs from 1 to 12, where 1 is January and 12 is December.
105
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
Second
Second
Gets or sets the seconds from an AcroTime.
Syntax
[get/set] Short
Returns
The seconds from the AcroTime. Seconds run from 0 to 59.
Year
Gets or sets the year from an AcroTime.
Syntax
[get/set] Short
Returns
The year from the AcroTime. The Year runs from 1 to 32767.
AxAcroPDFLib.AxAcroPDF
An object containing a set of methods that provide access to PDF browser controls. This is a creatable
interface. This object makes it possible to load a file, move to various pages within the file, and specify
various display and print options.
Methods
The AxAcroPDF object has the following methods.
Method
Description
GetVersions
Deprecated
GoBackwardStack
Goes to the previous view on the view stack, if the previous view exists.
GoForwardStack
Goes to the next view on the view stack, if the next view exists.
GotoFirstPage
Goes to the first page in the document, maintaining the current location
within the page and zoom level.
GotoLastPage
Goes to the last page in the document, maintaining the current location
within the page and zoom level.
GotoNextPage
Goes to the next page in the document, if it exists. Maintains the current
location within the page and zoom level.
106
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
AxAcroPDFLib.AxAcroPDF
107
Method
Description
GotoPreviousPage
Goes to the previous page in the document, if it exists. Maintains the
current location within the page and zoom level.
LoadFile
Opens and displays the specified document within the browser.
Print
Prints the document according to the options selected in a user dialog box.
PrintAll
Prints the entire document without displaying a user dialog box.
PrintAllFit
Prints the entire document without displaying a user dialog box, and the
pages are shrunk, if necessary, to fit into the imageable area of a page in
the printer.
PrintPages
Prints the specified pages without displaying a user dialog box.
PrintPagesFit
Prints the specified pages without displaying a user dialog box.
PrintWithDialog
Prints the document according to the options selected in a user dialog box.
SetCurrentHighlight
Highlights the text selection within the specified bounding rectangle on
the current page.
SetCurrentPage
Goes to the specified page in the document.
SetLayoutMode
Sets the layout mode for a page view according to the specified string.
SetNamedDest
Changes the page view to the named destination in the specified string.
SetPageMode
Sets the page mode according to the specified string.
SetShowScrollbars
Determines whether scrollbars will appear in the document view.
SetShowToolbar
Determines whether a toolbar will appear in the viewer.
SetView
Sets the view of a page according to the specified string.
SetViewRect
Sets the view rectangle according to the specified coordinates.
SetViewScroll
Sets the view of a page according to the specified string.
SetZoom
Sets the magnification according to the specified value.
SetZoomScroll
Sets the magnification according to the specified value, and scrolls the
page view both horizontally and vertically according to the specified
amounts.
Properties
The AxAcroPDF object has the following property.
Property
Description
Src
Gets or sets the URL for the document.
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
GetVersions
108
GetVersions
Note: Deprecated. This method is no longer available.
Syntax
VARIANT GetVersions();
GoBackwardStack
Goes to the previous view on the view stack, if the previous view exists. The previous view may be in a
different document.
Syntax
void GoBackwardStack();
Related methods
AcroPDF.GoForwardStack
GoForwardStack
Goes to the next view on the view stack, if the next view exists. The next view may be in a different
document.
Syntax
void GoForwardStack();
Related methods
AcroPDF.GoBackwardStack
GotoFirstPage
Goes to the first page in the document, maintaining the current location within the page and the current
zoom level.
Syntax
void gotoFirstPage();
Related methods
AcroPDF.GotoLastPage
AcroPDF.GotoNextPage
AcroPDF.GotoPreviousPage
AcroPDF.SetCurrentPage
Adobe Acrobat SDK
Interapplication Communication API Reference
OLE Automation
GotoLastPage
109
GotoLastPage
Goes to the last page in the document, maintaining the current location within the page and the current
zoom level.
Syntax
void gotoLastPage();
Related methods
AcroPDF.GotoFirstPage
AcroPDF.GotoNextPage
AcroPDF.GotoPreviousPage
AcroPDF.SetCurrentPage
GotoNextPage
Goes to the next page in the document, if it exists. Maintains the current location within the page and the
current zoom level.
Syntax
void gotoNextPage();
Related methods
AcroPDF.GotoFirstPage
AcroPDF.GotoLastPage
AcroPDF.GotoPreviousPage
AcroPDF.SetCurrentPage
GotoPreviousPage
Goes to the previous page in the document, if it exists. Maintains the current location within the page and
the current zoom level.
Syntax
void gotoPreviousPage();
Related methods
AcroPDF.GotoFirstPage
AcroPDF.GotoLastPage
AcroPDF.GotoNextPage
AcroPDF.SetCurrentPage
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
LoadFile
110
LoadFile
Opens and displays the specified document within the browser.
Syntax
VARIANT_BOOL LoadFile(BSTR fileName);
Parameters
fileName
The path of the file to be opened.
Returns
0 if the file could not be opened, -1 otherwise.
Print
Prints the document according to the options selected in a user dialog box. The options include
embedded printing (printing within a bounding rectangle on a given page), as well as interactive printing
to a specified printer. This method returns immediately, even if the printing has not completed.
Note: If security settings do not allow printing, this method is ignored.
Syntax
void Print();
Related methods
AcroPDF.PrintAll
AcroPDF.PrintAllFit
AcroPDF.PrintPages
AcroPDF.PrintPagesFit
AcroPDF.PrintWithDialog
PrintAll
Prints the entire document without displaying a user dialog box. The current printer, page settings, and
job settings are used. This method returns immediately, even if the printing has not completed.
Note: If security settings do not allow printing, this method is ignored.
Syntax
void printAll();
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
PrintAllFit
111
Related methods
AcroPDF.Print
AcroPDF.PrintAllFit
AcroPDF.PrintPages
AcroPDF.PrintPagesFit
AcroPDF.PrintWithDialog
PrintAllFit
Prints the entire document without displaying a user dialog box, and the pages are shrunk, if necessary, to
fit into the imageable area of a page in the printer. The current printer, page settings, and job settings are
used. This method returns immediately, even if the printing has not completed.
Note: If security settings do not allow printing, this method is ignored.
Syntax
void printAllFit(VARIANT_BOOL bOn);
Parameters
bOn
Determines whether to scale the imageable area when printing the document. A value of 0
indicates that no scaling should be used, and a positive value indicates that the pages are
shrunk, if necessary, to fit into the imageable area of a page in the printer.
Related methods
AcroPDF.Print
AcroPDF.PrintAll
AcroPDF.PrintPages
AcroPDF.PrintPagesFit
AcroPDF.PrintWithDialog
PrintPages
Prints the specified pages without displaying a user dialog box. The current printer, page settings, and job
settings are used.This method returns immediately, even if the printing has not completed.
Note: If security settings do not allow printing, this method is ignored.
Syntax
void printPages( Long nFrom, Long nTo);
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
PrintPagesFit
112
Parameters
nFrom
The page number of the first page to be printed. The first page in a document is page 0.
nTo
The page number of the last page to be printed.
Related methods
AcroPDF.Print
AcroPDF.PrintAll
AcroPDF.PrintAllFit
AcroPDF.PrintPagesFit
AcroPDF.PrintWithDialog
PrintPagesFit
Prints the specified pages without displaying a user dialog box. The current printer, page settings, and job
settings are used. A parameter specifies whether to shrink pages, if necessary. This method returns
immediately, even if the printing has not completed.
Note: If security settings do not allow printing, this method is ignored.
Syntax
void printPagesFit( Long nFrom, Long nTo,
VARIANT_BOOL bShrinkToFit);
Parameters
nFrom
The page number of the first page to be printed. The first page in a document is
page 0.
nTo
The page number of the last page to be printed.
bShrinkToFit
Specifies whether the pages will be shrunk, if necessary, to fit into the
imageable area of a page in the printer.
Related methods
AcroPDF.Print
AcroPDF.PrintAll
AcroPDF.PrintAllFit
AcroPDF.PrintPages
AcroPDF.PrintWithDialog
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
PrintWithDialog
113
PrintWithDialog
Prints the document according to the options selected in a user dialog box. The options include
embedded printing (printing within a bounding rectangle on a given page), as well as interactive printing
to a specified printer. This method returns immediately, even if the printing has not completed.
Note: If security settings do not allow printing, this method is ignored.
Syntax
void printWithDialog();
Related methods
AcroPDF.Print
AcroPDF.PrintAll
AcroPDF.PrintAllFit
AcroPDF.PrintPages
AcroPDF.PrintPagesFit
SetCurrentHighlight
Highlights the text selection within the specified bounding rectangle on the current page.
Syntax
void setCurrentHighlight(LONG nLeft, LONG nTop,
LONG nRight, LONG nBottom);
Parameters
nLeft
The distance in points from the left side of the page.
nTop
The distance in points from the top of the page.
nRight
The width of the bounding rectangle.
nBottom
The height of the bounding rectangle.
SetCurrentPage
Goes to the specified page in the document. Maintains the current location within the page and the
current zoom level.
Syntax
void setCurrentPage(LONG nPage);
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
SetLayoutMode
114
Parameters
nPage
The page number of the destination page. The first page in a document is page 0.
Related methods
AcroPDF.GotoFirstPage
AcroPDF.GotoLastPage
AcroPDF.GotoNextPage
AcroPDF.GotoPreviousPage
SetLayoutMode
Sets the layout mode for a page view according to the specified string.
Syntax
void setLayoutMode(BSTR szLayoutMode);
Parameters
szLayoutMode
Possible values:
DontCare — use the current user preference
SinglePage — use single page mode (as it would have appeared in
pre-Acrobat 3.0 viewers)
OneColumn — use one-column continuous mode
TwoColumnLeft — use two-column continuous mode with the first page
on the left
TwoColumnRight — use two-column continuous mode with the first page
on the right
Related methods
AcroPDF.SetNamedDest
AcroPDF.SetView
AcroPDF.SetViewRect
AcroPDF.SetViewScroll
SetNamedDest
Changes the page view to the named destination in the specified string.
Syntax
void setNamedDest(BSTR szNamedDest);
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
SetPageMode
Parameters
szNamedDest
The named destination to which the viewer will go.
Related methods
AcroPDF.SetLayoutMode
AcroPDF.SetView
AcroPDF.SetViewRect
AcroPDF.SetViewScroll
SetPageMode
Sets the page mode according to the specified string.
Syntax
void setPageMode(BSTR szPageMode);
Parameters
szPageMode
Possible values:
none — displays the document, but does not display bookmarks or
thumbnails (default)
bookmarks — displays the document and bookmarks
thumbs — displays the document and thumbnails
Related methods
AcroPDF.SetShowScrollbars
AcroPDF.SetShowToolbar
SetShowScrollbars
Determines whether scrollbars will appear in the document view.
Syntax
void setShowScrollbars(VARIANT_BOOL bOn);
Parameters
bOn
A positive value indicates that scrollbars will appear, 0 indicates that they will not.
115
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
SetShowToolbar
116
Related methods
AcroPDF.SetPageMode
AcroPDF.SetShowToolbar
SetShowToolbar
Determines whether a toolbar will appear in the viewer.
Syntax
void setShowToolbar(VARIANT_BOOL bOn);
Parameters
bOn
A positive value indicates that the toolbar will appear, 0 indicates that it will not.
Related methods
AcroPDF.SetPageMode
AcroPDF.SetShowScrollbars
SetView
Sets the view of a page according to the specified string.
Syntax
void setView(BSTR szViewMode);
Parameters
szViewMode
Possible values:
Fit — Fits the entire page within the window both vertically and horizontally.
FitH — Fits the entire width of the page within the window.
FitV — Fits the entire height of the page within the window.
FitB — Fits the bounding box within the window both vertically and
horizontally.
FitBH — Fits the entire width of the bounding box within the window.
FitB — Fits the entire height of the bounding box within the window.
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
SetViewRect
117
Related methods
AcroPDF.SetLayoutMode
AcroPDF.SetNamedDest
AcroPDF.SetViewRect
AcroPDF.SetViewScroll
SetViewRect
Sets the view rectangle according to the specified coordinates.
Syntax
void setViewRect(FLOAT left, FLOAT top,
FLOAT width, FLOAT height);
Parameters
left
The upper left horizontal coordinate.
top
The vertical coordinate in the upper left corner.
width
The horizontal width of the rectangle.
height
The vertical height of the rectangle.
Related methods
AcroPDF.SetLayoutMode
AcroPDF.SetNamedDest
AcroPDF.SetView
AcroPDF.SetViewScroll
SetViewScroll
Sets the view of a page according to the specified string. Depending on the view mode, the page is either
scrolled to the right or scrolled down by the amount specified in offset.
Syntax
void setViewRect(BSTR szViewMode, FLOAT offset);
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
SetZoom
118
Parameters
szViewMode
Possible values:
Fit — Fits the entire page within the window both vertically and horizontally.
FitH — Fits the entire width of the page within the window.
FitV — Fits the entire height of the page within the window.
FitB — Fits the bounding box within the window both vertically and
horizontally.
FitBH — Fits the entire width of the bounding box within the window.
FitBV — Fits the entire height of the bounding box within the window.
offset
The horizontal or vertical coordinate positioned either at the left or top edge.
Related methods
AcroPDF.SetLayoutMode
AcroPDF.SetNamedDest
AcroPDF.SetView
AcroPDF.SetViewRect
SetZoom
Sets the magnification according to the specified value.
Syntax
void setZoom(FLOAT percent);
Parameters
percent
The desired zoom factor, expressed as a percentage. For example, 1.0 represents
a magnification of 100%.
Related methods
AcroPDF.SetZoomScroll
SetZoomScroll
Sets the magnification according to the specified value, and scrolls the page view both horizontally and
vertically according to the specified amounts.
Syntax
void setZoomScroll(FLOAT percent, FLOAT left, FLOAT top);
Adobe Acrobat SDK
OLE Automation
Interapplication Communication API Reference
Src
119
Parameters
percent
The desired zoom factor, expressed as a percentage. For example, 1.0 represents
a magnification of 100%.
left
The horizontal coordinate positioned at the left edge.
top
The vertical coordinate positioned at the top edge.
Related methods
AcroPDF.SetZoom
Src
Gets or sets the URL for the document.
Syntax
[get/set] src
Returns
The URL for the document, formatted as a string.
2
DDE Messages
This chapter lists all DDE messages supported by Acrobat.
These DDE messages handle the display of the Acrobat application:
●
AppExit
●
AppHide
●
AppShow
●
CloseAllDocs
●
HideToolbar
●
MenuitemExecute
●
ShowToolbar
These DDE messages control the display of the document:
●
DocClose
●
DocDeletePages
●
DocInsertPages
●
DocOpen
●
DocReplacePages
●
DocSave
●
DocSaveAs
●
DocSetViewMode
●
FileOpen
●
FileOpenEx
These DDE messages handle printing of a document:
●
DocPrint
●
FilePrint
●
FilePrintEx
●
FilePrintSilent
●
FilePrintSilentEx
●
FilePrintTo
●
FilePrintToEx
These DDE messages control the view of a document.:
●
DocGoTo
●
DocGoToNameDest
●
DocPageDown
●
DocPageLeft
120
Adobe Acrobat SDK
Interapplication Communication API Reference
●
DocPageRight
●
DocPageUp
●
DocScrollTo
●
DocZoomTo
This DDE message is used for searching:
●
DocFind
Adobe Reader supports the following subset of DDE messages:
●
AppExit
●
CloseAllDocs
●
DocClose
●
DocGoTo
●
DocGoToNameDest
●
DocOpen
●
FileOpen
●
FileOpenEx
●
FilePrint
●
FilePrintEx
●
FilePrintSilent
●
FilePrintSilentEx
●
FilePrintTo
●
FilePrintToEx
AppExit
Exits the Acrobat application.
AppExit is also supported in Adobe Reader.
Syntax
[AppExit()]
Returns
true if the Acrobat application exits successfully, false otherwise.
Related methods
AppHide
AppShow
DDE Messages
AppExit
121
Adobe Acrobat SDK
DDE Messages
Interapplication Communication API Reference
AppHide
AppHide
Iconifies or hides the Acrobat application.
Syntax
[AppHide()]
Returns
true if the Acrobat application is hidden successfully, false otherwise.
Related methods
AppExit
AppShow
AppShow
Shows the Acrobat application.
Syntax
[AppShow()]
Returns
true if the Acrobat application is shown successfully, false otherwise.
Related methods
AppExit
AppHide
CloseAllDocs
Closes all open documents.
CloseAllDocs is also supported in Adobe Reader.
Syntax
[CloseAllDocs()]
Returns
true if the documents are closed successfully, false otherwise.
122
Adobe Acrobat SDK
DDE Messages
Interapplication Communication API Reference
DocClose
123
Related methods
DocClose
DocOpen
FileOpen
DocClose
Closes the specified document without saving it, and without prompting the user to save the document if
it has been modified.
DocClose is also supported in Adobe Reader.
Syntax
[DocClose(char* fullPath)]
Parameters
fullPath
The full path of the file to be closed.
Returns
true if the document is closed successfully, false if the document does not exist or is not closed
successfully.
Related methods
CloseAllDocs
DocOpen
FileOpen
DocDeletePages
Deletes the specified pages in the document. Requests to delete all pages in a document are ignored
because a document must have at least one page.
Syntax
[DocDeletePages(char* fullPath, long fromPage, long toPage)]
Adobe Acrobat SDK
DDE Messages
Interapplication Communication API Reference
DocFind
124
Parameters
fullPath
The full path of the document.
fromPage
The page number of the first page to be deleted.
toPage
The page number of the last page to be deleted.
Returns
true if the pages are deleted successfully. Returns false if the document specified by fullPath does
not exist, if the request was to delete all the document’s pages, or if the pages are not deleted successfully.
Related methods
DocInsertPages
DocReplacePages
DocFind
Finds a string in a specified file. This does not use a cross-document search, but instead performs a
page-by-page search of the specified file.
Syntax
[DocFind(char* fullPath, char* string, boolean caseSensitive,
boolean wholeWords, boolean bReset)]
Parameters
fullPath
The full path of the file to be searched.
string
The string to be found.
caseSensitive
true if the search is case-sensitive, false otherwise.
wholeWords
true if the search will only match whole words, false otherwise.
bReset
true if the search begins on the first page of the document, false if the search
begins on the current page.
Returns
false if the document specified by fullPath does not exist or if the text is not found, true otherwise.
Adobe Acrobat SDK
DDE Messages
Interapplication Communication API Reference
DocGoTo
DocGoTo
Goes to the specified page.
DocGoTo is also supported in Adobe Reader.
Syntax
[DocGoTo(char* fullPath, long pageNum)]
Parameters
fullPath
The full path of the file.
pageNum
The page number of the destination page.
Returns
false if the document specified by fullPath does not exist, true otherwise.
DocGoToNameDest
Goes to the specified named destination.
DocGoToNameDest is also supported in Adobe Reader.
Syntax
[DocGoToNameDest(char* fullPath, char* nameDest)]
Parameters
fullPath
The full path of the file.
nameDest
The named destination.
Returns
false if the document specified by fullPath does not exist, true otherwise.
DocInsertPages
Inserts pages from one file into another.
Syntax
[DocInsertPages(char* fullPath, long insertAfterPage, char* sourcePath)]
125
Adobe Acrobat SDK
DDE Messages
Interapplication Communication API Reference
DocOpen
126
Parameters
fullPath
The full path of the target document, which must already be open in the
Acrobat application.
insertAfterPage
The page number after which pages are being inserted. Possible values can be a
page number or one of the following:
PDBeforeFirstPage — Pages are inserted at the beginning of the
document.
PDLastPage — Pages are inserted at the end of the document.
sourcePath
The full path of the source document. This file need not be open in the Acrobat
application.
Returns
true if the pages are inserted successfully, false if the document does not exist or the pages are not
inserted successfully.
Related methods
DocDeletePages
DocReplacePages
DocOpen
Opens a document and adds it to the list of documents known to DDE, allowing it to be manipulated by
other DDE messages (see FileOpen).
DocOpen is also supported in Adobe Reader.
Syntax
[DocOpen(char* fullPath)]
Parameters
fullPath
The full path of the file to be opened.
Returns
true if the file is opened successfully, false otherwise.
Related methods
CloseAllDocs
DocClose
FileOpen
Adobe Acrobat SDK
DDE Messages
Interapplication Communication API Reference
DocPageDown
Scrolls forward through the document by one screen area.
Syntax
[DocPageDown(char* fullPath)]
Parameters
fullPath
The full path of the document.
Returns
false if the document specified by fullPath does not exist, true otherwise.
Related methods
DocPageLeft
DocPageRight
DocPageUp
DocScrollTo
DocPageLeft
Scrolls to the left by a small amount.
Syntax
[DocPageLeft(char* fullPath)]
Parameters
fullPath
The full path of the document.
Returns
false if the document specified by fullPath does not exist, true otherwise.
Related methods
DocPageDown
DocPageRight
DocPageUp
DocPageUp
DocPageDown
127
Adobe Acrobat SDK
DDE Messages
Interapplication Communication API Reference
DocPageRight
Scrolls to the right by a small amount.
Syntax
[DocPageRight(char* fullPath)]
Parameters
fullPath
The full path of the document.
Returns
false if the document specified by fullPath does not exist, true otherwise.
Related methods
DocPageDown
DocPageLeft
DocPageUp
DocPageUp
DocPageUp
Scrolls backward through the document by one screen area.
Syntax
[DocPageUp(char* fullPath)]
Parameters
fullPath
The full path of the document.
Returns
false if the document specified by fullPath does not exist, true otherwise.
Related methods
DocPageDown
DocPageLeft
DocPageRight
DocScrollTo
DocPageRight
128
Adobe Acrobat SDK
DDE Messages
Interapplication Communication API Reference
DocPrint
129
DocPrint
Prints a specified range of pages from a document, without displaying any modal Print dialog box to the
user. For PostScript printing, only Level 1 operators are used, only ASCII data is generated, and the
document’s pages are not shrunk to fit into the imageable area of the printed page.
Syntax
[DocPrint(char* fullPath, long startPage, long endPage)]
Parameters
fullPath
The full path of document.
startPage
The page number of the first page to be printed.
endPage
The page number of the last page to be printed.
Returns
false if the document specified by fullPath does not exist, true otherwise.
Related methods
FilePrint
FilePrintSilent
FilePrintTo
DocReplacePages
Replaces pages in the target document using the specified pages from the source document.
Syntax
[DocReplacePages(char* fullPath, long startDestPage,
char* sourcePath, long startSourcePage,
long endSourcePage)]
Parameters
fullPath
The full path of the target document. This file must already be open in the
Acrobat application.
startDestPage
The page number of the first page in the target document to be replaced.
sourcePath
The full path of the source document. This file does not have to be already open
in the Acrobat application.
Adobe Acrobat SDK
DDE Messages
Interapplication Communication API Reference
DocSave
startSourcePage
The page number of the first page in the source document to use as a
replacement page.
endSourcePage
The page number of the last page in the source document to use as a
replacement page.
130
Returns
true if the pages are replaced successfully. Returns false if the document does not exist or the pages are
not replaced successfully.
Related methods
DocDeletePages
DocInsertPages
DocSave
Saves the specified file. The user is not warned if there are any problems saving the file.
Syntax
[DocSave(char* fullPath)]
Parameters
fullPath
The full path of the file to be saved.
Returns
true if the document is saved successfully, false if the document does not exist or is not saved
successfully.
Related methods
DocSaveAs
DocSaveAs
Saves an open file to a new path. The user is not warned if there are any problems saving the file.
Syntax
[DocSaveAs(char* fullPath, char* newPath)]
Adobe Acrobat SDK
DDE Messages
Interapplication Communication API Reference
DocScrollTo
Parameters
fullPath
The full path of the existing file.
newPath
The full path of the new file.
Returns
true if the document is saved successfully, false if the document does not exist or is not saved
successfully.
Related methods
DocSave
DocScrollTo
Scrolls the view of the current page to the specified location.
Syntax
[DocScrollTo(char* fullPath, int x, int y)]
Parameters
fullPath
The full path of the document.
x
The destination’s x–coordinate.
y
The destination’s y–coordinate.
Returns
false if the document specified by fullPath does not exist, true otherwise.
Related methods
DocPageDown
DocPageLeft
DocPageRight
DocPageUp
131
Adobe Acrobat SDK
DDE Messages
Interapplication Communication API Reference
DocSetViewMode
132
DocSetViewMode
Determines whether bookmarks, thumbnail images, or neither are shown in addition to the document.
Syntax
[DocSetViewMode(char* fullPath, char* viewType)]
Parameters
fullPath
The full path of the document.
viewType
The view mode to be used. Must be one of the following:
PDUseThumbs — Displays pages and thumbnail images.
PDUseNone — Displays only pages.
PDUseBookmarks — Displays pages and bookmarks.
Returns
true if the view mode is set successfully, false if the document specified by fullPath does not exist or
an unknown view mode is specified.
Related methods
FullMenus
ShortMenus
DocZoomTo
Sets the zoom for a specified document.
Syntax
[DocZoomTo(char* fullPath, char* zoomType, int scale)]
Parameters
fullPath
The full path of the file whose zoom to set.
zoomType
The zoom strategy to use. Must be one of the following:
AVZoomNoVary — A fixed zoom, such as 100%.
AVZoomFitPage — Fits the page in the window.
AVZoomFitWidth — Fits the page’s width into the window.
AVZoomFitVisibleWidth — Fits the page’s visible content into the window.
scale
The magnification specified as a percent (for example, 100 corresponds to a
magnification of 1.0). scale is used only when zoomType is AVZoomNoVary.
Adobe Acrobat SDK
DDE Messages
Interapplication Communication API Reference
FileOpen
133
Returns
false if the document specified by fullPath does not exist, or if zoomType has an unknown value.
Returns true otherwise.
FileOpen
Opens and displays the specified document. If the file is already open, it becomes the active document
and appears in the front. This DDE message does not add the document to the list that can be
manipulated using DDE messages; use DocOpen to do that.
FileOpen is also supported in Adobe Reader.
Syntax
[FileOpen(char* fullPath)]
Parameters
fullPath
The full path of the file to be opened.
Returns
true if the file is opened successfully, false otherwise.
Related methods
CloseAllDocs
DocClose
DocOpen
FileOpenEx
Opens and displays a file. If the file is already open, it becomes the active document and appears in the
front. This DDE message does not add the document to the list that can be manipulated using DDE
messages; use DocOpen to do that.
This method allows documents that either take a long time to open or are password-protected to open
without stopping the flow of DDE messages. Documents opened with FileOpenEx are opened during an
idle period. This is useful in situations in which several DDE messages are sent at once, such as a multiple
file select from Windows Explorer.
FileOpenEx is also supported in Adobe Reader.
Syntax
[FileOpenEx(char* fullPath)]
Adobe Acrobat SDK
DDE Messages
Interapplication Communication API Reference
FilePrint
134
Parameters
fullPath
The full path of the file to be opened.
Returns
true is always returned. The specified file may not actually open.
Related methods
FileOpen
CloseAllDocs
DocClose
DocOpen
FilePrint
Prints all pages in a document, displaying a modal print dialog box to the user. For PostScript printing, only
Level 1 operators are used, only ASCII data is generated, and the document’s pages are not shrunk to fit
into the imageable area of the printed page.
FilePrint is also supported in Adobe Reader.
Syntax
[FilePrint(char* fullPath)]
Parameters
fullPath
The full path of the file to be printed.
Returns
false if the document specified by fullPath does not exist, true otherwise.
Related methods
DocPrint
FilePrintSilent
FilePrintTo
Adobe Acrobat SDK
DDE Messages
Interapplication Communication API Reference
FilePrintEx
135
FilePrintEx
Prints all pages in a document, displaying a modal print dialog box to the user. For PostScript printing, only
Level 1 operators are used, only ASCII data is generated, and the document's pages are not shrunk to fit
into the imageable area of the printed page.
Similar to FileOpenEx, this is a special DDE command that returns true right away and performs the
action during idle periods. This ensures that no DDE commands are lost when printing a large number of
files simultaneously.
FilePrintEx is also supported in Adobe Reader.
Syntax
[FilePrintEx(char* fullPath)]
Parameters
fullPath
The full path of the file to print.
Returns
true is always returned.
Related methods
DocPrint
FileOpenEx
FilePrint
FilePrintSilent
FilePrintSilentEx
FilePrintTo
FilePrintToEx
FilePrintSilent
Prints all pages in a document, without displaying a print dialog box to the user. For PostScript printing,
only Level 1 operators are used, only ASCII data is generated, and the document’s pages are not shrunk to
fit into the imageable area of the printed page.
FilePrintSilent is also supported in Adobe Reader.
Syntax
[FilePrintSilent(char* fullPath)]
Adobe Acrobat SDK
DDE Messages
Interapplication Communication API Reference
FilePrintSilentEx
136
Parameters
fullPath
The full path of the file to be printed.
Returns
false if the document specified by fullPath does not exist, true otherwise.
Related methods
DocPrint
FilePrint
FilePrintTo
FilePrintSilentEx
Prints all pages in a document, without displaying a print dialog box to the user. For PostScript printing,
only Level 1 operators are used, only ASCII data is generated, and the document’s pages are not shrunk to
fit into the imageable area of the printed page.
Similar to FileOpenEx, this is a DDE command that returns true right away and does the action during
idle periods. This is to ensure that no DDE commands are lost when printing a large number of files
simultaneously.
FilePrintSilentEx is also supported in Adobe Reader.
Syntax
[FilePrintSilentEx(char* fullPath)]
Parameters
fullPath
Returns
true is always returned.
Related methods
DocPrint
FileOpenEx
FilePrintEx
FilePrintSilent
FilePrintTo
FilePrintToEx
The full path of the file to be printed.
Adobe Acrobat SDK
DDE Messages
Interapplication Communication API Reference
FilePrintTo
137
FilePrintTo
Prints all pages in a document to a specified printer, using a specified driver and port, displaying a modal
print dialog box to the user. For PostScript printing, only ASCII data is generated, and the document’s
pages are not shrunk to fit into the imageable area of the printed page.
FilePrintTo is also supported in Adobe Reader.
Syntax
[FilePrintTo(char* fullPath, char* printName,
char* driverName, char* portName)]
Parameters
fullPath
The full path of the file to be printed.
printName
The name of the printer. Required for Windows 95 and later.
driverName
Printer driver name.
portName
Port name. Required for Windows NT.
Returns
false if the document specified by fullPath does not exist, true otherwise.
Related methods
DocPrint
FilePrint
FilePrintSilent
FilePrintToEx
Prints all pages in a document to a specified printer, using a specified driver and port, displaying a modal
print dialog box to the user. For PostScript printing, only ASCII data is generated, and the document’s
pages are not shrunk to fit into the imageable area of the printed page.
Similar to FileOpenEx, this is a DDE command that returns true right away and does the action during
idle periods. This is to ensure that no DDE commands are lost when printing a large number of files
simultaneously.
FilePrintToEx is also supported in Adobe Reader.
Syntax
[FilePrintToEx(char* fullPath, char* printName,
char* driverName, char* portName)]
Adobe Acrobat SDK
DDE Messages
Interapplication Communication API Reference
Parameters
fullPath
The full path of the file to be printed.
printName
The name of the printer. Required for Windows 95 and later.
driverName
Printer driver name.
portName
Port name. Required for Windows NT.
Returns
true is always returned.
Related methods
DocPrint
FileOpenEx
FilePrintEx
FilePrintSilentEx
FilePrintTo
FilePrintToEx
FullMenus
Displays full menus, and sets this option in the Acrobat application’s preferences file.
With Acrobat 3.0 or later, all menus are displayed, and this function is ignored.
Syntax
[FullMenus()]
Returns
true if full menus are set successfully, false otherwise.
Related methods
DocSetViewMode
ShortMenus
HideToolbar
Hides the toolbar.
FullMenus
138
Adobe Acrobat SDK
DDE Messages
Interapplication Communication API Reference
MenuitemExecute
139
Syntax
[HideToolbar()]
Returns
true if the toolbar is hidden successfully, false otherwise.
Related methods
ShowToolbar
MenuitemExecute
Executes the menu item specified by its language-independent name.
Syntax
[MenuitemExecute(char* menuItemName)]
Parameters
menuItemName
The language-independent name of the menu item to execute. See the Acrobat
and PDF Library API Reference for a list of menu item names.
ShortMenus
Displays short menus, and sets this option in the Acrobat application’s preferences file.
With Acrobat 3.0 or later, all menus are displayed, and this function is ignored.
Syntax
[ShortMenus()]
Returns
true if short menus are set successfully, false otherwise.
Related methods
DocSetViewMode
FullMenus
Adobe Acrobat SDK
Interapplication Communication API Reference
ShowToolbar
Shows the toolbar.
Syntax
[ShowToolbar()]
Returns
true if the toolbar is shown successfully, false otherwise.
Related methods
HideToolbar
DDE Messages
ShowToolbar
140
3
Apple Event Objects and Apple Events
This chapter describes the supported Apple event objects, with descriptions of each object’s elements and
properties, and the supported Apple events.
Objects
Acrobat presents the following objects to the Apple event interface:
●
annotation
●
application
●
bookmark
●
conversion
●
document
●
Link Annotation
●
menu
●
menu item
●
page
●
PDF Window
●
Text Annotation
annotation
An annotation on a page in a PDF file that corresponds to PDAnnot, an internal Acrobat class. This object
was formerly known as PDAnnot.
Acrobat also has two built-in annotation objects. For more information, see “Link Annotation” on page 149
and “Text Annotation” on page 154.
Plural form
Annotations
Properties
Property
Class
Description
best type
type class [r/o]
The best descriptor type.
bounds
a list of small real
The boundary rectangle for the annotation in
PDF space (left, top, right, bottom).
class
type class [r/o]
The class.
141
Adobe Acrobat SDK
Apple Event Objects and Apple Events
Interapplication Communication API Reference
annotation
142
Property
Class
Description
color
'RGB'
The color of the border around the annotation.
contents
international text
Text annotations only. The textual contents of
the note.
default type
type class [r/o]
The default descriptor type.
destination page
number
integer
Link annotations only. The page number to
appear in the PDF window when the
annotation link is activated.
destination
rectangle
a list of small real
Link annotations only. The boundary rectangle
(specified in user space) for the view of the
destination. Coordinates are specified in the
following order: left, top, right, bottom.
fit type
constant
Link annotations only. Determines how the
destination rectangle is fitted to the window
when the link is activated. Values are: Left
Top Zoom, Fit Page, Fit Width, Fit
Height, Fit Rect, Fit BBox, Fit BB
Width, Fit BB Height
These are described in the PDF Reference.
index
integer [r/o]
The annotation’s index within the page object.
modification date
date
The date and time the annotation was last
modified.
name
string
Text annotations only. The annotation’s label.
open state
Boolean
Text annotations only. Whether the annotation
is open.
subtype
international text [r/o]
The subtype of the annotation.
zoom factor
small real
Link annotations only. If fit type is Left
Top Zoom, this specifies the zoom factor;
otherwise it is ignored. Setting this property
automatically sets fit type to Left Top
Zoom.
Related methods
delete
perform
Adobe Acrobat SDK
Apple Event Objects and Apple Events
Interapplication Communication API Reference
application
143
application
The Acrobat or Adobe Reader application itself.
Elements
Element
Accessed by
document
name, numeric index
PDF Window
name, numeric index
menu
name, numeric index
menu item
name
Properties
Property
Class
Description
active doc
reference
The active document.
active tool
international text
The type of the currently active tool. See the
Acrobat and PDF Library API Reference for a list
of tool names.
anti_alias text
Boolean
Determines whether to anti-alias text and
monochrome images.
best type
type class [r/o]
The best descriptor type.
case sensitivity
Boolean
Determines whether searches are casesensitive.
class
type class [r/o]
The class.
default type
type class [r/o]
The default descriptor type.
default zoom factor
small real
The default zoom factor, in percent, used for
displaying new documents. For example, a
value of 100 corresponds to a zoom factor of
1.0 (100%).
default zoom type
constant
The default zoom type when opening a new
document. Valid values are no vary, fit
page, fit width, fit height, and fit
visible width.
download entire file Boolean
Determines whether to download the entire
file.
frontmost
Boolean
Determines whether Acrobat is the frontmost
application. Value can be set to true only.
Adobe Acrobat SDK
Apple Event Objects and Apple Events
Interapplication Communication API Reference
application
144
Property
Class
Description
fullscreen click
advances
Boolean
Determines whether mouse click advances in
fullscreen mode.
fullscreen cursor
Boolean
Determines whether to hide the cursor in
fullscreen mode.
fullscreen escape
Boolean
Determines whether the Esc key can be used
to exit fullscreen mode.
fullscreen loop
Boolean [r/o]
Determines whether the document’s pages
are displayed in a loop while in fullscreen
mode.
fullscreen timer
delay
integer
The number of seconds to advance to the next
page in fullscreen mode.
fullscreen
transition
international text [r/o]
Default fullscreen transition.
highlight color
'RGB '
Color used to highlight selections.
maximum documents
integer [r/o]
Maximum number of open documents.
name
string [r/o]
The application’s name.
note color
'RGB ‘
A list of three values between 0 and 65535
representing the color of the border around
text annotations. For example, the following
sets the note color to deep blue: set the
note color to {0, 0, 32768}.
note font name
international text
Deprecated.
note font size
integer
Deprecated.
open in place
Boolean
Determines whether to open cross-document
links in the same window.
page layout
international text
Default page layout. Values are: Single
Page, Continuous, Facing, and
Continuous - Facing.
page units
international text
Default page display units: Points, Inches
or Millimeters.
PS level
integer
Deprecated. Set the PostScript level when
using save or print pages commands.
save as linearize
Boolean
Determines whether to save the document as
optimized for the web.
show splash at
startup
Boolean
Determines whether the splash screen is
shown at startup.
Adobe Acrobat SDK
Apple Event Objects and Apple Events
Interapplication Communication API Reference
AVPageView
Property
Class
Description
skip warnings
Boolean
Determines whether to skip warning dialog
boxes during program execution.
shrink to fit
Boolean
Deprecated.
text note label
international text
The text that will appear in the title bar of all
newly created text notes.
toolbar visibility
Boolean
Determines whether the toolbar is visible.
UI language
international text [r/o]
A three-character language code identifying
which language is used in the Acrobat user
interface. Example: ENU represents English.
use fullscreen timer Boolean
version
string [r/o]
whole word searching Boolean
Determines whether to use a timer to advance
pages in fullscreen mode
The version number of the application.
Determines whether searches are applied to
whole words only.
Related methods
close all docs
count
make
open
print
quit
run
AVPageView
Note: Deprecated. Use PDF Window instead.
bookmark
A bookmark on a page in a PDF file. Corresponds to Acrobat’s PDBookmark object.
Note: This object was formerly known as PDBookmark.
Plural form
Bookmarks
145
Adobe Acrobat SDK
Apple Event Objects and Apple Events
Interapplication Communication API Reference
bookmark
146
Properties
Property
Class
Description
best type
type class [r/o]
The best descriptor type.
class
type class [r/o]
The class.
default type
type class [r/o]
The default descriptor type.
destination page
number
integer
The page number to which the PDF Window goes
when the bookmark’s action is performed.
destination
rectangle
list of small real
Boundary rectangle (specified in user space) for the
view of the destination when the bookmark’s action is
performed. Coordinates are specified in the following
order: (left, top, right, bottom).
Note: Set this only after setting fit type.
fit type
constant
Controls how the destination rectangle is fitted to the
window when the bookmark’s action is performed.
Possible values:
Left Top Zoom — Sets a specified zoom and a
specified location on the page.
Fit Page — Sets the zoom factor so that the entire
page fits into the window.
Fit Width — Sets the zoom factor so that the width
of the page fits into the window.
Fit Height — Sets the zoom factor so that the
height of the page fits into the window.
Fit Rect — Sets the zoom factor so that the
specified rectangle fits into the window.
Fit BBox — Sets the zoom so that the rectangle
enclosing all marks on the page (known as the
bounding box) fits into the window.
Fit BB Width — Sets the zoom factor so that the
width of the bounding box fits into the window.
Fit BB Height — Sets the zoom factor so that the
height of the bounding box fits into the window.
index
integer [r/o]
The bookmark’s index within the document.
name
international text
The bookmark’s title.
zoom factor
small real
The zoom factor used when fit type is Left Top
Zoom; ignored otherwise. Setting this property
automatically sets fit type to Left Top Zoom.
Adobe Acrobat SDK
Apple Event Objects and Apple Events
Interapplication Communication API Reference
conversion
147
Related methods
insert pages
perform
conversion
A file type converter that exports PDF files into other formats. Conversions correspond to the list of formats
specified in the Acrobat Save As menu. A list of formats can be obtained as follows:
get every conversion
Properties
Property
Class
Description
best type
type class [r/o]
The best descriptor type.
class
type class [r/o]
The class.
default type
type class [r/o]
The default descriptor type.
index
integer [r/o]
The index number of the converter.
name
international text
The conversion’s description.
Related methods
save
document
Represents a single open document in Acrobat or Adobe Reader.
Elements
Element
Accessed by
page
Numeric index. The first page in a document is page 1.
bookmark
Name or numeric index.
PDF Window
An index of 1 or with the some keyword in AppleScript. No
document has more than one PDF Window.
Plural form
documents
Adobe Acrobat SDK
Apple Event Objects and Apple Events
Interapplication Communication API Reference
document
148
Properties
Property
Class
Description
best type
type class [r/o]
The best descriptor type.
bounds
bounding rectangle [r/o]
The boundary rectangle for the document’s window,
in screen coordinates (left, top, right, bottom).
class
type class [r/o]
The class.
default type
type class [r/o]
The default descriptor type.
file alias
alias [r/o]
An alias for the file to which the document will be
saved if no other name is specified; this is usually the
same path from which the document was read.
modified
Boolean [r/o]
Determines whether the document has been
modified and should be saved.
name
international text [r/o]
The document’s name as it appears in the window’s
titlebar.
view mode
constant
The viewing mode of the document. Possible values:
just pages, pages and thumbs, or pages and
bookmarks.
Related methods
bring to front
clear selection
close
count
create thumbs
delete
delete pages
delete thumbs
find next note
find text
get info
insert pages
maximize
print pages
replace pages
save
set info
Adobe Acrobat SDK
Apple Event Objects and Apple Events
Interapplication Communication API Reference
EPS Conversion
149
EPS Conversion
A file type converter that exports PDF files into EPS format.
Properties
Inherits from PostScript Conversion.
Related methods
save
Link Annotation
A link annotation on a page in a PDF file. Can only be used as the target of a make event. All other access is
via the annotation class.
Note: This object was formerly known as PDLinkAnnot.
Properties
Inherits from annotation.
Related methods
delete
perform
menu
A menu in the Acrobat or Adobe Reader menu bar.
Elements
Element
Accessed by
menu item
name, numeric index.
Properties
Property
Class
Description
best type
type class [r/o]
The best descriptor type.
class
type class [r/o]
The class.
default type
type class [r/o]
The default descriptor type.
Adobe Acrobat SDK
Apple Event Objects and Apple Events
Interapplication Communication API Reference
menu item
150
Property
Class
Description
name
international text [r/o]
The menu’s name (a language-independent
name that uniquely identifies the menu). See
the Acrobat and PDF Library API Reference for a
list of menu names.
title
string [r/o]
The menu’s title as it would appear in the user
interface.
Related methods
execute
menu item
A menu item contained within a menu in Acrobat or Adobe Reader.
Properties
Property
Class
Description
best type
type class [r/o]
The best descriptor type.
class
type class [r/o]
The class.
default type
type class [r/o]
The default descriptor type.
enabled
Boolean [r/o]
Determines whether the menu item is
enabled.
has submenu
Boolean [r/o]
Determines whether the menu item has a
hierarchical sub-menu.
marked
Boolean [r/o]
Determines whether the menu item is
checked.
name
international text [r/o]
The menu item’s language-independent
name. See the Acrobat and PDF Library API
Reference for a list of menu item names.
title
string [r/o]
The menu’s title as it would appear in the user
interface.
Related methods
execute
Adobe Acrobat SDK
Apple Event Objects and Apple Events
Interapplication Communication API Reference
page
151
page
A single page in the PDF representation of a document. Corresponds to Acrobat’s internal PDPage object.
Note: This object was formerly known as PDPage.
Elements
Element
Accessed by
annotation
numeric index.
Plural form
Pages
Properties
Property
Class
Description
best type
type class [r/o]
The best descriptor type.
bounds
list of small real
The boundary rectangle for the page in user
space (left, top, right, bottom).
class
type class [r/o]
The class.
default type
type class [r/o]
The default descriptor type.
page number
integer [r/o]
The page’s number. The first page in a
document is page 1.
rotation
integer
The rotation angle of the page in degrees (0,
90, 180, or 270).
Related methods
delete pages
insert pages
replace pages
goto
move
PDAnnot
Note: Deprecated. Use annotation instead.
Adobe Acrobat SDK
Apple Event Objects and Apple Events
Interapplication Communication API Reference
PDBookMark
152
PDBookMark
Note: Deprecated. Use bookmark instead.
PDLinkAnnot
Note: Deprecated. Use Link Annotation instead.
PDPage
Note: Deprecated. Use page instead.
PDTextAnnot
Note: Deprecated. Use Text Annotation instead.
PDF Window
The area of the Acrobat or Adobe Reader window that displays the contents of a page within the
document. Corresponds to the Acrobat internal AvPageView object. A document that is not visible does
not have a PDF Window.
Note: This object was formerly known as AVPageView.
Elements
Element
Accessed by
page
numeric index. The first page in a document is page 1.
Properties
Property
Class
Description
best type
type class [r/o]
The best descriptor type.
bounds
bounding rectangle
The boundary rectangle for the window.
class
type class [r/o]
The class.
default type
type class [r/o]
The default descriptor type.
document
document [r/o]
The document that owns this window.
index
integer
The number of the window.
name
international text [r/o]
The document’s name as shown in the
window’s titlebar.
page number
integer
The number of the currently displayed page.
Adobe Acrobat SDK
Apple Event Objects and Apple Events
Interapplication Communication API Reference
PostScript Conversion
153
Property
Class
Description
position
point [r/o]
The upper left coordinates of the window.
visible
Boolean [r/o]
Whether the window is visible.
zoomed
Boolean
Whether the window is zoomed.
zoom factor
small real
The current zoom factor specified as a
percentage. For example, a value of 100
corresponds to a zoom factor of 1.0 (100%).
zoom type
constant
The zooming and content fitting algorithm
currently employed. Possible values: no vary,
fit page, fit width, fit height, and
fit visible width.
Related methods
go backward
go forward
goto
goto next
goto previous
read page down
read page up
scroll
select text
zoom
PostScript Conversion
A file type converter that exports PDF files into PostScript format.
Properties
Inherits other properties from conversion.
Property
Class
Description
annotations
Boolean [r/o]
Determines whether to include annotations.
binary
Boolean [r/o]
Determines whether the output file should be
in binary or ASCII text format.
Adobe Acrobat SDK
Apple Event Objects and Apple Events
Interapplication Communication API Reference
Text Annotation
154
Property
Class
Description
embedded fonts
Boolean [r/o]
Determines whether to include fonts.
halftones
Boolean [r/o]
Determines whether to use halftone screens.
images
Boolean [r/o]
Determines whether to include RGB and LAB
images.
postScript level
integer [r/o]
The PostScript Language level. Only levels 2
and 3 are supported.
preview
Boolean [r/o]
Determines whether to include preview in
output.
TrueType
Boolean [r/o]
Determines whether to convert TrueType fonts
to Type 1.
Related methods
save
Text Annotation
A PDF text annotation (note) on a page in a PDF file. Can only be used as the target of a make event. All
other access is via the annotation class.
Note: This object was formerly known as TextAnnot.
Properties
Inherits from annotation.
Related methods
find next note
perform
replace pages
Adobe Acrobat SDK
Apple Event Objects and Apple Events
Interapplication Communication API Reference
Required suite events
155
Required suite events
The following events are sent by the Finder to all applications:
●
open
●
print
●
quit
●
run
Note: Most of these events have counterparts in the Core suite that have greater functionality. The
Required suite is not listed in the AppleScript dictionary, even though it is implemented.
Adobe Reader also supports the Required suite events, but no others.
open
Opens a file.
Syntax
open [reference]
Parameters
open
The file or files to open.
print
Prints one or more files.
Syntax
print [reference]
Parameters
print
The file or files to print.
quit
Terminates an application. For information on a variant event in the Core suite that accepts options, see
quit on page 160.
Syntax
quit
Adobe Acrobat SDK
Apple Event Objects and Apple Events
Interapplication Communication API Reference
run
156
run
Launches the application and invokes its standard startup procedures.
Syntax
run
Core suite events
Acrobat supports the following subset of the Core suite of Apple events:
●
close
●
count
●
delete
●
exists
●
get
●
make
●
move
●
open
●
quit
●
save
●
set
close
Closes a document.
Syntax
close [reference] saving [constant] linearize [boolean]
Parameters
close
The document to close.
saving
Determines whether to save a document that has been modified before
quitting. Possible values:
yes — Save the document.
no — Do not save the document.
ask — Ask the user whether to save the document.
The default value is ask.
linearize
Determines whether the document should be optimized for the web when
saving before closing.
Adobe Acrobat SDK
Apple Event Objects and Apple Events
Interapplication Communication API Reference
count
Related events
open
count
Counts the number of instances of a particular class.
Syntax
count [type class] of [reference]
Parameters
count
The class whose instances are to be counted.
each
The class whose instances are to be counted. This keyword is optional.
Note: There is an alternate form using the keyword each in which the parameters are reversed:
count [reference] each [type class]
Returns
An integer specifying the number of elements.
AppleScript example
count annotation of document "dev_acro.pdf"
count menu item of menu "View"
count document 1 each bookmark
delete
Deletes one or more objects.
Syntax
delete [reference]
Parameters
delete
Related events
make
exists
The object to be deleted.
157
Adobe Acrobat SDK
Apple Event Objects and Apple Events
Interapplication Communication API Reference
exists
158
AppleScript example
delete first bookmark of document "test.pdf"
exists
Tests whether a specified object exists.
Syntax
[reference] exists
exists [reference]
Parameters
exists
Object whose existence is checked.
Returns
true if the object exists, false otherwise.
AppleScript example
exists second document
second document exists
get
Retrieves the value of an object or property.
Syntax
get [reference] as [class]
Note: The keyword get is optional.
Parameters
get
The object or property whose value is returned.
as
The form in which the data is returned.
Returns
The value of the specified property or object. If the specified object does not exist, no result is returned.
Related events
set
Adobe Acrobat SDK
Apple Event Objects and Apple Events
Interapplication Communication API Reference
make
AppleScript example
get the name of last bookmark
get the index of last bookmark as string
make
Creates a new object.
Syntax
make new [type class] at [location reference] with data [anything] with
properties [record]
Parameters
make [new]
The class of the new object.
at
The location at which to insert the new object.
with data
The initial data for the new object.
with properties
The initial values for the properties of the new object.
Returns
A reference to the newly created object.
Related events
delete
exists
AppleScript example
set myAnnotation to make TextAnnotation at beginning
set name of myAnnotation to "Werner Heisenberg"
set contents of myAnnotation to "Might have been here"
move
Moves a page object.
Syntax
move [reference] to [location reference]
159
Adobe Acrobat SDK
Apple Event Objects and Apple Events
Interapplication Communication API Reference
open
160
Parameters
move
The page object to move. The first page in a document is page 1.
to
The new location for the page.
Returns
A reference to the page that is moved.
AppleScript example
move page 3 to before page 1
open
Opens a document or documents.
Syntax
open [list of alias] invisible [boolean] options [string]
Parameters
open
The document or documents to open.
invisible
Whether the opened document should be hidden. Default is false.
options
Optional parameter string of open actions.
Related events
close
quit
Causes the Acrobat application to quit.
Syntax
quit saving [constant]
Parameters
saving
Determines whether to save documents that have been modified before quitting.
Possible values:
yes — Save the document.
no — Do not save the document.
ask — If the documents have been modified, ask the user whether to save them.
The default value is ask.
Adobe Acrobat SDK
Apple Event Objects and Apple Events
Interapplication Communication API Reference
save
161
AppleScript example
quit saving yes
save
Saves a document.
Syntax
save [reference] to [file specification] using [reference] linearize[ boolean]
Parameters
save
The document to be saved.
to
The file into which the document is to be saved. This parameter is optional
in Acrobat 6.0 and higher. Specifying the to parameter is equivalent to
doing a Save As. You can save a document in one of the supported formats
with the using parameter.
linearize
Determines whether the document should be optimized for the web.
using
The conversion method used to save the document in the desired format.
Supported conversions by name are EPS Conversion and PostScript
Conversion. All others can be specified by index using the conversion
object.
AppleScript example
save document 1 to file "MyHardDrive:tempBig.ps" using PostScript Conversion
with embedded fonts, images, preview, and annotation without binary given
postScript level: 1
set
Sets an object’s data or properties.
Syntax
set [reference] to [anything]
Parameters
set
The object or property whose value is set.
to
The new value.
Related events
get
Adobe Acrobat SDK
Interapplication Communication API Reference
Apple Event Objects and Apple Events
Acrobat application events
AppleScript example
set the name of first bookmark to "Chapter 1"
Acrobat application events
This section describes a number of Acrobat API calls for the Apple event interface that are specific to
Acrobat applications. The supported events in this suite are:
●
bring to front
●
clear selection
●
close all docs
●
create thumbs
●
delete pages
●
delete thumbs
●
execute
●
find next note
●
find text
●
get info
●
go backward
●
go forward
●
goto
●
goto next
●
goto previous
●
insert pages
●
is toolbutton enabled
●
maximize
●
perform
●
print pages
●
read page down
●
read page up
●
remove toolbutton
●
replace pages
●
scroll
●
select text
●
set info
●
zoom
Apple encourages the use of an application’s signature as the name of its class for application-specific
Apple events. The string CARO is the name of the class for Acrobat-specific Apple events:
#define kAEAcrobatViewerClass 'CARO'
AppleScript does not need this information.
162
Adobe Acrobat SDK
Apple Event Objects and Apple Events
Interapplication Communication API Reference
bring to front
163
bring to front
Brings the specified document’s window to the front.
Syntax
bring to front [reference]
Parameters
bring to front
The document to be displayed as the active document in the front window.
AppleScript example
bring to front document "AppleEvt.pdf"
Apple event ID
kAEBringToFront ('bfrt')
clear selection
Clears the document’s current selection, if any.
Syntax
clear selection [reference]
Parameters
clear selection
The document containing the selection to be cleared
Related events
select text
AppleScript example
clear selection document "PLUGINS.PDF"
Apple event ID
kAEClearSelection ('clsl')
close all docs
Closes all documents.
Syntax
close all docs saving [constant]
Adobe Acrobat SDK
Apple Event Objects and Apple Events
Interapplication Communication API Reference
create thumbs
164
Parameters
saving
Determines whether to save modified documents before closing. Possible
values:
yes — Save the document.
no — Do not save the document.
ask — If the document has been modified, ask the user whether to save it.
The default value is ask.
Related events
open (Required suite)
open (Core suite)
AppleScript example
close all docs
Apple event ID
kAECloseAllDocs ('cldc')
create thumbs
Creates thumbnail images for all pages in the document.
Syntax
create thumbs [reference]
Parameters
create thumbs
The document in which thumbnails are created.
Related events
delete thumbs
AppleScript example
create thumbs document "roadmap.pdf"
Apple event ID
kAECreateThumbs ('crtb')
Adobe Acrobat SDK
Apple Event Objects and Apple Events
Interapplication Communication API Reference
delete pages
delete pages
Deletes the specified pages in the document.
Syntax
delete pages [reference] first [integer] last [integer]
Parameters
delete pages
The document containing the pages to be deleted.
first
The first page to be deleted. The first page in a document is page 1.
last
The last page to be deleted.
Related events
insert pages
replace pages
AppleScript example
delete pages document "AppleEvt.pdf" first 1 last 3
Apple event ID
kAEDeletePages ('dlpg')
Apple event parameters
keyAEFirstPage ('frpg')
keyAELastPage ('lapg'’)
delete thumbs
Deletes all thumbnails from the document.
Syntax
delete thumbs [reference]
Parameters
delete thumbs
Related events
create thumbs
The document from which thumbnails are deleted.
165
Adobe Acrobat SDK
Apple Event Objects and Apple Events
Interapplication Communication API Reference
execute
AppleScript example
delete thumbs document "AppleEvt.pdf"
Apple event ID
kAEDeleteThumbs ('dltb')
execute
Executes the specified menu item.
Syntax
execute [reference]
Parameters
execute
The menu item to execute. See the Acrobat and PDF Library API Reference
for a list of menu item names.
AppleScript example
activate
execute menu item "Open"
Apple event ID
kAEExecute ('exec')
find next note
Finds and selects the next text note in a document.
Syntax
find next note [reference] wrap around [boolean]
Parameters
find next note
The document in which to find the next text note.
wrap around
Determines whether to continue the search at the beginning of a
document if a note has not been found after the end of the document is
reached. If true, the search wraps around; otherwise it does not. The
default value is false.
Returns
The text annotation found.
166
Adobe Acrobat SDK
Apple Event Objects and Apple Events
Interapplication Communication API Reference
find text
167
Related events
find text
AppleScript example
find next note document "dev_acro.pdf"
Apple event ID
kAEFindNextNote ('fnnt')
Apple event parameters
keyAEWrapAround ('wrar')
find text
Finds text in a document.
Syntax
find text [reference] string [international text] case sensitive [boolean]
whole words [boolean] wrap around [boolean]
Parameters
find text
The document to be searched.
string
The string to be found.
case sensitive
Determines whether searching is case-sensitive. The default value is
false.
whole words
Determines whether to search only for whole words. The default value is
false.
wrap around
Determines whether to continue the search at the beginning of a
document if the specified text has not been found after the end of the
document is reached. If true, the search wraps around; otherwise it does
not. The default value is false.
Related events
find next note
AppleScript example
find text document "PLUGINS.PDF" string "Develop" whole words true
Apple event ID
kAEFindText ('ftxt')
Adobe Acrobat SDK
Apple Event Objects and Apple Events
Interapplication Communication API Reference
get info
168
Apple event parameters
keyAESearchString ('sstr')
keyAECaseSensitive ('case')
keyAEWholeWordsOnly ('whwd')
keyAEWrapAround ('wrar')
get info
Gets the value of the specified key in the document’s Info dictionary.
Syntax
get info [reference] key [international text]
Parameters
get info
The document from which to obtain the Info dictionary entry.
key
The case-sensitive Info dictionary key whose value is to be obtained. The
predefined keys are: Creator, Producer, CreationDate, Author,
Title, Subject, and Keywords. None of these is required in the PDF file.
Returns
A string containing the specified key’s value, or an empty string if the key is not found.
AppleScript example
get info document "PLUGINS.PDF" key "CreationDate"
Apple event ID
kAEGetInfo ('gnfo')
Apple event parameters
keyAEInfoKey ('inky')
go backward
Goes to the previous view in the stored view history. Does nothing if the current view is the first view in the
history.
Syntax
go backward [reference]
Parameters
go backward
A PDF Window object
Adobe Acrobat SDK
Apple Event Objects and Apple Events
Interapplication Communication API Reference
go forward
Related events
go forward
goto
goto next
goto previous
AppleScript example
go backward first PDF Window
Apple event ID
kAEGoBack ('gbck')
go forward
Goes to the next view in the stored view history. Does nothing if the current view is the last view in the
history.
Syntax
go forward [reference]
Parameters
go forward
A PDF Window object
Related events
go backward
goto
goto next
goto previous
AppleScript example
go forward first PDF Window
Apple event ID
kAEGoForward ('gfwd')
169
Adobe Acrobat SDK
Apple Event Objects and Apple Events
Interapplication Communication API Reference
goto
170
goto
Displays the page that has the specified page number.
Syntax
goto [reference] page [integer]
Parameters
goto
The PDF Window object in which to change the page.
page
The page number of the page to be displayed. The first page in a
document is page 1.
Related events
go backward
go forward
goto next
goto previous
AppleScript example
goto first PDF Window page 2
Apple event ID
kAEGotoPage ('gtpg')
Apple event parameters
keyAEPageNumber ('pg #')
goto next
Displays the next page after the one currently displayed in the PDF Window. Does nothing if the current
page is the last page in the document.
Syntax
goto next [reference]
Parameters
goto next
The PDF Window object in which to change the page.
Adobe Acrobat SDK
Apple Event Objects and Apple Events
Interapplication Communication API Reference
goto previous
171
Related events
go backward
go forward
goto
goto previous
AppleScript example
goto next first PDF Window
Apple event ID
kAEGotoNextPage ('nxpg')
goto previous
Displays the previous page before the one currently displayed in the PDF Window. Does nothing if the
current page is the first page in the document.
Syntax
goto previous [reference]
Parameters
goto previous
The PDF Window object in which to change the page.
Related events
go backward
go forward
goto
goto next
AppleScript example
goto previous first PDF Window
Apple event ID
kAEGotoPrevPage ('pvpg')
Adobe Acrobat SDK
Apple Event Objects and Apple Events
Interapplication Communication API Reference
insert pages
172
insert pages
Inserts one or more pages from one document into another.
Syntax
insert pages [reference] after [integer] from [reference] starting with
[integer] number of pages [integer] insert bookmarks [boolean]
Parameters
insert pages
The target document in which to insert the page or pages.
after
The number of the page after which the pages will be inserted. The first
page in a document is page 1.
from
The source document containing the page or pages to be inserted.
starting with
The first page to be inserted.
number of pages
The number of pages to be inserted.
insert bookmarks
Determines whether to copy bookmarks that point to the inserted pages.
Default is true.
Related events
delete pages
AppleScript example
insert pages document "AppleEvt.pdf" after 2 from document "dev_acro.pdf"
starting with 1 number of pages 4
Apple event ID
kAEInsertPages ('inpg')
Apple event parameters
keyAEInsertAfter ('inaf')
keyAESourceDoc ('srdc')
kAESourceStartPage ('stpg')
keyAENumPages ('nmpg')
keyAEInsertBookmarks ('inbm')
is toolbutton enabled
Determines whether the specified toolbar button is enabled.
Syntax
is toolbutton enabled named [international text]
Adobe Acrobat SDK
Apple Event Objects and Apple Events
Interapplication Communication API Reference
maximize
173
Parameters
named
Button name. See the Acrobat and PDF Library API Reference for a list of
toolbar button names.
Returns
true if the toolbar button is enabled, false otherwise.
Related events
remove toolbutton
AppleScript example
is toolbutton enabled named "AcroSrch:Query"
Apple event ID
kAEIsToolButtonEnabled ('tben')
Apple event parameters
keyAEButtonname ('tbnm')
maximize
Sets the document’s window size to either its maximum or original size.
Syntax
maximize [reference] max size [integer]
Parameters
maximize
The document whose window is to be resized.
max size
If true, the document’s window is set to full size. If false, the window is
returned to its original size.
AppleScript example
maximize document "AppleEvt.pdf" max size false
Apple event ID
kAEMaximize ('maxi')
Apple event parameters
keyAEMaxSize ('mxsz')
Adobe Acrobat SDK
Apple Event Objects and Apple Events
Interapplication Communication API Reference
perform
174
perform
Executes a bookmark’s or link annotation’s action.
Syntax
perform [reference]
Parameters
object
The bookmark or page object whose action is to be performed.
AppleScript example
perform last bookmark
Apple event ID
kAEPerform ('prfm')
print pages
Prints one or more pages from a document without displaying a modal Print dialog box.
Syntax
print pages [reference] first [integer] last [integer] PS Level [integer]
binary output [boolean] shrink to fit [boolean]
Parameters
print pages
The document containing the page or pages to be printed. This keyword
and the actual filename must be specified.
first
The first page to be printed. The default value is 1.
last
The last page to print. The default value is the number of the last page in
the document.
PS Level
The PostScript language level (1 or 2) to use when printing to a PostScript
printer. The default value is 1.
binary output
Determines whether binary output is permitted (used for PostScript
printing only). The default value is false.
shrink to fit
Determines whether pages should be shrunk to fit paper in printer. The
default value is false.
AppleScript example
print pages document "AppleEvt.pdf" first 1 last 3 PS Level 2 binary output
true shrink to fit true
Adobe Acrobat SDK
Apple Event Objects and Apple Events
Interapplication Communication API Reference
read page down
Apple event ID
kAEPrintPages ('prpg')
Apple event parameters
keyAEFirstPage ('frpg')
keyAELastPage ('lapg')
keyAEPSLevel ('pslv')
keyAEBinaryOK ('binO')
keyAEShrinkToFit ('s2ft')
read page down
Scrolls forward through the document by one screen.
Syntax
read page down [reference]
Parameters
read page down
The PDF Window object to be scrolled.
Related events
read page up
scroll
AppleScript example
read page down first PDF Window
Apple event ID
kAEReadPageDown ('pgdn')
read page up
Scrolls backward through the document by one screen.
Syntax
read page up [reference]
Parameters
read page up
The PDF Window object to be scrolled.
175
Adobe Acrobat SDK
Apple Event Objects and Apple Events
Interapplication Communication API Reference
remove toolbutton
Related events
read page down
scroll
AppleScript example
read page up first PDFPageWindow
Apple event ID
kAEReadPageUp ('pgup')
remove toolbutton
Removes the specified button from the toolbar.
Syntax
remove toolbutton named [international text]
Parameters
named
The name of the toolbar button to be removed. See the Acrobat and PDF
Library API Reference for a list of toolbar button names.
Related events
is toolbutton enabled
AppleScript example
remove toolbutton named "ZoomIn"
Apple event ID
kAERemoveToolButton ('rmtb')
Apple event parameters
keyAEButtonname ('tbnm')
replace pages
Replaces one or more pages in a document with pages from another document.
Syntax
replace pages [reference] over [integer] from [reference] starting with
[integer] number of pages [integer] merge notes [boolean]
176
Adobe Acrobat SDK
Apple Event Objects and Apple Events
Interapplication Communication API Reference
scroll
177
Parameters
replace pages
The target document whose pages are to be replaced.
over
The first page to be replaced. The first page in a document is page 1.
from
The source document from which the replacement page or pages are obtained.
starting with
The first page in the source document to be copied.
number of pages
The number of pages to be replaced.
merge notes
Determines whether to copy notes from the source document. The default
value is true.
Related events
delete pages
insert pages
AppleScript example
replace pages document "AppleEvt.pdf" over 2 from document "dev_acro.pdf"
starting with 1 number of pages 4 merge notes false
Apple event ID
kAEReplacePages ('rppg')
Apple event parameters
keyAEDestStartPage ('dtpg')
keyAESourceDoc ('srdc')
keyAESourceStartPage ('stpg')
keyAENumPages ('nmpg')
keyAEMergeNotes ('mgnt')
scroll
Scrolls the view of a page by the specified amount.
Syntax
scroll [reference] X Amount [integer] Y Amount [integer]
Parameters
scroll
The PDF Window object in which to scroll the view.
X Amount
The amount to scroll in the horizontal direction, in pixels. Positive values move the view
to the right.
Y Amount
The amount to scroll in the vertical direction, in pixels. Positive values move the view down.
Adobe Acrobat SDK
Apple Event Objects and Apple Events
Interapplication Communication API Reference
select text
178
Related events
read page down
read page up
AppleScript example
scroll first PDFWindow X Amount 20 Y Amount 100
Apple event ID
kAEScroll ('scrl')
Apple event parameters
keyAEXDelta ('xdlt')
keyAEYDelta ('ydlt')
select text
Selects text as specified by either character or word offsets.
Syntax
select text [reference] from words [list of integer] from chars [list of
integer]
Parameters
select text
The PDF Window object in which to select text.
from words
The words to be selected. This consists of one or more pairs of word offsets
from the beginning of the document and word lengths (the number of
contiguous words).
from chars
Characters to be selected. This consists of one or more pairs of character
offsets from the beginning of the document and character lengths (the
number of contiguous characters).
Related events
clear selection
AppleScript example
repeat with i from 1 to 10
repeat with j from 1 to (10 - i)
select text from words {i, j}
end repeat
end repeat
Adobe Acrobat SDK
Apple Event Objects and Apple Events
Interapplication Communication API Reference
set info
Apple event ID
kAESetTextSelection ('stxs')
Apple event parameters
keyAEWordList ('fmwd')
keyAECharList ('fmch')
set info
Sets the value of a specified key in the document’s Info dictionary
Syntax
set info [reference] key [international text] value [international text]
Parameters
set info
The PDF Window in which to set the value of an Info dictionary entry.
key
The Info dictionary key whose value is to be set.
value
The value to be stored.
AppleScript example
set info document "PlugIns.pdf" key "Author"
value "Wolfgang Pauli"
Apple event ID
kAESetInfo ('snfo')
Apple event parameters
keyAEInfoKey ('inky')
keyAEInfoValue ('invl')
zoom
Changes the zoom level of the specified PDF Window.
Syntax
zoom [reference] to [small real]
179
Adobe Acrobat SDK
Apple Event Objects and Apple Events
Interapplication Communication API Reference
Miscellaneous events
Parameters
zoom
The PDF Window object to be zoomed.
to
The zoom factor specified as a percentage. For example, a value of 100
(100%) displays the document with a magnification of 1.0.
AppleScript example
zoom first PDFWindow to 150
Apple event ID
kAEZoomTo ('zmto')
Apple event parameters
keyAEZoomFactor ('zmft')
Miscellaneous events
Acrobat provides an Apple event that does not fall into one of the regular suites: do script
do script
Executes the specified JavaScript script.
Syntax
do script [international text] file [alias]
Parameters
do script
The JavaScript script to be executed.
file
File holding the JavaScript script to be executed.
Returns
Result of JavaScript execution as text.
AppleScript example
do script MyJavaScriptFile.js
180
4
Acrobat Catalog Plug-In
This chapter describes IAC support for the Acrobat Catalog plug-in, which allows you to create a full-text
index of a set of PDF documents. A full-text index is a searchable database of all the text in the documents.
After building an index, you can use the Acrobat Search command to search the entire library quickly.
Searches of full-text indexes created using Catalog are faster and more convenient than using the Find
command.
For more information on Catalog, see the Acrobat Help and the Acrobat and PDF Library API Reference.
Catalog Windows messages
Catalog broadcasts a set of Windows messages when certain operations occur. These messages are
broadcast whether the operations are initiated from the user interface, HFT methods, or DDE methods.
AcrobatCatalogBuildSuccess — On every successful build.
AcrobatCatalogBuildFail — On every failed build.
AcrobatCatalogBuildStopped — When a build has stopped.
Catalog DDE methods
Clients can connect to the Catalog plug-in through DDE using the service name Acrobat and the topic
name Control. This section lists the available DDE methods.
AppExit
Exits Acrobat Catalog.
Syntax
[AppExit()]
Returns
If true, Catalog exited successfully, otherwise false.
AppFront
Brings Catalog to the front.
Syntax
[AppExit()]
181
Adobe Acrobat SDK
Acrobat Catalog Plug-In
Interapplication Communication API Reference
FileBuild
Builds an index based on the specified index definition file.
Syntax
[FileBuild(char* fullPath)]
Parameters
fullPath
The full path of the file to be opened, including the .pdx extension.
Returns
If true, the file opened successfully, otherwise false.
FileOpen
Opens an index definition file and displays the Edit Index Definition dialog box.
Syntax
[FileOpen(char* fullPath)]
Parameters
fullPath
The full path of the file to be opened, including the .pdx extension.
Returns
true if the file opened successfully, otherwise false.
FilePurge
Purges an index definition file.
Syntax
[FilePurge(char* fullPath)]
Parameters
fullPath
The full path of the file to be purged, including the .pdx extension.
Returns
true if the file was successfully purged, otherwise false.
FileBuild
182
5
Acrobat Forms Plug-In
The Acrobat Forms plug-in allows a PDF document to act as a form; that is, the Acrobat equivalent of a
paper form with fields. This chapter describes the OLE automation methods exported by the Acrobat
AcroForm plug-in.
The Forms plug-in for Acrobat (versions 4.0 and above) allows users to author form fields. For
Adobe Reader, the Forms plug-in does not allow form authoring, but allows users to fill in data and print
Acrobat forms. The Adobe Reader Forms plug-in also does not allow users to save data to the local hard
disk. Both Acrobat and Adobe Reader allow Web designers to send data from the form back to a Web
server.
Note: Forms as used here do not refer to XObject forms as defined in the PDF Reference.
For more information on Forms, see the Acrobat Help and the Acrobat and PDF Library API Reference.
Forms plug-in OLE automation
The Acrobat Forms plug-in works as an automation server in the Windows environment. Because the
automation capabilities have been added to a plug-in, rather than an executable that can be directly
launched, the following steps are necessary to access them from an automation controller:
1. Instantiate the Acrobat application by using the Visual Basic CreateObject method. For example:
CreateObject("AcroExch.App")
This causes the Acrobat Forms plug-in to run, at which time it registers its class object with OLE.
2. Instantiate the main exposed object:
CreateObject("AFormAut.App")
Registration in the Windows registry (which is different from the class object registration described above)
happens every time Acrobat loads the plug-in. Therefore, you must run Acrobat at least once with the
AForm32.api file in the plug-ins folder before its type library can be found for object browsing within the
Microsoft Visual Studio environment. This is also necessary in order to allow early binding. Declare the
program variables as objects of the corresponding classes in AFORMAUTLib, and not simply as Object.
Note: Neither Acrobat nor the Acrobat Forms plug-in are thread-safe, and therefore Acrobat Forms OLE
automation uses the single-threading model.
Exceptions
All methods and properties may return an exception. These may include standard OLE exceptions, such as:
●
E_OUTOFMEMORY (0x8007000E)
●
E_INVALIDARG (0x80070057)
These exceptions are not specifically listed in the descriptions of the methods and properties that appear
in this chapter. Others are Acrobat Forms-specific, and are listed in the following table.
183
Adobe Acrobat SDK
Acrobat Forms Plug-In
Interapplication Communication API Reference
AFormApp
184
The actual numeric value of the returned exception is assembled as an HRESULT, uses the
FACILITY_ITF, and starts with decimal 512 (hex 0x0200), as recommended by Microsoft. For example,
the numeric value of the exception AutErcNoForm is 0x80040201. The important part is the right-most
(0x201), which is the first error in the enumeration below.
Exception name
Numeric
value
Description
AutErcNoDoc
1
No document is currently open in the Acrobat
application.
AutErcNotTerminal
2
This property or method applies to terminal fields or
their annotations.
AutErcNotToThisFieldType
3
This property or method is not applicable to this type
of field.
AFormApp
AFormApp is the only object the controller can externally instantiate (that is, using CreateObject). All
other objects must be created by navigating down the hierarchy with the methods and properties
described in this section.
Field
A field in the document that is currently active in Acrobat.
Methods
The Field object has the following methods.
●
PopulateListOrComboBox
●
SetBackgroundColor
●
SetBorderColor
●
SetButtonCaption
●
SetButtonIcon
●
SetExportValues
●
SetForegroundColor
●
SetJavaScriptAction
●
SetResetFormAction
●
SetSubmitFormAction
Adobe Acrobat SDK
Acrobat Forms Plug-In
Interapplication Communication API Reference
PopulateListOrComboBox
185
PopulateListOrComboBox
Specifies the item names and optionally exports values for a field of type listbox or combobox.
Syntax
void PopulateListOrComboBox ( const VARIANT& arrItems,
const VARIANT& arrExportVal);
Parameters
arrItems
An array of strings, with each element representing an item name.
There is a limit of 64K for string data in a combo or list box control on Windows
platforms. For Mac OS systems, the limit is 200 entries for the combo or list box
control. Using more than these limits degrades performance and makes the
control unusable.
arrExportVal
Optional. An array of strings, the same size as the first parameter, with each
element representing an export value.
Some of the elements in exportString may be empty strings.
Exceptions
Raises AutErcNotToThisFieldType if the field is not of type listbox or combobox.
Related methods
Add
SetBackgroundColor
Specifies the background color for a field. The background color is used to fill the field’s rectangle.
Syntax
void SetBackgroundColor (LPCTSTR bstrColorSpace, float GorRorC, float GorM,
float BorY, float K);
Parameters
bstrColorSpace
Values are defined by using a transparent, gray, RGB or CMYK color space.
Valid strings include:
●
T
●
G
●
RGB
●
CMYK
GorRorC
Used if bstrColorSpace is set to T, G, or RGB. A float range between zero and
one inclusive.
GorM
Used if bstrColorSpace is set to G. A float range between zero and one
inclusive.
Adobe Acrobat SDK
Acrobat Forms Plug-In
Interapplication Communication API Reference
SetBorderColor
BorY
Used if bstrColorSpace is set to RGB. A float range between zero and one
inclusive.
K
Used if bstrColorSpace is set to CMYK. A float range between zero and one
inclusive.
186
Related methods
SetBorderColor
SetForegroundColor
Example
Field.SetBackgroundColor "RGB", 0.7, 0.3, 0.6, 0
SetBorderColor
Specifies the border color for a field. The border color is used to stroke the field’s rectangle with a line as
large as the border width. The new border color is propagated to any child annotations underneath, so the
field may be non-terminal.
Syntax
void SetBorderColor (LPCTSTR bstrColorSpace, float GorRorC, float GorM, float
BorY, float K);
Parameters
bstrColorSpace
Values are defined by using a transparent, gray, RGB or CMYK color space.
Valid strings include:
●
T
●
G
●
RGB
●
CMYK
GorRorC
Used if bstrColorSpace is set to T, G, or RGB. A float range between zero and
one inclusive.
GorM
Used if bstrColorSpace is set to G. A float range between zero and one
inclusive.
BorY
Used if bstrColorSpace is set to RGB. A float range between zero and one
inclusive.
K
Used if bstrColorSpace is set to CMYK. A float range between zero and one
inclusive.
Related methods
SetBackgroundColor
SetForegroundColor
Adobe Acrobat SDK
Acrobat Forms Plug-In
Interapplication Communication API Reference
SetButtonCaption
187
Example
Field.SetBorderColor "RGB", 0.7, 0.3, 0.6, 0
SetButtonCaption
The caption to be used for the appearance of a field of type button.
Syntax
void SetButtonCaption (LPCTSTR bstrFace, LPCTSTR bstrCaption);
Parameters
bstrFace
A string that specifies the face for which the caption will be used. Valid strings
include:
N — Normal appearance
D — Down appearance
R — Appearance for rollover
bstrCaption
The caption for the button.
If a button’s layout is of type icon only, the caption is not used in generating its
appearance. In addition, only the Normal face is displayed, unless the
Highlight is of type push.
Exceptions
Raises AutErcNotToThisFieldType if the field is not of type button. The new appearance is
propagated to any child annotations underneath; the field may be non-terminal.
Related methods
SetButtonIcon
Example
Field.SetButtonCaption "D", "Submit Form"
SetButtonIcon
Specifies the icon to be used for the appearance of a field of type button.
Syntax
void SetButtonIcon (LPCTSTR bstrFace, LPCTSTR bstrFullPath, short pageNum);
Adobe Acrobat SDK
Acrobat Forms Plug-In
Interapplication Communication API Reference
SetExportValues
188
Parameters
bstrFace
A string that specifies the face for which the icon will be used. Valid strings
include:
N — Normal appearance
D — Down appearance
R — Appearance for rollover
bstrFullPath
The full path of the PDF file to be used as the source of the appearance.
pageNum
Used to select the page inside that PDF file (zero-based).
If a button’s layout is of type icon only, the caption is not used in generating its
appearance. In addition, only the Normal face is displayed, unless the
Highlight is of type push.
Exceptions
Raises AutErcNotToThisFieldType if the field is not of type button. The new appearance is
propagated to any child annotations underneath, so it is OK if the field is non-terminal.
Related methods
SetButtonCaption
Example
Field.SetButtonIcon "N", "c:\Clipart.pdf", 0
SetExportValues
Sets the export values for each of the annotations of a field of type radio button and checkbox.
For radio button fields, this is necessary to make the field work properly as a group. One button is checked
at any given time, giving its value to the field as a whole.
For checkbox fields, unless an export value is specified, the default is used when the field checked is Yes.
When it is unchecked, its value is Off (this is also true for a radio button field when none of its buttons are
checked).
Syntax
void SetExportValues (const VARIANT& arrExportVal);
Parameters
arrExportVal
An array of strings, which is expected to have as many elements as there are
annotations in the field. The elements of the array are distributed among the
individual annotations comprising the field, using their tab order.
Exceptions
Raises AutErcNotToThisFieldType if the field is not of type radio button or checkbox.
Adobe Acrobat SDK
Acrobat Forms Plug-In
Interapplication Communication API Reference
SetForegroundColor
189
Related methods
Add
Example
Dim arrExp(1) As String
arrExp(0) = "CreditCardA"
arrExp(1) = "CreditCardB"
Field.SetExportValues arrExp
SetForegroundColor
Specifies the foreground color for a field. It represents the text color for text, button, combobox, or listbox
fields and the check color for checkbox or radio button fields.
The parameters are similar to SetBorderColor and SetBackgroundColor, except that the
transparent color space is not allowed.
Syntax
void SetForegroundColor (LPCTSTR bstrColorSpace, float GorRorC, float GorM,
float BorY, float K);
Parameters
bstrColorSpace
Values are defined by using a transparent, gray, RGB or CMYK color space.
Valid strings include:
●
T
●
G
●
RGB
●
CMYK
GorRorC
Used if bstrColorSpace is set to T, G, or RGB. A float range between zero and
one inclusive.
GorM
Used if bstrColorSpace is set to G. A float range between zero and one
inclusive.
BorY
Used if bstrColorSpace is set to RGB. A float range between zero and one
inclusive.
K
Used if bstrColorSpace is set to CMYK. A float range between zero and one
inclusive.
Related methods
SetBackgroundColor
SetBorderColor
Example
Field.SetForegroundColor "CMYK", 0.25, 0.25, 0.25, 0.1
Adobe Acrobat SDK
Acrobat Forms Plug-In
Interapplication Communication API Reference
SetJavaScriptAction
190
SetJavaScriptAction
Sets the action of the field to be of type JavaScript. When using SetJavaScriptAction within
Visual Basic, you can use Chr(13) to add a <CR>, and Chr(9) for tabs, so that the function is well formatted.
Syntax
void SetJavaScriptAction (LPCTSTR bstrTrigger, LPCTSTR bstrTheScript);
Parameters
bstrTrigger
bstrTheScript
A string that specifies the trigger for the action. Valid strings include:
●
up
●
down
●
enter
●
exit
●
calculate
●
validate
●
format
●
keystroke
The script itself.
If the trigger is calculate, an entry is added at the end of the calculation order
array (see the CalcOrderIndex property).
Calculation script
A simple calculate script is supplied with Acrobat.
AFSimple_Calculate(cFunction, cFields)
●
cFunction is one of AVG, SUM, PRD, MIN, MAX
●
cFields is the list of the fields to use in the calculation.
Formatting scripts
The following scripts and formats can be used for the format and keystroke triggers:
AFDate_KeystrokeEx(cFormat)
AFDate_Format(cFormat)
cFormat is one of:
AFTime_Keystroke(ptf)
AFTime_Format(ptf)
ptf is the time format:
"m/d", "m/d/yy", "mm/dd/yy", "mm/yy", "d-mmm",
"d-mmm-yy", "dd-mmm-yy", "yy-mm-dd",
"mmm-yy", "mmmm-yy", "mmm d, yyyy", "mmmm
d, yyyy", "m/d/yy h:MM tt", "m/d/yy HH:MM"
0 = 24HR_MM [ 14:30 ]
1 = 12HR_MM [ 2:30 PM ]
2 = 24HR_MM_SS [ 14:30:15 ]
3 = 12HR_MM_SS [ 2:30:15 PM ]
Adobe Acrobat SDK
Acrobat Forms Plug-In
Interapplication Communication API Reference
SetResetFormAction
191
AFPercent_Keystroke(nDec, sepStyle)
AFPercent_Format(nDec, sepStyle)
nDec is the number of places after the decimal point.
AFSpecial_Keystroke(psf)
AFSpecial_Format(psf)
psf is the type of formatting to use:
AFNumber_Format(nDec, sepStyle,
negStyle, currStyle, strCurrency,
bCurrencyPrepend)
AFNumber_Keystroke(nDec, sepStyle,
negStyle, currStyle, strCurrency,
bCurrencyPrepend)
nDec is the number of places after the decimal point.
sepStyle is an integer denoting whether to use a
separator. If sepStyle is 0, use commas. If
sepStyle is 1, do not separate.
0 = zip code
1 = zip + 4
2 = phone
3 = SSN
sepStyle is an integer denoting whether to use a
separator. If sepStyle is 0, use commas. If
sepStyle is 1, do not separate.
sepStyle is the formatting used for negative
numbers:
0 = MinusBlack
1 = Red
2 = ParensBlack
3 = ParensRed
currStyle is the currency style - not used.
strCurrency is the currency symbol.
bCurrencyPrepend is true to prepend the
currency symbol; false to display on the end of the
number.
SetResetFormAction
Sets the action of the field to be of type ResetForm.
Syntax
void SetResetFormAction (LPCTSTR bstrTrigger, long theFlags,
const VARIANT& arrFields);
Parameters
bstrTrigger
A string that specifies which trigger is used for the action. Valid strings include:
up — Mouse up
down — Mouse down
enter — Mouse enter
exit — Mouse exit
theFlags
When 0 (Include), arrFields specifies which fields to include in the reset
operation. When non-zero (Exclude), arrFields specifies which fields to
exclude from the reset operation.
Adobe Acrobat SDK
Acrobat Forms Plug-In
Interapplication Communication API Reference
arrFields
SetSubmitFormAction
192
Optional. An array of strings for the fully-qualified names of the fields.
Depending on the value of theFlags, these fields are included in or excluded
from the reset operation.
When the fields are included, the set can include the names of non-terminal
fields, which is a fast and easy way to cause all their children to be included in
the action.
When not supplied, all fields are reset.
SetSubmitFormAction
Sets the action of the field to be of type SubmitForm.
Syntax
void SetSubmitFormAction (LPCTSTR bstrTrigger, LPCTSTR bstrTheURL,
long theFlags, const VARIANT& arrFields);
Parameters
bstrTrigger
A string that specifies which trigger is used for the action. Valid strings include:
up — Mouse up
down — Mouse down
enter — Mouse enter
exit — Mouse exit
bstrTheURL
A string containing the URL.
theFlags
A collection of flags that define various characteristics of the action.
See the PDF Reference to learn how the binary value of this long is interpreted.
arrFields
Optional. If specified, represents an array of strings for the fully-qualified names
of the fields to submit when the action is executed. If the array is interpreted as
fields to submit (as opposed to fields excluded from the submission, depending
on the least-significant bit in the flags), then it may include the names of
non-terminal fields, which is a way to cause all their children to be included in
the submission.
If not specified, the created action does not include a /Fields key.
Properties
The Field object has the following properties.
●
Alignment
●
BorderStyle
●
BorderWidth
●
ButtonLayout
●
CalcOrderIndex
●
CharLimit
Adobe Acrobat SDK
Acrobat Forms Plug-In
Interapplication Communication API Reference
●
DefaultValue
●
Editable
●
Highlight
●
IsHidden
●
IsMultiline
●
IsPassword
●
IsReadOnly
●
IsRequired
●
IsTerminal
●
Name
●
NoViewFlag
●
PrintFlag
●
Style
●
TextFont
●
TextSize
●
Type
●
Value
Alignment
Alignment
The text alignment of a text field. Valid alignments are:
left
center
right
Syntax
[get/set] String
Returns
If the field is terminal and has multiple child annotations, a get returns the alignment for the first child,
whichever annotation that happens to be.
On a set, the property is propagated to any child annotations underneath, so the field may be
non-terminal.
Exceptions
If the field is not of type text, an exception AutErcNotToThisFieldType is returned.
On a get, if the field is non-terminal, an exception AutErcNotTerminal is returned.
Example
Field.Alignment = left
193
Adobe Acrobat SDK
Interapplication Communication API Reference
Acrobat Forms Plug-In
BorderStyle
194
BorderStyle
The border style for a field. Valid border styles include solid, dashed, beveled, inset, and
underline.
Syntax
[get/set] String
Returns
If it is terminal and has multiple child annotations, a get returns the value of the border style for the first
child, whichever annotation that happens to be.
On a set, the property is propagated to any child annotations underneath, so the field may be
non-terminal.
Exceptions
On a get, raises AutErcNotTerminal if the field is non-terminal, an exception is returned.
Example
Field.BorderStyle = "beveled"
BorderWidth
The thickness of the border when stroking the perimeter of a field’s rectangle. If the border color is
transparent, this property has no effect except in the case of a beveled border. The value 0 represents no
border, and the value 3 represents a thick border.
Syntax
[get/set] short
Returns
If it is terminal and has multiple child annotations, a get returns the value of the border width for the first
child, whichever annotation that happens to be.
On a set, the property is propagated to any child annotations underneath, so the field may be
non-terminal.
Exceptions
On a get, if the field is non-terminal, an exception AutErcNotTerminal is returned.
Example
Field.BorderWidth = 1
Adobe Acrobat SDK
Interapplication Communication API Reference
Acrobat Forms Plug-In
ButtonLayout
195
ButtonLayout
The layout appearance of a button. Valid values include:
0 — Text only; the button has a caption but no icon.
1 — Icon only; the button has an icon but no caption.
2 — Icon over text; the icon should appear on top of the caption.
3 — Text over icon; the text should appear on top of the icon.
4 — Icon then text; the icon should appear to the left of the caption.
5 — Text then icon; the icon should appear to the right of the caption.
6 — Text over icon; the text should be overlaid on top of the icon.
If it is terminal and has multiple child annotations, a get returns the layout for the first child, whichever
annotation that happens to be.
On a set, the property is propagated to any child annotations underneath, therefore the field can be
non-terminal.
Syntax
[get/set] short
Exceptions
If the field is not of type button, an exception AutErcNotToThisFieldType is returned.
On a get, if the field is non-terminal, an exception AutErcNotTerminal is returned.
Example
Field.ButtonLayout = 2
CalcOrderIndex
The zero-based calculation order of fields in the document. If you want the calculation for a field f2 to be
performed after that for field f1, you need only set the CalcOrderIndex for f2 to f1’s
CalcOrderIndex + 1. The elements in the calculation order array are shifted to make room for the
insertion, but the first calculation is still at index 0.
For more information, see the JavaScript for Acrobat API Reference.
Syntax
[get/set] short
Example
Set F1 = Fields("SubTotal")
Set F2 = Fields("Total")
F2.CalcOrderIndex = F1.CalcOrderIndex + 1
Adobe Acrobat SDK
Acrobat Forms Plug-In
Interapplication Communication API Reference
CharLimit
CharLimit
The limit on the number of characters that a user can type into a text field.
On a set, the property is propagated to any child annotations underneath, if any.
Syntax
[get/set] short
Exceptions
If the field is not of type text, an exception AutErcNotToThisFieldType is returned.
DefaultValue
The default value of the field. It returns the empty string if the field has no default value. If the field is
non-terminal, an exception AutErcNotTerminal is returned.
Syntax
[get/set] String
See also
Value
Editable
Determines whether the user can type in a selection or must choose one of the provided selections.
Comboboxes can be editable; that is, the user can type in a selection.
On a set, the property is propagated to any child annotations underneath, if any.
Syntax
[get/set] Boolean
Exceptions
Returns an exception of AutErcNotToThisFieldType if the field is not of type combobox.
Example
Field.Editable = False
196
Adobe Acrobat SDK
Acrobat Forms Plug-In
Interapplication Communication API Reference
Highlight
197
Highlight
Defines how a button reacts when a user clicks it. The four highlight modes supported are:
●
none
●
invert
●
push
●
outline
If it is terminal and has multiple child annotations, a get returns the highlight for the first child, whichever
annotation that happens to be.
On a set, the property is propagated to any child annotations underneath, so the field may be
non-terminal.
Syntax
[get/set] String
Exceptions
If the field is not of type button, an exception AutErcNotToThisFieldType is returned.
On a get, if the field is non-terminal, an exception AutErcNotTerminal is returned.
Example
Field.Highlight = "invert"
IsHidden
Determines whether the field is hidden or visible to the user. If the value is true the field is invisible, and
false indicates that the field is visible.
During get operations, if the field is non-terminal, an exception AutErcNotTerminal is returned. If it is
terminal, and has multiple child annotations, a get returns the value of the hidden flag for the first child,
whichever annotation that happens to be.
During set operations, the property is propagated to any child annotations underneath, therefore a field
can be non-terminal.
Syntax
[get/set] Boolean
Example
'Hide "name.last"
Set Field = Fields("name.last")
Field.IsHidden = True
Adobe Acrobat SDK
Acrobat Forms Plug-In
Interapplication Communication API Reference
IsMultiline
198
IsMultiline
Determines whether the text field is multi-line or single-line. On a set, the property is propagated to any
child annotations underneath, if any.
Syntax
[get/set] Boolean
Exceptions
If the field is not of type text, an exception AutErcNotToThisFieldType is returned.
Example
Field.IsMultiline = True
IsPassword
Determines whether the field will display asterisks for the data entered. Upon submission, the actual data
entered is sent. Fields that have the password attribute set will not have the data in the field saved when
the document is saved to disk.
On a set, the property is propagated to any child annotations underneath, if any.
Syntax
[get/set] Boolean
Exceptions
If the field is not of type text, an exception AutErcNotToThisFieldType is returned.
Example
Field.IsPassword = True
IsReadOnly
The read-only characteristic of a field. When a field is read-only, the user can see the field but cannot
change it. If a button is read-only, the user cannot click it to execute an action.
Because this is a field flag and not an annotation flag, both a get and a set of this property are allowed
regardless of whether the field is terminal or non-terminal.
●
A get on a non-terminal field retrieves that field’s flag.
●
A set changes the flag on all its terminal children.
Syntax
[get/set] Boolean
Adobe Acrobat SDK
Interapplication Communication API Reference
Acrobat Forms Plug-In
IsRequired
199
IsRequired
The required characteristic of a field. When a field is required, its value must be non-NULL when the user
clicks a submit button that causes the value of the field to be sent to the web. If the field value is NULL, the
user receives a warning message and the submit does not occur.
Since this is a field flag and not an annotation flag, both a get and a set of this property are allowed,
regardless of whether the field is terminal or non-terminal.
A get on a non-terminal field retrieves that field’s flag. A set changes the flag on all its terminal children.
Syntax
[get/set] Boolean
IsTerminal
true if the field is terminal, otherwise false.
Syntax
[read-only] Boolean
Example
Dim Field As AFORMAUTLib.Field
Dim bTerminal As Boolean
'bTerminal should be True
bTerminal = Field.IsTerminal
Name
The fully qualified name of the field. It is the default member of the Field interface.
Syntax
[read-only] String
NoViewFlag
Determines whether a given field prints but does not display on the screen.
Set the NoViewFlag property to true to allow the field to appear when the user prints the document
but not when it displays on the screen; set it to false to allow both printing and displaying.
On a get, if the field is non-terminal, an exception AutErcNotTerminal is returned. If it is terminal, and
has multiple child annotations, a get returns the value of the no-view flag for the first child, whichever
annotation that happens to be.
On a set, the property is propagated to any child annotations underneath, so the field may be
non-terminal.
Syntax
[get/set] Boolean
Adobe Acrobat SDK
Interapplication Communication API Reference
Acrobat Forms Plug-In
PrintFlag
200
PrintFlag
Determines whether a field prints. Set the PrintFlag property to true to allow the field to appear when
the user prints the document, set it to false to prevent printing.
On a get, if the field is non-terminal, an exception AutErcNotTerminal is returned. If it is terminal, and
has multiple child annotations, a get returns the value of the print flag for the first child, whichever
annotation that happens to be.
On a set, the property is propagated to any child annotations underneath, so the field may be
non-terminal.
Syntax
[get/set] Boolean
Style
The style of a checkbox or a radio button (the glyph used to indicate that the check box or radio button
has been selected).
Valid styles include:
check
cross
diamond
circle
star
square
If it is terminal and has multiple child annotations, a get returns the style for the first child, whichever
annotation that happens to be.
On a set, the property is propagated to any child annotations underneath, therefore a field can be
non-terminal.
Syntax
[get/set] String
Exceptions
During set, if the field is not of type checkbox or radio button, an exception
AutErcNotToThisFieldType is returned.
On a get, if the field is non-terminal, an exception AutErcNotTerminal is returned.
Example
Field.Style = "star"
Adobe Acrobat SDK
Interapplication Communication API Reference
Acrobat Forms Plug-In
TextFont
201
TextFont
The text font used when laying out the field. Valid fonts include:
Courier
Courier-Bold
Courier-Oblique
Courier-BoldOblique
Helvetica
Helvetica-Bold
Helvetica-Oblique
Helvetica-BoldOblique
Symbol
Times-Roman
Times-Bold
Times-Italic
Times-BoldItalic
ZapfDingbats
On a set, the property is propagated to any child annotations underneath, if any.
Syntax
[get/set] String
Example
Field.TextFont = "Times-BoldItalic"
TextSize
The text points size used in the field. In combobox and radio button fields, the text size determines the size
of the check. Valid text sizes include zero and the range from 4 to 144 inclusive.
A text size of zero means that the largest point size that can still fit in the field’s rectangle should be used.
In multi-line text fields and buttons this is always 12 points.
On a set, the property is propagated to any child annotations underneath, if any.
Syntax
[get/set] short
Example
Field.TextSize = 18
Type
The type of the field as a string. Valid types that are returned:
text
button
combobox
listbox
checkbox
radiobutton
signature
Adobe Acrobat SDK
Interapplication Communication API Reference
Acrobat Forms Plug-In
Value
202
Syntax
[read-only] String
Example
Set Field = Fields("name.last")
'Should print "name.last"
print Field
' Should print the type of field. Example,
' "text"
print Field.Type
Value
A string that represents the value of the field. Returns the empty string if the field has no value. If the field
is non-terminal, an exception AutErcNotTerminal is returned.
For fields of type checkbox, the value Off represents the unchecked state. The checked state is
represented using the export value. This is also true for radio buttons (where each individual button in a
group should have a different export value; see SetExportValues on page 188). For fields of type
listbox or combobox, if an export value is defined, then that represents the value, otherwise the item name
is used.
These remarks apply also to DefaultValue.
Syntax
[get/set] String
Example
Dim arrExp(1) As String
arrExp(0) = "CreditCardV"
arrExp(1) = "CreditCardM"
Field.SetExportValues arrExp
Field.Value = arrExp(0)
Fields
A collection of all the fields in the document that are currently active in Acrobat at the time Fields is
instantiated.
The Fields collection includes both terminal and non-terminal fields. A terminal field is one that either
does not have children, or if it does, they are simply multiple appearances (that is, child annotations) of the
field in question.
Note: If you instantiate a Fields object, and subsequently fields are manually added or removed using
the Forms tool in Acrobat, the Fields object will no longer be in sync with the document. You
must re-instantiate the Fields object.
Adobe Acrobat SDK
Acrobat Forms Plug-In
Interapplication Communication API Reference
Methods
203
Methods
The Fields object has the following methods.
●
Add
●
AddDocJavascript
●
ExecuteThisJavascript
●
ExportAsFDF
●
ExportAsHtml
●
ImportAnFDF
●
Remove
Add
Dynamically adds a new field to the Acrobat form and to the Fields collection.
Returns the newly-created Field object. You can pass the name of an existing field as a parameter, as
long as that field is of the same type as the one being created.
This is useful in the following circumstances:
●
For radio buttons to use the SetExportValues method to make the radio buttons mutually
exclusive.
●
For fields that should have multiple appearances (that is, child annotations) in the document.
Syntax
LPDISPATCH Add (LPCTSTR bstrFieldName, LPCTSTR bstrFieldType, short pageNum,
float left, float top, float right, float bottom);
Parameters
bstrFieldName
The fully-qualified name of the field.
bstrFieldType
Field type for the newly created field. Valid types are:
●
text
●
button
●
combobox
●
listbox
●
checkbox
●
radio button
●
signature
You must use the quotation marks. See the sample code below.
When creating list or combo boxes, there is a limit of 64K for string data on
Windows platforms. Mac OS systems have a limit of 200 entries for the list or
combo boxes. Using more than the limit degrades performance. You populate
the fields of the list and combo boxes using the PopulateListOrComboBox
method.
Adobe Acrobat SDK
Acrobat Forms Plug-In
Interapplication Communication API Reference
AddDocJavascript
204
pageNum
The page number (zero-based).
left, top, right,
bottom
These parameters are floats representing the left, top, right, and bottom
coordinates of the field rectangle, measured in rotated page space; that is, [0,0]
is always at the left bottom corner regardless of page rotation.
Returns
The newly-created Field object.
Related methods
PopulateListOrComboBox
Remove
Example
Set Field = Fields.Add("payment",_ "radiobutton", 0, 100, 600, 130, 570)
AddDocJavascript
Adds a document-level JavaScript function to the PDF file. When using AddDocJavascript, within
Visual Basic, you can use Chr(13) to add a <CR>, and Chr(9) for tabs, so that the function is well
formatted.
Syntax
void AddDocJavascript (LPCTSTR bstrScriptName, LPCTSTR bstrTheScript);
Parameters
bstrScriptName
The name of the function to be added to the document.
bstrTheScript
The definition to be added to the document.
Related methods
ExecuteThisJavascript
Example
'Adding a document-level JavaScript
'function, to compute factorials:
Fields.AddDocJavaScript "Fact", _
"function Fact(n)" & Chr(13) & _
"{" & Chr(13) & _
Chr(9) & "if (n <= 0)" & Chr(13) & _
Chr(9) & Chr(9) & "return 1;" & Chr(13) & _
Chr(9) & "else" & Chr(13) & _
Chr(9) & Chr(9) & "return n * Fact(n - 1);" & Chr(13) & _
"}"
Adobe Acrobat SDK
Acrobat Forms Plug-In
Interapplication Communication API Reference
ExecuteThisJavascript
205
ExecuteThisJavascript
Executes the specified JavaScript script.
Syntax
CString ExecuteThisJavascript (LPCTSTR bstrTheScript);
Parameters
bstrTheScript
A string containing a JavaScript script, which is executed by Acrobat in the
context of the currently active document.
See the JavaScript for Acrobat API Reference for information on event level
values.
Returns
Returns a result by assigning it to event value.
Related methods
AddDocJavascript
Example
Fields.ExecuteThisJavaScript "var f =_ this.getField(""myButton""); f.delay =_
false;"
To get the returns in Visual Basic:
Dim cSubmitName As String
cSubmitName = Fields.ExecuteThisJavaScript
"event.value = this.getField(""myField"").submitName;"
ExportAsFDF
Exports the data as FDF from an Acrobat form.
Syntax
void ExportAsFDF (LPCTSTR bstrFullPath, LPCTSTR bstrSubmitButton,
BOOL bEmptyFields, const VARIANT& arrFields);
Parameters
bstrFullPath
A full path of the file to which the produced FDF file will be saved.
bstrSubmitButton
The name of an existing form field of type button (in case you want to
include it in the FDF file, as if it had been used to trigger a SubmitForm
action). You can specify an empty string.
Adobe Acrobat SDK
Acrobat Forms Plug-In
Interapplication Communication API Reference
ExportAsHtml
206
bEmptyFields
A Boolean value to indicate whether fields with no value should be
included in the produced FDF file.
arrFields
Optional. An array of strings representing the fully-qualified names of the
fields to include in the FDF file. This array may include the names of
non-terminal fields, which is a fast and easy way to cause all their children
to be included in the FDF file.
Related methods
ImportAnFDF
ExportAsHtml
Example
Dim arrFields(1) As String
arrFields(0) = "name"
arrFields(1) = "address"
'This will create an FDF that includes
'name.last, name.first, address.street,
'etc., but only if they have a value
'(since we are passing False for the
' "bEmptyFields" parameter.
Fields.ExportAsFDF "C:\Temp\out.fdf", "", False, arrFields
ExportAsHtml
Exports the data as HTML from an Acrobat form. This method is similar to ExportAsFDF. The only
difference is that the form data is exported in URL-encoded format.
Syntax
void ExportAsHtml (LPCTSTR bstrFullPath, LPCTSTR bstrSubmitButton,
BOOL bEmptyFields, const VARIANT& arrFields);
Parameters
bstrFullPath
A full path of the file to which the produced FDF file will be saved.
bstrSubmitButton
The name of an existing form field of type button (in case you want to
include it in the FDF file, as if it had been used to trigger a SubmitForm
action). You may pass an empty string.
bEmptyFields
A Boolean to indicate whether fields with no value should be included in
the produced FDF file.
arrFields
Optional. An array of strings representing the fully-qualified names of the
fields to include in the FDF file. This array may include the names of
non-terminal fields, which is a fast and easy way to cause all their children
to be included in the FDF file.
Related methods
ExportAsFDF
Adobe Acrobat SDK
Acrobat Forms Plug-In
Interapplication Communication API Reference
ImportAnFDF
207
ImportAnFDF
Imports the FDF file into an Acrobat form.
Syntax
void ImportAnFDF (LPCTSTR bstrFullPath);
Parameters
bstrFullPath
The full path of the file containing the FDF file to be imported.
Related methods
ExportAsFDF
Remove
Removes a field from the Acrobat Form and from the Fields collection.
Syntax
void Remove (LPCTSTR bstrFieldName);
Parameters
bstrFieldName
The fully-qualified name of the field to be removed from the Acrobat form. If the
field has multiple child annotations, all of them are removed. If multiple fields
have the same name, all are removed.
Related methods
Add
Example
'Remove fields you no longer used.
Fields.Remove("MyOldField")
Properties
The Fields object has the following properties.
●
Count
●
Item
●
_NewEnum
Count
The number of items in the collection.
Syntax
[read-only] long
Adobe Acrobat SDK
Acrobat Forms Plug-In
Interapplication Communication API Reference
Item
208
Example
Dim Field As AFORMAUTLib.Field
Dim nFields As Long
nFields = Fields.Count
For Each Field In Fields
If Field.IsTerminal Then
print Field.Value
End If
Next Field
Item
Takes the fully qualified name of the field (for example, “name.last”) as a parameter, and returns the
Field object for it. It is the default member of the Fields interface. That is, item is the property invoked
if the object name is specified by itself without a property or a method in the controller script.
Syntax
[read-only] IDispatch*
Example
Dim Field As AFORMAUTLib.Field
Dim nFields As Long
Set Field = Fields.Item("name.last")
'Since Item is the default_ property:
Set Field = Fields("name.last")
_NewEnum
The IEnumVariant enumerator for the collection.
You do not need to call this property directly. Visual Basic calls it in the background whenever the code
contains a For Each Field In Fields loop. For example:
For Each Field in Fields
If Field.IsTerminal
print Field.Value
End If
Next Field
Syntax
[read-only] IUnknown*
6
Acrobat Search Plug-in
This chapter describes IAC support for the Acrobat Search plug-in, which allows users to perform text
searches in PDF documents. It adds menus, menu items, toolbar buttons, and a Search panel to the
Acrobat application. The Search plug-in exports a host function table (HFT) containing several methods
that can be used by other plug-ins.
Search supports interapplication communication in the form of DDE messages in Windows and Apple
events in Mac OS. These messages and events allow remote clients to submit search queries and
manipulate a list of indexes (the list of indexes is referred to as the shelf ).
For more information on the Search plug-in, see the Acrobat Help and the Acrobat and PDF Library API
Reference.
Search plug-in using DDE
A client can connect to the Search plug-in with DDE using the service name "Acrobat Search" and the
topic name "Acrobat Search".
DdeInitialize(&id, &DDE_ProcessMessage, APPCMD_CLIENTONLY, 0);
hszServerName = DdeCreateStringHandle(id, "Acrobat Search", 0);
hszTopicName = DdeCreateStringHandle(id, "Acrobat Search", 0);
hConv = DdeConnect(id, hszServerName, hszTopicName, NULL);
After a connection has been made, a single poke transaction will submit a search query. Two types of
queries are supported: simple query and query.
Simple query item
A simple query has the item name “SimpleQuery”. When using a simple query, pass only a string that
contains the query, using the ASQL query parser’s format (see QLangType_CQL in the table “Query
language type constants” on page 211). It is not possible to choose another parser or to set word options
using the simple query item.
Query item
A query has the item name “Query ”. When using query, a QueryData structure is used. This structure
contains the query, as well as specifying the query parser to use and additional options.
hszItemName = DdeCreateStringHandle(id, "Query", 0);
DdeClientTransaction(qd, nLen, hConv, hszItemName, CF_TEXT, XTYP_POKE,
1000, &dwResult);
DdeDisconnect(hConv)
209
Adobe Acrobat SDK
Acrobat Search Plug-in
Interapplication Communication API Reference
Query item
210
The global data handle (qd) passed to the server must be in the following format:
typedef struct _QueryData {
eQLangType qlt;
boolean bOverrideWordOptions;
uns32 nWordOptions;
uns16 nMaxDocs;
uns16 nQueryOffset;
uns16 nNumSorts; //deprecated in Acrobat 6.0
uns16 nSortOffset[QP_MAX_SORT_FIELDS]; //deprecated in Acrobat 6.0
boolean bSortWays[QP_MAX_SORT_FIELDS]; //deprecated in Acrobat 6.0
unsigned char cData[1];
} QueryData;
Query options
qlt
The query language type. Must be one of the values shown in “Query
language type constants” on page 211.
bOverrideWordOptions
Indicates that the client wishes to use different word options than those
currently set by the user.
nWordOptions
The word options. Must be an OR of the values shown in “Word option
bit-flag constants” on page 211.
nMaxDocs
If non-zero, the client wishes to use a different limit for the maximum
number of documents than the limit currently set by the user.
nSortOffsets
A list of offsets into the cData chunk. Each offset points to a
NULL-terminated string containing the field name.
This value has no effect in Acrobat 6.0 or later, because sort options are
not valid.
nQueryOffset
An offset into the cData chunk that points to a NULL-terminated string
containing the query to execute.
nNumSorts
The number of fields in the sort spec. If this number is 0, the plug-in
uses the current sort spec set by the user.
This value has no effect in Acrobat 6.0 or later, because sort options are
not valid.
bSortWays
A list of sort order flags, one for each sort field. true indicates an
ascending sort, and false indicates a descending sort.
This value has no effect in Acrobat 6.0 or later, because sort options are
not valid.
Adobe Acrobat SDK
Acrobat Search Plug-in
Interapplication Communication API Reference
Query item
211
Query language type constants
Allows only simple phrase searches; does not allow Boolean searching.
QLangType_Simple
This query type does not work in the DDE interface of the Search
plug-in shipped with version 2.0 of Acrobat.
QLangType_CQL
Allows Boolean searches using AND, OR, and NOT, as described in the
Acrobat Search plug-in’s online help file.
QLangType_Passthrough
The Verity BooleanPlus query language. Contact Verity for further
information on this language.
Word option bit-flag constants
QPON_Case
The search is case-sensitive.
QPON_Stemming
Find not only the specified word, but other words that have the same stem. For
example, run and ran have the same stem.
QPON_SoundsLike
Find not only the specified word, but other words that sound like it.
QPON_Thesaurus
Find not only the specified word, but other words that have the same meaning.
QPON_Proximity
Consider the proximity of results when using the AND operator to look for more
than one word in a document. Without this option, AND terms can be anywhere
in a document. Searching for “red” and “blue,” for example, finds a document
where “red” is the first word on the first page and where “blue” is the last word
on the last page. With this option, however, AND terms must be within two or
three pages of each other to be found. Also, the closer AND terms appear
together, the higher the relevance ranking of the document that contains
them.
QPON_Refine
Do not search the entire list of indexes, but only the documents that matched
the previous search. This is used to refine the results of the previous search.
To create and populate this structure correctly, the client must know the sum of the lengths of each sort
field (sls), the length of the query (lq), and the size of the QueryData structure. The client then allocates
memory as follows:
nSize = sizeof(QueryData) + sls + lq;
qd = (QueryData *)malloc(nSize);
For example, if the query was “Adobe” and the sort spec was “Title” ascending and “Score” descending
then the structure would be packed as follows:
memset(qd, 0, nSize);
qd->nQueryOffset = 0;
strcpy(&cData[0], "Adobe");
qd->nNumSort = 2;
qd->nSortOffset[0] = strlen("Adobe") + 1;
qd->bSortWays[0] = TRUE;
strcpy(&cData[qd->nSortOffset[0]], "Title");
qd->bSortWays[1] = FALSE;
qd->nSortOffset[1] = qd->nSortOffset[0] + strlen("Title") + 1;
strcpy(&cData[qd->nSortOffset[1]], "Score");
Adobe Acrobat SDK
Acrobat Search Plug-in
Interapplication Communication API Reference
Manipulating indexes through DDE
212
Manipulating indexes through DDE
After a connection has been made, a single poke transaction can add, delete, add, or remove indexes. The
item name to use is “Index”.
hszItemName = DdeCreateStringHandle(id, "Index", 0);
DdeClientTransaction(qd, nLen, hConv, hszItemName, CF_TEXT, XTYP_POKE,
1000, &dwResult);
DdeDisconnect(hConv);
The global data handle (gd) passed to the server must be in the following format:
typedef struct _IndexData {
IndexActionType eAction;
int16 nIndexOffset;
int16 nTempNameOffset;
unsigned char cData[1];
} IndexData;
Options
eAction
The operation to be performed on the index. Must be one of values
listed in “Index operation selectors” on page 212.
nIndexOffset
An offset into the cData chunk that points to a NULL-terminated string
containing the PDX file representing the index.
nTempNameOffset
An offset into cData. It points to a temporary name that is displayed by
the Search plug-in when the index is unavailable. This field must specify
an offset either to an empty string (\0) or to a non-empty C string.
Index operation selectors
IndexAction_Add
Adds an index to the shelf.
IndexAction_Remove
Removes an index from the shelf.
IndexAction_Enable
Enables an index on the shelf.
IndexAction_Disable
Disables an index on the shelf.
To create and populate this structure correctly, the client must know the sum of the lengths of the Index (li)
and Temp names (lt) (including NULL-terminating characters), and the size of the IndexData structure.
The client then allocates memory as follows:
nSize = sizeof(IndexData) + li + lt;
id = (IndexData *)malloc(nSize);
For example, to add the index C:\FOO.PDX to the Search plug-in’s shelf:
memset(id, 0, nSize);
id->eAction = IndexAction_Add;
id->nIndexOffset = 0;
strcpy(&id->cData[0], "C:\\FOO.PDX");
id->nTempNameOffset = strlen("C:\\FOO.PDX") + 1;
strcpy(&id->cData[id->nTempNameOffset],
"My Favorite Index");
Adobe Acrobat SDK
Acrobat Search Plug-in
Interapplication Communication API Reference
Search plug-in using Apple events
Search plug-in using Apple events
The Search plug-in supports the Apple events described in this section.
SearchAddIndex
Adds a specified index to the shelf.
Apple event ID
kSearchAddIndex ('addx')
Parameters
kIndexListTag ('SilP'),
typeLongInteger
An opaque void* representing the shelf, obtained from
SearchGetIndexList.
kPathTag ('Path'),
typeChar
Mac OS full path representing an index, of the form:
kFlagTag ('Flag'),
typeLongInteger
Index flags. See SearchGetIndexFlags on page 216 for a
description. The kIndexAvailable flag should always be set.
MyDisk:TopFolder:BottomFolder:Strange.pdx
Returns
kIndexTag ('SixP'), typeLongInteger
An opaque void* representing an index. Returns NULL if failure.
Returns
#define kIndexExists ((SearchIndexPtr)-1)
if the index already exists in the index list. If the index already exists, you can retrieve it using
SearchGetIndexByPath on page 215.
SearchCountIndexList
Gets the number of indexes currently on the shelf.
Apple event ID
kSearchCountIndexList ('cidx')
Parameters
kIndexListTag ('SilP'),
typeLongInteger
An opaque void* representing the shelf, obtained from
SearchGetIndexList.
213
Adobe Acrobat SDK
Acrobat Search Plug-in
Interapplication Communication API Reference
SearchDoQuery
214
Returns
kIndexListTag ('SilP'), typeLongInteger
Number of indexes on the shelf (kIndexListTag here is not semantically correct, but works).
SearchDoQuery
Executes a specified query, using the set of indexes currently on the shelf. The search results are displayed
in the Acrobat Search plug-in’s Results window.
Apple event ID
kSearchDoQuery ('kwry')
Parameters
kQueryStringTag ('Quryv),
typeChar
The query string, a NULL-terminated block of text. Its format is the
same as what a user would type into the search Query window, and
depends on the search language specified by kParserTag.
kParserTag ('Prsr'),
typeShortInteger
The query parser to use; may be one of (see SrchType.h):
kParserSimple 0 — Allows only simple phrase searches; does
not allow Boolean searching.
kParserCQL 1 — Allows Boolean searches using AND, OR, and
NOT, as described in the Acrobat Search plug-in’s online help file.
kParserBPlus 2 — The Verity BooleanPlus query language.
Contact Verity for further information on this language.
kSortSpecTag ('Sort'),
typeAEList
A list of C strings representing fields to sort by. The first element is
the first level sort, the second is the second level sort, and so forth.
Each string may be any field that appears in the index, plus Score
(which sorts results by relevance ranking). Some common fields are
Title, ModificationDate, CreationDate, and Keywords.
kWordOptionsTag ('WOpt'),
typeLongInteger
A bit field of word options. Must be a logical OR of the values listed
below in “Word options for Apple events” on page 215.
The manner in which the options are used depends on the value
associated with kOptionsOverrideTag.
kOptionsOverrideTag
('WOer'),
typeShortInteger
Flag that indicates whether the word options are OR’ed with the
search options set in the user interface, or used instead of them. If 0,
the word options are OR’ed with the user interface search options,
and the resulting value is used. If non-zero, the word options are
used instead of the user interface search options.
kMaxDocsTag ('MaxD'),
typeShortInteger
The maximum number of documents to display in the Results
window. If more documents than this have hits, only the first
maxDocs are displayed. maxDocs cannot be greater than 999.
Adobe Acrobat SDK
Acrobat Search Plug-in
Interapplication Communication API Reference
SearchGetIndexByPath
215
Word options for Apple events
kWordOptionCase
The search is case-sensitive.
kWordOptionStemming
Find not only the specified word, but other words that have the
same stem (for example, run and ran have the same stem).
kWordOptionSoundsLike
Find not only the specified word, but other words that sound like it.
kWordOptionThesaurus
Find not only the specified word, but other words that have the
same meaning.
kWordOptionProximity
Consider the proximity of results when using the AND operator to
look for more than one word in a document. Without
kWordOptionProximity, AND terms can be anywhere in a
document. Searching for “red” and “blue,” for example, finds a
document where “red” is the first word on the first page and where
“blue” is the last word on the last page. With
kWordOptionProximity, however, AND terms must be within
two or three pages of each other to be found. Also, with
kWordOptionProximity, the closer AND terms appear together,
the higher the relevance ranking of the document that contains
them.
kWordOptionRefine
Do not search the entire list of indexes, but only the documents that
matched the previous search. This is used to refine the results of the
previous search.
SearchGetIndexByPath
Gets the index that has the specified path. The index must already be on the shelf. The index can be passed
to other Search Apple events to remove it from the shelf, obtain its title, and so forth.
Apple event ID
kSearchGetIndexByPath ('fpdx')
Parameters
kIndexListTag ('SilP'),
typeLongInteger
An opaque void* representing the shelf, obtained from
SearchGetIndexList.
kPathTag ('Path'),
typeChar
Mac OS full path representing an index, of the form:
MyDisk:TopFolder:BottomFolder:Strange.pdx
Returns
kIndexTag ('SixP'), typeLongInteger
An opaque void* representing an index. Returns NULL if the specified index is gone.
Adobe Acrobat SDK
Acrobat Search Plug-in
Interapplication Communication API Reference
SearchGetIndexFlags
216
SearchGetIndexFlags
Get the flags for an index.
Apple event ID
kSearchGetIndexFlags ('gfdx')
Parameters
kIndexTag ('SixP'),
typeLongInteger
An opaque void* representing an index.
Returns
kFlagTag ('Flag'), typeLongInteger
A logical OR of the following:
kIndexAvailableFlag (1L << 0) — Set if the index is available for searching.
kIndexSelectedFlag (1L << 1) — Set if the index appears with a check mark in the Search
plug-in’s user interface.
kIndexPtrInvalidFlag (1L << 31) — Set if the index is not valid or is no longer valid.
SearchGetIndexList
Gets a list of the indexes currently on the shelf.
Apple event ID
kSearchGetIndexList ('gidx')
Returns
kIndexListTag ('SilP'), typeLongInteger
An opaque void* representing the list of indexes currently on the shelf. This value can subsequently be
used by other search Apple events to obtain information about a specific index, the number of indexes on
the shelf, and so forth.
SearchGetIndexPath
Gets the full path to an index.
Apple event ID
kSearchGetIndexPath ('gpdx')
Adobe Acrobat SDK
Acrobat Search Plug-in
Interapplication Communication API Reference
SearchGetIndexTitle
217
Parameters
kIndexTag ('SixP'),
typeLongInteger
An opaque void* representing the index whose path is to be
obtained. The index may be obtained using
SearchGetIndexByPath, SearchGetNthIndex, or
SearchAddIndex.
Returns
kPathTag ('Path'), typeChar
A NULL-terminated character string representing the full path of the index. Returns an empty string if the
requested index is not valid.
SearchGetIndexTitle
Gets the title of an index.
Apple event ID
kSearchGetIndexTitle ('gtdx')
Parameters
kIndexTag ('SixP'),
typeLongInteger
An opaque void* representing the index whose title is to be
obtained. The index may be obtained using
SearchGetIndexByPath, SearchGetNthIndex, or
SearchAddIndex.
Returns
kTitleTag ('Title'), typeChar
A NULL-terminated character string representing the title of the index. If there is no title, it returns the
index's path. Returns an empty string if the requested index is not valid.
SearchGetNthIndex
Gets the nth index on the shelf. The index can be passed to other Search Apple events to remove it from the
shelf, obtain its title, and so forth.
Apple event ID
kSearchGetNthIndex ('fndx')
Adobe Acrobat SDK
Acrobat Search Plug-in
Interapplication Communication API Reference
SearchRemoveIndex
218
Parameters
kIndexListTag ('SilP'),
typeLongInteger
An opaque void* representing the shelf, obtained from
SearchGetIndexList.
kNthIndexTag ('Enth'),
typeLongInteger
The index to get. The first index on the shelf is index zero.
Returns
kIndexTag ('SixP'), typeLongInteger
An opaque void* representing an index. Returns NULL if the nth index is gone.
SearchRemoveIndex
Removes the specified index from the shelf.
Apple event ID
kSearchRemoveIndex ('rmdx')
Parameters
kIndexListTag ('SilP'),
typeLongInteger
An opaque void* representing the shelf, obtained from
SearchGetIndexList.
kIndexTag ('SixP'),
typeLongInteger
An opaque void* representing the index to be removed. The index
may be obtained using SearchGetIndexByPath,
SearchGetNthIndex, or SearchAddIndex.
SearchSetIndexFlags
Sets the flags for an index.
Apple event ID
kSearchSetIndexFlags ('sfdx')
Parameters
kIndexTag ('SixP'),
typeLongInteger
An opaque void* representing an index.
kFlagTag ('Flag'),
typeLongInteger
Index flags. See the description in SearchGetIndexFlags. In
practice, kIndexAvailableFlag should always be set.
Adobe Acrobat SDK
Acrobat Search Plug-in
Interapplication Communication API Reference
Search lists
219
Returns
kFlagTag ('Flag'), typeLongInteger
Index flags. See the description in “SearchGetIndexFlags” on page 216. This value is returned because it is
possible for a request to set a flag to fail.
Search lists
The Search plug-in adds a new menu, menu items, and toolbar buttons to the Acrobat application.
Menu names
The Search plug-in adds the following menu to Acrobat.
Menu name
Description
AcroSrch:ToolsSubMenu Acrobat Search submenu of Edit menu
Menu item names
The Search plug-in adds the following menu items to Acrobat.
Menu item name
Description
AcroSrch:Query
Displays the Search dialog box.
AcroSrch:Indexes
Displays the Index dialog box.
AcroSrch:Results
Displays the Results dialog box.
AcroSrch:Assist
Displays the Word Assistant dialog box.
AcroSrch:Separator
A separator item in the Search tools menu.
AcroSrch:PrevDoc
Goes to the previous document in the hit list.
AcroSrch:PrevHit
Goes to the previous hit in the hit list.
AcroSrch:NextHit
Goes to the next hit in the hit list.
AcroSrch:NextDoc
Goes to the next document in the hit list.
Adobe Acrobat SDK
Acrobat Search Plug-in
Interapplication Communication API Reference
Toolbar button names
Toolbar button names
The Search plug-in adds the following buttons to the Acrobat toolbar.
Button name
Description
AcroSrch:Separator
Separator (not visible).
AcroSrch:Query
Displays the Acrobat Search plug-in’s query dialog box.
AcroSrch:Results
Displays the Acrobat Search plug-in’s search results dialog box.
AcroSrch:Prev
Goes to the previous hit in the Acrobat Search plug-in’s results list.
AcroSrch:Next
Goes to the next hit in the Acrobat Search plug-in’s results list.
220
7
Coordinate Systems
This chapter describes the coordinate systems used by IAC: user space and device space.
User space
The user space is the coordinate system used within PDF files. In the IAC interface, it is used for most PD
layer objects (that is, objects such as PDBookmark whose names begin with “PD”). The following graphic
shows the user space coordinate system. The orientation, origin, and scale of the user space coordinate
system can be changed by operators in the page description in a PDF file.
User space coordinate system
The default user space is the user space coordinate system in effect immediately before each page begins
drawing. The origin of this coordinate system is the lower left corner of a page’s media box. The
x-coordinate increases to the right, and the y-coordinate increases upward. One unit in the default user
space is 1/72 of an inch.
221
Adobe Acrobat SDK
Coordinate Systems
Interapplication Communication API Reference
Device space
222
Device space
The device space specifies coordinates in screen pixels, as shown in the following graphic. It is used in the
AV layer of the IAC interface (that is, objects such as AVDoc whose names begin with “AV”).
Device space coordinate system
The origin of the device space coordinate system is at the upper left corner of the visible page on the
screen (that is, the upper left corner of the white part of the page). The x-coordinate increases to the right,
and the y-coordinate increases downward.
The upper left corner of the visible page is determined by the intersection of a page’s PDF crop box and
media box. As a result, the device space coordinate system changes if the cropping on a page changes.
Index
A
AcquirePage method 71
Acrobat application events 162
AcroExch.App 14
AcroExch.AVDoc 30
AcroExch.AVPageView 47
AcroExch.HiliteList 56
AcroExch.PDAnnot 56
AcroExch.PDBookmark 66
AcroExch.PDDoc 69
AcroExch.PDPage 86
AcroExch.PDTextSelect 98
AcroExch.Point 102
AcroExch.Rect 102
AcroExch.Time 104
Add method 56, 203
AddAnnot method 87
AddDocJavascript method 204
AddNewAnnot method 88
Adobe Reader
Apple events 155
DDE support 121
AFormApp object 184
Alignment property 193
annotation object 141
App object 14
AppExit message 121
AppExit method 181
AppFront method 181
AppHide message 122
Apple events and objects 141
application object 143
AppShow message 122
AVDoc object 30
AVPageView object 47, 145
AxAcroPDF object 106
AxAcroPDFLib.AxAcroPDF 106
B
bookmark object 145
BorderStyle property 194
BorderWidth property 194
Bottom property 103
bring to front event 163
BringToFront method 31
ButtonLayout property 195
C
CalcOrderIndex property 195
Catalog plug-in 181
CharLimit property 196
clear selection event 163
ClearFlags method 71
ClearSelection method 32
close all docs event 163
close event 156
Close method 32, 72
CloseAllDocs message 122
CloseAllDocs method 16
conversion object 147
coordinate systems 221
CopyToClipboard method 88
Core suite events 156
count event 157
Count property 207
Create method 72
create thumbs event 164
CreatePageHilite method 89
CreateTextSelect method 73
CreateThumbs method 74
CreateWordHilite method 90
CropPage method 91
CropPages method 74
D
Date property 104
DDE
Adobe Reader support 121
messages 120
DefaultValue property 196
delete event 157
delete pages event 165
delete thumbs event 165
DeletePages method 75
DeleteThumbs method 75
Destroy method 66, 98
device space 222
DevicePointToPage method 47
do script event 180
DocClose message 123
DocDeletePages message 123
DocFind message 124
DocGoTo message 125
DocGoToNameDest message 125
DocInsertPages message 125
DocOpen message 126
DocPageDown message 127
DocPageLeft message 127
DocPageRight message 128
DocPageUp message 128
DocPrint message 129
DocReplacePages message 129
DocSave message 130
DocSaveAs message 130
DocScrollTo message 131
223
Adobe Acrobat SDK
Index
Interapplication Communication API Reference
DocSetViewMode message 132
document object 147
DocZoomTo message 132
DoGoBack method 48
DoGoForward method 48
Draw method 91
DrawEx method 92
dual interfaces 14
224
Field object 184
Fields collection 202
FileBuild method 182
FileOpen message 133
FileOpen method 182
FileOpenEx message 133
FilePrint message 134
FilePrintEx message 135
FilePrintSilent message 135
FilePrintSilentEx message 136
FilePrintTo message 137
FilePrintToEx message 137
FilePurge method 182
find next note event 166
find text event 167
FindText method 33
Forms plug-in 183
FullMenus message 138
GetContents method 58
GetDate method 58
GetDoc method 49, 94
GetFileName method 76
GetFlags method 76
GetFrame method 18, 34
GetInfo method 77
GetInstanceID method 77
GetInterface method 19
GetJSObject method 78
GetLanguage method 19
GetNumAnnots method 94
GetNumAVDocs method 20
GetNumber method 95
GetNumPages method 78
GetNumText method 99
GetPage method 50, 100
GetPageMode method 79
GetPageNum method 50
GetPDDoc method 34
GetPermanentID method 79
GetPreference method 20
GetPreferenceEx method 21
GetRect method 58
GetRotate method 95
GetSize method 96
GetSubtype method 59
GetText method 101
GetTitle method 35, 59, 67
GetVersions method 108
GetViewMode method 35
GetZoom method 51
GetZoomType method 51
go backward event 168
go forward event 169
GoBackwardStack method 108
GoForwardStack method 108
goto event 170
Goto method 52
goto next event 170
goto previous event 171
GotoFirstPage method 108
GotoLastPage method 109
GotoNextPage method 109
GotoPreviousPage method 109
G
H
get event 158
get info event 168
GetActiveDoc method 17
GetActiveTool method 17
GetAnnot method 93
GetAnnotIndex method 93
GetAperture method 49
GetAVDoc method 18, 49
GetAVPageView method 33
GetBoundingRect method 99
GetByTitle method 67
GetColor method 57
HFT 209
Hide method 21
HideToolbar message 138
Highlight property 197
HiliteList object 56
host function table 209
Hour property 105
E
Editable property 196
EPS Conversion object 149
events
Acrobat application 162
Core suite 156
miscellaneous 180
Required suite 155
exceptions, Forms plug-in 183
execute event 166
ExecuteThisJavascript method 205
exists event 158
Exit method 16
ExportAsFDF method 205
ExportAsHtml method 206
F
I
ImportAnFDF method 207
index, Catalog plug-in 181
insert pages event 172
Adobe Acrobat SDK
Index
Interapplication Communication API Reference
InsertPages method 79
is toolbutton enabled event 172
IsEqual method 60
IsHidden property 197
IsMultiline property 198
IsOpen method 60
IsPassword property 198
IsReadOnly property 198
IsRequired property 199
IsTerminal property 199
IsValid method 35, 61, 68
Item property 208
L
Left property 103
Link Annotation object 149
LoadFile method 110
Lock method 21
M
make event 159
maximize event 173
Maximize method 23, 36
menu item object 150
menu object 149
MenuitemExecute message 139
MenuItemExecute method 23
MenuItemIsEnabled method 24
MenuItemIsMarked method 24
MenuItemRemove method 25
Millisecond property 105
Minimize method 22
Minute property 105
Month property 105
move event 159
MovePage method 80
N
Name property 199
_NewEnum property 208
NoViewFlag property 199
O
OLE automation 14
open event 155, 160
Open method 36, 81
OpenAVDoc method 81
OpenInWindow method 37
OpenInWindowEx method 38
P
page object 151
PDAnnot object 56, 151
PDBookMark object 152
PDBookmark object 66
PDDoc object 69
PDF Window object 152
225
PDLinkAnnot object 152
PDPage object 86, 152
PDTextAnnot object 152
PDTextSelect object 98
perform event 174
Perform method 62, 68
plug-ins
Catalog 181
Forms 183
Search 209
Point object 102
PointToDevice method 53
PopulateListOrComboBox method 185
PostScript Conversion object 153
print event 155
Print method 110
print pages event 174
PrintAll method 110
PrintAllFit method 111
PrintFlag property 200
PrintPages method 40, 111
PrintPagesEx method 40
PrintPagesFit method 112
PrintPagesSilent method 41
PrintPagesSilentEx method 42
PrintWithDialog method 113
Q
queries 209
quit event 155, 160
R
read page down event 175
read page up event 175
ReadPageDown method 53
ReadPageUp method 54
Rect object 102
Remove method 207
remove toolbutton event 176
RemoveAnnot method 96
replace pages event 176
ReplacePages method 82
Required suite events 155
Restore method 25
Right property 103
run event 156
S
save event 161
Save method 83
scroll event 177
ScrollTo method 54
search lists 219
Search plug-in 209
SearchAddIndex event 213
SearchCountIndexList event 213
SearchDoQuery event 214
SearchGetIndexByPath event 215
Adobe Acrobat SDK
Index
Interapplication Communication API Reference
SearchGetIndexFlags event 216
SearchGetIndexList event 216
SearchGetIndexPath event 216
SearchGetIndexTitle event 217
SearchGetNthIndex event 217
SearchRemoveIndex event 218
SearchSetIndexFlags event 218
Second property 106
select text event 178
set event 161
set info event 179
SetActiveTool method 26
SetBackgroundColor method 185
SetBorderColor method 186
SetButtonCaption method 187
SetButtonIcon method 187
SetColor method 62
SetContents method 63
SetCurrentHighlight method 113
SetCurrentPage method 113
SetDate method 63
SetExportValues method 188
SetFlags method 84
SetForegroundColor method 189
SetFrame method 26, 43
SetInfo method 85
SetJavaScriptAction method 190
SetLayoutMode method 114
SetNamedDest method 114
SetOpen method 64
SetPageMode method 85, 115
SetPreference method 27
SetPreferenceEx method 27
SetRect method 64
SetResetFormAction method 191
SetRotate method 97
SetShowScrollbars method 115
SetShowToolbar method 116
SetSubmitFormAction method 192
SetTextSelection method 44
SetTitle method 45, 65, 69
SetView method 116
SetViewMode method 45
SetViewRect method 117
226
SetViewScroll method 117
SetZoom method 118
SetZoomScroll method 118
ShortMenus message 139
Show method 28
ShowTextSelect method 46
ShowToolbar message 140
Src property 119
Style property 200
T
Text Annotation object 154
text searches 209
TextFont property 201
TextSize property 201
Time object 104
ToolButtonIsEnabled method 28
ToolButtonRemove method 29
Top property 104
Type property 201
U
Unlock method 29
UnlockEx method 30
user space 221
V
Value property 202
X
X property 102
Y
Y property 102
Year property 106
Z
zoom event 179
ZoomTo method 55
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement