Add-In Express for Office and .Net Add-In Express™ for Microsoft® Office and .Net
Total Page:16
File Type:pdf, Size:1020Kb
Add -in Express™ for Microsoft® Office and .net Add-in Express for Office and .net Add-in Express™ for Microsoft® Office and .net Add-in Express™ for Microsoft® Office and .net Developer's Guide Revised on 1-Jul-20 Copyright © Add-in Express Ltd. All rights reserved. Add-in Express, ADX Extensions, ADX Toolbar Controls, Afalina, AfalinaSoft and Afalina Software are trademarks or registered trademarks of Add-in Express Ltd. in the United States and/or other countries. Microsoft, Outlook, and the Office logo are trademarks or registered trademarks of Microsoft Corporation in the United States and/or other countries. Borland and the Delphi logo are trademarks or registered trademarks of Borland Corporation in the United States and/or other countries. THIS SOFTWARE IS PROVIDED "AS IS" AND ADD-IN EXPRESS LTD. MAKES NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED. BY WAY OF EXAMPLE, BUT NOT LIMITATION, ADD-IN EXPRESS LTD. MAKES NO REPRESENTATIONS OR WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF THE LICENSED SOFTWARE, DATABASE OR DOCUMENTATION WILL NOT INFRINGE ANY THIRD-PARTY PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS Add-in Express™ 2 www.add-in-express.com Add-in Express for Office and .net Add-in Express™ for Microsoft® Office and .net Table of contents Add-in Express™ for Microsoft® Office and .net ................................ 2 Table of contents ................................................................................ 3 Introduction ....................................................................................... 11 Add-in Express in seven lines ................................................................................................... 12 Installing and activating ............................................................................................................. 13 Activation basics ........................................................................................................................................ 13 Setup package contents ............................................................................................................................ 14 Redistributables ......................................................................................................................................... 14 Solving installation problems ..................................................................................................................... 15 Creating Add-in Express projects ............................................................................................. 15 Preconditions ............................................................................................................................................. 15 Developer permissions .............................................................................................................................. 16 Add-in Express projects............................................................................................................................. 16 Add-in Express project structure ............................................................................................................... 17 Add-in Express modules............................................................................................................................ 19 Registering the project, registering the add-in, the registrar ..................................................................... 21 Using .config files with Office extensions .................................................................................................. 21 Office extensibility technologies supported ............................................................................. 22 System requirements ................................................................................................................. 22 Technical support....................................................................................................................... 23 What's new in Add-in Express version 9 .................................................................................. 24 Getting Started .................................................................................. 25 Your first Microsoft Office COM add-in ..................................................................................... 26 Download the example .............................................................................................................................. 26 A bit of theory ............................................................................................................................................ 26 Step #1 – Creating COM add-in project .................................................................................................... 27 Step #2 – Add-in module ........................................................................................................................... 31 Step #3 – Add-in module designer ............................................................................................................ 31 Step #4 – Office applications that your add-in supports ............................................................................ 32 Step #5 – Office application that loads your add-in ................................................................................... 33 Step #6 – Handling errors and logging debug messages ......................................................................... 34 Step #7 – Designing custom Ribbon UI .................................................................................................... 34 Step #8 – Advanced Task Panes in Excel 2000-2019/365 ....................................................................... 36 Step #9 – Advanced Task Panes in Word and PowerPoint 2000-2019/365............................................. 39 Add-in Express™ 3 www.add-in-express.com Add-in Express for Office and .net Add-in Express™ for Microsoft® Office and .net Step #10 – Accessing host application's object model ............................................................................. 40 Step #11 – Handling host application events ............................................................................................ 42 Step #12 – Programming the Ribbon UI ................................................................................................... 43 Step #13 – Programming Add-in Express regions .................................................................................... 46 Step #14 – Running the COM add-in ........................................................................................................ 47 Step #15 – Debugging the COM add-in .................................................................................................... 50 Step #16 – Deploying the COM add-in ...................................................................................................... 50 What's next? .............................................................................................................................................. 51 Your first Microsoft Outlook COM add-in ................................................................................. 52 Download the example .............................................................................................................................. 52 A bit of theory ............................................................................................................................................ 52 Step #1 – Creating COM add-in project .................................................................................................... 53 Step #2 – Add-in module ........................................................................................................................... 57 Step #3 – Add-in module designer ............................................................................................................ 57 Step #4 – Outlook versions that your add-in supports .............................................................................. 58 Step #5 – What Outlook version loads your add-in ................................................................................... 59 Step #6 – Handling errors and logging debug messages ......................................................................... 60 Step #7 – Designing custom Ribbon UI in Outlook ................................................................................... 60 Step #8 – Advanced Outlook Region in Outlook 2000-2019/365 ............................................................. 61 Step #9 – Accessing Outlook objects ........................................................................................................ 64 Step #10 – Handling Outlook events ......................................................................................................... 66 Step #11 – Programming the Outlook Ribbon UI ...................................................................................... 68 Step #12 – Programming Add-in Express regions .................................................................................... 71 Step #13 – Running COM add-in project .................................................................................................. 72 Step #14 – Debugging COM add-in .......................................................................................................... 75 Step #15