Building Office Add-ins using Office.js
Building Office Add-ins using Office.js
About the Book
This book is about creating Office Add-ins – and in particular, about the new Office 2016 wave of Office.js APIs.
Want to get started with just the very core concepts, before buying the book? Download some sample chapters, or visit http://BuildingOfficeAddins.com, which contains abridged content for some of the key topics in this book. Or better yet, buy the book regardless: I am sure you'll find the topics therein new and useful for writing add-ins; and if you don't, LeanPub's Happiness Guarantee will let you get a full refund anytime in the first 45 days.
All proceeds from this book will be donated to humanitarian work / disaster relief (and also get matched by Microsoft's generous Employee Match program, for double impact).
Office 2016 has seen a major re-birth of the API model, with hundreds of new APIs created for Excel and Word and OneNote. These APIs are cross-platform, are built on a modern web framework, and offer some of the same powerful functionality that previously was only available on the Desktop.
In spirit, the new Office.js APIs are reasonably similar to their VBA/VSTO counterparts, but with the notable difference of being async – which brings with it a new set of concepts and best practices. This book will begin by address the core concepts to help you get over the initial learning curve, and get started on using the APIs. The subsequent chapters will expand upon these topics, covering more advanced scenarios, and offering debugging advice, tips, FAQs, and so forth.
Note that this book is published using a "lean" methodology – publishing early, and publishing often. Since writing the book is strictly my "moonlighting" activity – my day-job is to be a developer on Office.js APIs, not a technical writer – it will take a good long while before I am actually done with all the content I want to write about. I would rather ship an early version of the book, addressing the most common questions and issues that I see folks struggling with, and then keep iterating on it from there.
In buying this e-book through LeanPub (where I’m also discounting it for the "early readers"), you are entitled to free updates to the book. So, expect to see more content appear month-to-month (and, if you sign up for email notification, to receive periodic emails updates about what new content got added).
I welcome any and all feedback about the writing, explanations, code-samples, and whatever else. I also welcome topic suggestions, if you see something I didn’t cover; or, if you see something that I plan to cover, but haven’t yet, just let me know and I can see if I can prioritize it.
- Michael Zlatkovsky, the author
3 Copy Package
This package is for THREE copies of the book, to distribute among your Dev team, at a small discount. After checkout, in the confirmation/download page, you will see "You have purchased multiple copies of this Book. Click here to manage your download tokens." You can use this to send out the individual tokens to team members. That way, only one person (e.g., a team admin with a corporate credit card) needs to go through the checkout process, and the rest can just download the book.
5 Copy Package
This package is for FIVE copies of the book, to distribute among your Dev team. After checkout, in the confirmation/download page, you will see "You have purchased multiple copies of this Book. Click here to manage your download tokens." You can use this to send out the individual tokens to team members. That way, only one person (e.g., a team admin with a corporate credit card) needs to go through the checkout process, and the rest can just download the book.
The Book + 1-hour Skype call / coaching
Need some help navigating the world of Office Add-ins? Or want to discuss your business scenario or technological constraints, and hear my suggestions on how I would proceed if I were in your shoes? Purchase this package, and get a copy of the book PLUS a one-hour Skype call at a mutually-convenient time (generally my early mornings, or most anytime in the evenings, or potentially on the weekends, Seattle time). Email me after you've purchased this package (follow the "Email the Author" link from the book landing page), and we can set up some time with your or your Dev team to chat. Like everything else on Leanpub, this package is covered by the 45-day 100% Happiness Guarantee.
1 The book and its structure
- 1.1 The “evergreen”, in-progress book
- 1.2 Release notes
- 1.3 Bug reports / topic suggestions
- 1.4 Twitter
- 1.5 Who should read this book
- 1.6 From the author
- 1.7 A few brief notes
- 1.8 Acknowledgments
2 Introduction to Office Add-ins
- 2.1 What’s “new” in the Office 2016 APIs (relative to 2013)?
- 2.2 What about VBA, VSTO, and COM Add-ins?
- 2.3 “But can Office.js do XYZ?”
2.5 Office.js: The asynchronous / deferred-execution programming model
- 2.5.1 Why is Office.js async?
- 2.5.2 What is meant by “the server”
3 Getting started: Prerequisites & resources
- 3.1 Script Lab: an indispensable tool
- 3.2 The optimal dev environment
- 3.3 API documentation resources
- 4.2.1 Variables
- 4.2.2 Variables & TypeScript
- 4.2.3 Strings
- 4.2.4 Assignments, comparisons, and logical operators
- 4.2.6 Arrays
- 4.2.7 Complex objects & JSON
- 4.2.8 Functions
- 4.2.9 Functions & TypeScript
- 4.2.10 Scope, closure, and avoiding polluting the global namespace
- 4.2.11 Misc.
- 4.2.12 jQuery
4.3 Promises Primer
- 4.3.1 Chaining Promises, the right way
- 4.3.2 Creating a new Promise
5 Office.js APIs: Core concepts
- 5.1 Canonical code sample: reading data and performing actions on the document
- 5.2 Excel.run (Word.run, etc.)
5.3 Proxy objects: the building-blocks of the Office 2016 API model
- 5.3.1 Setting document properties using proxy objects
- 5.3.3 The processing on the host application’s side
- 5.3.4 Loading properties: the bare basics
5.4 Handling errors
- 5.4.1 The basics of Office.js errors
- 5.4.2 Don’t forget the user!
- 5.4.3 Some practical advice
- 5.5 Recap: the four basic principles of Office.js
6 Implementation details, if you want to know how it really works
- 6.1 The Request Context queue
- 6.2 The host application’s response
- 6.3 Back on the proxy object’s territory
- 6.4 A special (but common) case: objects without IDs
7 More core
7.1 Scalar vs. navigation properties – and their impact on
- 7.2 Loading and re-loading
- 7.3 Loading collections
7.4 Understanding the
- 7.4.1 What does it even mean?
- 7.4.2 Signaling your intentions: an analogy
7.4.3 Common mistake: re-invoking
getmethods (and in general, loading on methods versus properties)
- 7.4.4 Another common mistake: loading nonexistent properties
7.4.5 A rarer and more befuddling case: when using an object across
- 7.5 Methods that return “primitive” types (strings, numbers, etc). E.g.: tables.getCount(), chart.getImage(), etc.
- 7.1 Scalar vs. navigation properties – and their impact on
8 More core
8.1 Real-world example of multiple
- 8.2 When to sync
8.3 The final
context.sync(in a multi-
8.4 A more complex
- 8.5 Avoiding leaving the document in a “dirty” state
- 8.1 Real-world example of multiple
9 Checking if an object exists
- 9.1 Checking via exception-handling – a somewhat heavy-handed approach
9.2 A gentler check: the
*OrNullObjectmethods & properties
- 9.2.1 Case 1: Performing an action, and no-op-ing otherwise
- 9.2.2 Case 2: Checking whether the object exists, and changing behavior accordingly
Word.run, etc.) advanced topics
10.1 What does “
.run” do, and why do I need it?
10.2 Using objects outside the “linear”
Word.runflow (e.g., in a button-click callback, in a
10.2.1 Re-hydrating an existing Request Context: the overall pattern, proper error-handling,
object.track, and cleanup of tracked objects.
- 10.2.2 A common, and infuriatingly silent, mistake: queueing up actions on the wrong request context
- 10.2.3 Resuming with multiple objects
- 10.2.4 Why can’t we have a single global request context, and be one happy family?
- 10.2.1 Re-hydrating an existing Request Context: the overall pattern, proper error-handling,
- 10.1 What does “
- 11 Other API Topics
12 The practical aspects of building an Add-in
- 12.1 Walkthrough: Building an Add-in using Visual Studio
12.2 Getting started with building TypeScript-based Add-ins
- 12.2.1 Using Visual Studio
- 12.2.2 Using Yeoman generator & Node/NPM
- 12.3 Debugging: the bare basics
- 12.4 IntelliSense
- 12.5 Office versions: Office 2016 vs. Office 365 (MSI vs. Click-to-Run); Deferred vs. Current channels; Insider tracks
12.6 Office.js API versioning
- 12.6.2 The host capabilities
- 12.6.3 The Beta Endpoint
- 12.6.4 How can you know than an API is “production-ready”?
13.1 Passing in functions to Promise
13.3.2 Returning the
13.3.3 Passing values across
- 13.1 Passing in functions to Promise
14 Appendix B: Miscellanea
- 14.1 Script Lab: the story behind the project
The Leanpub 45-day 100% Happiness Guarantee
Within 45 days of purchase you can get a 100% refund on any Leanpub purchase, in two clicks.
See full terms
Free Updates. DRM Free.
If you buy a Leanpub book, you get free updates for as long as the author updates the book! Many authors use Leanpub to publish their books in-progress, while they are writing them. All readers get free updates, regardless of when they bought the book or how much they paid (including free).
Most Leanpub books are available in PDF (for computers), EPUB (for phones and tablets) and MOBI (for Kindle). The formats that a book includes are shown at the top right corner of this page.
Finally, Leanpub books don't have any DRM copy-protection nonsense, so you can easily read them on any supported device.
Ansible for KubernetesJeff Geerling
Ansible is a powerful infrastructure automation tool. Kubernetes is a powerful application deployment platform. Learn how to use these tools to automate massively-scalable, highly-available infrastructure.
Practical FP in Scala: A hands-on approachGabriel Volpe
A practical book aimed for those familiar with functional programming in Scala who are yet not confident about architecting an application from scratch.
Together, we will develop a purely functional application using the best libraries in the Cats ecosystem, while learning about design patterns and best practices.
Functional Design and ArchitectureAlexander Granin
Software Design in Functional Programming, Design Patterns and Practices, Methodologies and Application Architectures. How to build real software in Haskell with less efforts and low risks. The first complete source of knowledge.
Production HaskellMatt Parsons
Are you excited about Haskell, but don't know where to begin? Are you thrilled by the technical advantages, but worried about the unknown pitfalls? This book has you covered.
Tame your Work FlowSteve Tendon and Daniel Doiron
Do you need a high performance enterprise governance approach improving management, execution and delivery while dealing with multiple projects/products, events, stakeholders and teams? Giving you better bottom line results, faster time to market, less work, better predictability, happier employees, and delighted clients? Then learn about TameFlow!
Ansible for DevOpsJeff Geerling
Ansible is a simple, but powerful, server and configuration management tool. Learn to use Ansible effectively, whether you manage one server—or thousands.
Machine Learning EngineeringAndriy Burkov
"If you intend to use machine learning to solve business problems at scale, I'm delighted you got your hands on this book."
—Cassie Kozyrkov, Chief Decision Scientist at Google
"Foundational work about the reality of building machine learning models in production."
—Karolis Urbonas, Head of Machine Learning and Science at Amazon
C++ Best PracticesJason Turner
Level up your C++, get the tools working for you, eliminate common problems, and move on to more exciting things!
Composing SoftwareEric Elliott
All software design is composition: the act of breaking complex problems down into smaller problems and composing those solutions. Most developers have a limited understanding of compositional techniques. It's time for that to change.
El Manual del ManagerKeyvan Akbary, Félix López, and Álvaro Salazar
¿Has deseado alguna vez el haber tenido una buena introducción al rol del Engineering Manager? En este libro aprenderás lo necesario para ejercer el rol de una manera efectiva: Expectativas y Responsabilidades del Rol, 1-1s, Ayudar a Crecer, Objetivos, Planes de Carrera, Cultura, Feedback, Contratación, Cultura de Producto y mucho más.
The Tester's Library
8 BooksThe Tester's Library consists of eight five-star books that every software tester should read and re-read. As bound books, this collection would cost over $200. Even as e-books, their price would exceed $80, but in this bundle, their cost is only $49.99. Here are the books, and why they should be in your library: Perfect Software and Other...
11 BooksIn this bundle, you will find 10 different agile books. They are about different aspects of being agile. - finding a job - doing coding dojo's - Retrospectives - Personal kanban - a non-typical coaching book and even a book that gives you an insight in the lives of some agile people.
WTFlop 6M + HU - Beta Bundle
Marionette.js A to Z
Build A Better Backbone App
3 BooksThe best way to learn new development skills is through experience, but that takes time you don't have.Get the best of both worlds with this bundle: you'll learn how to produce modern web applications by learning from experienced developers like Derick Bailey and David Sulc. BackboneJS is one of the favorite tools on the web today, but it...
General Systems Thinker Bundle
5 BooksThe General Systems Thinker Bundle is just that: a bundle of five books to advance the reader one giant step toward improved thinking, based on General Systems principles. Four of the books are the complete General Systems Series. The fifth is fictional piece which shows some general systems thinkers in action. It's a mystery in which a group of...
Experiential Learning Bundle
4 BooksThis bundle provides all four volumes of the popular Experiential Learning Series at a savings of $20 over the price if purchased separately.
2 BooksAfter getting up and running with Ansible in Jeff Geerling's Ansible for DevOps, strengthen your skills managing tens to thousands of instances and services in Amazon's AWS cloud with Yan Kurniawan's Ansible for AWS.
Learn ECMAScript 6 inside and out
2 BooksFor any technology, it helps to get multiple points of view on the functionality to get the best possible understanding. For ECMAScript 6/2015, no two resources are recommended more frequently thanExploring ES6by Dr. Axel Rauschmayer andUnderstanding ECMAScript 6by Nicholas C. Zakas. These two points of view, investigating the specification and...
Software architecture, for systems old and new
2 BooksThis bundle includes books about hands-on software architecture.