ArcGIS® Desktop Developer Guide ArcGIS® 9.1 PUBLISHED BY ESRI 380 New York Street Redlands, California 92373-8100 Copyright © 2004 ESRI U.S. GOVERNMENT RESTRICTED/LIMITED RIGHTS All rights reserved. Any software, documentation, and/or data delivered hereunder is Printed in the United States of America. subject to the terms of the License Agreement. In no event shall the U.S. Government acquire greater than RESTRICTED/LIMITED RIGHTS. The information contained in this document is the exclusive property of At a minimum, use, duplication, or disclosure by the U.S. Government is ESRI. This work is protected under United States copyright law and subject to restrictions as set forth in FAR §52.227-14 Alternates I, II, and other international copyright treaties and conventions. No part of this III (JUN 1987); FAR §52.227-19 (JUN 1987) and/or FAR §12.211/12.212 work may be reproduced or transmitted in any form or by any means, (Commercial Technical Data/Computer Software); and DFARS electronic or mechanical, including photocopying and recording, or by any §252.227-7015 (NOV 1995) (Technical Data) and/or DFARS §227.7202 information storage or retrieval system, except as expressly permitted in (Computer Software), as applicable. Contractor/Manufacturer is ESRI, writing by ESRI. All requests should be sent to Attention: Contracts 380 New York Street, Redlands, California 92373-8100, USA. Manager, ESRI, 380 New York Street, Redlands, California 92373-8100, USA. ESRI, ArcView, ArcIMS, SDE, the ESRI globe logo, ArcGlobe, ArcReader, ArcPad, ArcScan, ArcObjects, ArcGIS, ArcMap, ArcCatalog, ArcScene, The information contained in this document is subject to change without ArcInfo, ArcEdit, ArcEditor, ArcToolbox, 3D Analyst, ArcPress, ArcSDE, notice. GIS by ESRI, the ArcGIS logo, and www.esri.com are trademarks, registered trademarks, or service marks of ESRI in the United States, Contributing Writers the European Community, or certain other jurisdictions. Euan Cameron, Rob Elkins, Shelly Gill, Sean Jones, Allan Laframboise, Glenn Meister, Steve Van Esch Other companies and products mentioned herein are trademarks or registered trademarks of their respective trademark owners. Attribution.pmd 1 1/26/2005, 7:02 AM Contents CHAPTER 1: INTRODUCING ArcGIS DESKTOP DEVELOPMENT .............. 1 ArcGIS 9 developer overview .......................................................................................................... 2 ArcGIS Desktop developer overview ............................................................................................. 6 Using this guide ................................................................................................................................. 10 ArcGIS developer resources .......................................................................................................... 12 CHAPTER 2: ArcGIS SOFTWARE ARCHITECTURE ........................................... 17 ArcGIS software architecture ....................................................................................................... 18 ArcGIS application programming interfaces ............................................................................. 23 ArcGIS Engine libraries .................................................................................................................... 25 ArcGIS Desktop application libraries .......................................................................................... 33 CHAPTER 3: DEVELOPING FOR ArcGIS DESKTOP APPLICATIONS ....... 45 Customizing ArcGIS Desktop.......................................................................................................................... 46 Storing customizations .................................................................................................................... 49 Customizing ArcGIS Desktop applications with VBA ............................................................. 53 Component development .............................................................................................................. 64 Choosing a component development environment .............................................................. 67 Building an ArcGIS Desktop component ................................................................................... 68 CHAPTER 4: LICENSING AND DEPLOYMENT................................................... 73 ArcGIS Desktop license checking.................................................................................................74 Packing and deploying customizations ....................................................................................... 86 CHAPTER 5: DEVELOPER SCENARIOS................................................................... 93 Create a toolbar: Command, Tool, and Menu ........................................................................... 94 Extensions.........................................................................................................................................114 Dockable window ...........................................................................................................................120 APPENDIX A: DEVELOPER ENVIRONMENTS .................................................. 133 The Microsoft Component Object Model ............................................................................. 134 Developing with ArcObjects ........................................................................................................146 The Visual Basic 6 environment ..................................................................................................155 Visual Basic for Applications ........................................................................................................168 The Visual Basic 6 development environment ........................................................................174 Visual C++................................................................................................................................................................ 181 .NET Application Programming Interface............................................................................................. 223 TOC.pmd 3 1/26/2005, 7:37 AM APPENDIX B: READING THE OBJECT MODEL DIAGRAMS ..................... 265 Interpreting the object model diagrams...................................................................................266 APPENDIX C: ILLUSTRATED CODE SAMPLES ................................................ 269 Locate and execute command on toolbar ............................................................................. 271 Draw digitized line onscreen .......................................................................................................272 Add feature class to ArcMap .......................................................................................................274 Add layer to ArcMap using GxDialog .......................................................................................276 Style gallery auto symbol selection ............................................................................................278 Loop through selected area features ........................................................................................280 Spatial query .....................................................................................................................................282 Add map surround to page layout............................................................................................284 Add text callout to active view ..................................................................................................286 Geometry projection .....................................................................................................................288 Display raster cell value in status bar ........................................................................................290 Export current view ......................................................................................................................292 Print current view ..........................................................................................................................294 Display map extent in GxView as envelope ...........................................................................296 Edit feature class schema..............................................................................................................298 APPENDIX D: ArcObjects PROBLEM-SOLVING GUIDE ............................. 301 ArcObjects problem-solving guide ............................................................................................302 APPENDIX E: UIControls............................................................................................ 319 UIControl classes ............................................................................................................................320 UIButtonControl class ..................................................................................................................321 UIComboBoxControl class .........................................................................................................322 UIEditBoxControl class ................................................................................................................323 UIToolControl class .......................................................................................................................324 APPENDIX F: