Te chnical Note #5181 Versio n : Acrobat 6

1 Acrobat Forms API. bc reference Technical Note # 5181 . Version : Acrobat ADOBE SYSTEMS INCORPORATED. Corporate Headquarters 345 Park Avenue San Jose, CA 95110-2704. (408) 536-6000. May 2003. Copyright 2003 Adobe Systems Incorporated. All rights reserved. NOTICE: All information contained herein is the property of Adobe Systems Incorporated. No part of this publication (whether in hardcopy or electronic form) may be reproduced or transmitted, in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without the prior written consent of the Adobe Systems Incorporated. PostScript is a registered trademark of Adobe Systems Incorporated. All instances of the name PostScript in the text are references to the PostScript language as defined by Adobe Systems Incorporated unless otherwise stated. The name PostScript also is used as a product trademark for Adobe Systems' implementation of the PostScript language interpreter.

2 Except as otherwise stated, any reference to a "PostScript printing device, "PostScript display device, or similar item refers to a printing device, display device or item (respectively) that contains PostScript technology created or licensed by Adobe Systems Incorporated and not to devices or items that purport to be merely compatible with the PostScript language. Adobe, the Adobe logo, Acrobat , the Acrobat logo, Acrobat Capture, Distiller, PostScript, the PostScript logo and Reader are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries. Apple, Macintosh, and Power Macintosh are trademarks of Apple Computer, Inc., registered in the United States and other countries. PowerPC. is a registered trademark of IBM Corporation in the United States. ActiveX, Microsoft, Windows, and Windows NT are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.

3 UNIX is a registered trademark of The Open Group. All other trademarks are the property of their respective owners. This publication and the information herein is furnished AS IS, is subject to change without notice, and should not be construed as a commitment by Adobe Systems Incorporated. Adobe Systems Incorporated assumes no responsibility or liability for any errors or inaccuracies, makes no warranty of any kind (express, implied, or statutory) with respect to this publication, and expressly disclaims any and all warranties of merchantability, fitness for particular purposes, and noninfringement of third party rights. Acrobat SDK Documentation Roadmap Getting Started Getting Started Using the Acrobat Software Development Kit PDF Specification Acrobat SDK Release notes Acrobat Developer FAQ Reader Enabling PDF reference Acrobat Development Overview Acrobat Plug-in Tutorial Acrobat SDK Samples Guide Manual Upgrading Plug-ins from Acrobat to Acrobat Acrobat Core API Extended API for Plug-in PDF Creation APIs JavaScript Acrobat Interapplication and Specifications Communication (IAC).

4 Acrobat Core Acrobat JavaScript API Overview AcroColor api reference Acrobat Distiller Scripting Acrobat IAC Overview Parameters reference Acrobat Core Acrobat IAC reference api reference ADM Programmer's Acrobat Distiller Acrobat Guide and reference api reference JavaScript Scripting Guide pdfmark Catalog api reference reference Programming Acrobat JavaScript Using Visual Basic Digital Signature API. reference Forms api reference PDF Consultant Accessibility Checker Search api reference Spelling api reference Using the Save as XML Plug-in Weblink api reference Contents Preface .. 11. What Is In This Document.. 11. Other Useful Documentation .. 11. Conventions Used in This Book .. 12. AcroForm api reference .. 15. Introduction .. 15. Contents .. 15. Exceptions .. 16. AcroForm Objects .. 17. AcroForm Objects .. 17. PDField .. 17. Core Objects .. 18. ASAtom .. 18. ASBool.. 18.

5 ASFile .. 18. ASPathName.. 18. AVDoc .. 18. CosDoc .. 18. CosObj .. 18. PDAnnot .. 19. PDDoc .. 19. PDPage .. 19. AcroForm Methods .. 21. AFExecuteThisScript .. 21. AFImportAppearance .. 22. AFLayoutBorder.. 23. AFLayoutCreateStream .. 24. AFLayoutDelete .. 25. AFLayoutNew .. 26. AFLayoutText .. 27. AFPDDocEnumPDFields .. 29. AFPDDocGetPDFieldFromName .. 30. Acrobat Forms api reference 5. Contents AFPDDocLoadPDFields .. 31. AFPDF ieldFromCosObj .. 32. AFPDF ieldGetCosObj .. 33. AFPDF ieldGetDefaultTextAppearance .. 34. AFPDF ieldGetFlags .. 35. AFPDF ieldGetName .. 36. AFPDF ieldGetValue .. 37. AFPDF ieldIsAnnot .. 38. AFPDF ieldIsTerminal.. 39. AFPDF ieldIsValid .. 40. AFPDF ieldReset .. 41. AFPDF ieldSetDefaultTextAppearance.. 42. AFPDF ieldSetFlags .. 43. AFPDF ieldSetOptions .. 44. AFPDF ieldSetValue.. 45. AFPDFormFromPage .. 46. AFPDW idgetGetAreaColors .. 47. AFPDW idgetGetBorder.

6 48. AFPDW idgetGetRotation .. 49. AFPDW idgetSetAreaColors.. 50. AFPDW idgetSetBorder .. 51. AssembleFormAndImportFDF.. 52. ExportAsFDF .. 53. ExportAsFDFEx .. 55. ExportAsFDFWithParams .. 57. ExportAsHtml .. 58. ExportAsHtmlEx.. 59. ImportAnFDF .. 61. IsPDDocAcroForm .. 62. ResetForm .. 63. AcroForm Callbacks .. 65. AFPDF ieldEnumProc.. 65. AcroForm Declarations .. 67. AcroForm Data Types .. 67. AF_Flags_t .. 67. AFPDF ieldBorder .. 69. AFPDF ieldFlags_t .. 70. AFPDW idgetBorder .. 71. AFPDW idgetBorderRec .. 71. AFPDW idgetBorderStyle .. 72. ExportAsFDFP arams .. 73. ExportAsFDFP aramsRec.. 73. 6 Acrobat Forms api reference Contents RetCode.. 76. TextAppearance .. 77. TextAppearanceP.. 77. Core Data Types.. 79. PDColorSpace .. 79. PDColorValue .. 80. PDColorValueRec .. 80. PDRotate .. 81. AcroForm Macros .. 83. Init_TextAppearanceP.. 83. SetDefaultTextAppearanceP.. 84. TextApperanceIsValid.

7 85. Text-to-Speech API (Windows only) .. 87. AFTTSGetNumberOfVoices.. 88. AFTTSGetPitch.. 89. AFTTSGetSpeaker.. 90. AFTTSGetSpeechRate .. 91. AFTTSGetVoiceName .. 92. AFTTSGetVolume .. 93. AFTTSIsAvailable .. 94. AFTTSP ause .. 95. AFTTSQS ilence .. 96. AFTTSQS ound .. 97. AFTTSQ ueueTextData .. 98. AFTTSR eset.. 99. AFTTSR esume ..100. AFTTSSetPitch ..101. AFTTSSetSpeaker ..102. AFTTSSetSpeechRate ..103. AFTTSSetVolume ..104. AFTTSStop ..105. AFTTSTalk..106. AcroForm OLE Automation .. 107. Description..107. Contents ..107. Conventions ..108. Exceptions ..108. Acrobat Forms api reference 7. Contents OLE Automation Objects .. 109. AFormApp ..109. Field ..109. Fields ..109. OLE Automation Methods .. 111. Field ..111. PopulateListOrComboBox ..111. SetBackgroundColor..112. SetBorderColor ..113. SetButtonCaption ..114. SetButtonIcon ..115. SetExportValues..116. SetForegroundColor.

8 117. SetJavaScriptAction ..118. SetResetFormAction ..121. SetSubmitFormAction..122. Fields..123. Add..123. AddDocJavascript ..125. ExecuteThisJavascript ..126. ExportAsFDF ..127. ExportAsHtml ..128. ImportAnFDF ..129. Remove ..130. OLE Automation Properties .. 131. Field ..131. Alignment ..131. BorderStyle..132. BorderWidth ..133. ButtonLayout ..134. CalcOrderIndex ..135. CharLimit ..136. DefaultValue ..137. Editable ..138. Highlight ..139. IsHidden ..140. IsMultiline ..141. IsPassword ..142. IsReadOnly ..143. IsRequired ..144. IsTerminal ..145. 8 Acrobat Forms api reference Contents Name ..146. NoViewFlag ..147. PrintFlag ..148. Style ..149. TextFont ..150. TextSize ..151. Type ..152. Value..153. Fields..154. Count ..154. Item ..155. _NewEnum..156. Acrobat Forms api reference 9. Contents 10 Acrobat Forms api reference Preface The Adobe Acrobat Forms plug-in allows a Portable Document Format (PDF) document to act as a form; that is, the Acrobat equivalent of a paper form with fields.

9 It is now faster and easier to exchange information either in familiar paper or electronic forms converted to PDF files with Acrobat , or as dynamic interactive database templates. NOTE: Forms as used here do not refer to XObject forms as defined in the PDF reference . The Forms plug-in for Acrobat (versions and above) allows users to author form fields. For Acrobat Reader, the Forms plug-in does not allow form authoring, but allows users to fill in data and print Acrobat forms. The Reader Forms plug-in also does not allow users to save data to the local hard disk. Both Acrobat and Reader allow Web designers to send data from the form back to a Web server. What Is In This Document This document is a reference for developers who want to take advantage of the Forms API. It is divided into two sections: AcroForm api reference describes the Forms API and explains how to use it. It includes the new Text-to-Speech APIs for Windows.

10 AcroForm OLE Automation describes the OLE Automation methods exported by the Adobe Acrobat AcroForm plug-in. If you received this technical note without obtaining the entire Acrobat Software Development Kit (SDK), you can get the complete SDK by visiting: Useful Documentation Other Useful Documentation You should be familiar with the Acrobat core API. The following technical notes provide this information. Acrobat Core API Overview, technical note 5190,gives an overview of the objects and methods provided by the Acrobat core API. Acrobat Core api reference , technical note 5191,describes in detail the objects and methods provided by the Acrobat core API. Acrobat Development Overview, technical note 5167, describes how to develop Acrobat plug-ins on the various platforms available. Acrobat Forms api reference 11. Preface Conventions Used in This Book PDF reference , Fourth Edition, version Provides a description of the PDF file format, as well as suggestions for producing efficient PDF files.