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.
Yours truly,
- Michael Zlatkovsky, the author
About the Author
Packages
The Book
PDF
EPUB
MOBI
WEB
English
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.
PDF
EPUB
MOBI
WEB
English
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.
PDF
EPUB
MOBI
WEB
English
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.
PDF
EPUB
MOBI
WEB
English
Table of Contents
-
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.4 A word on JavaScript and TypeScript
-
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 JavaScript & Promises primer (as pertaining to our APIs)
- 4.1 “JavaScript Garden”, an excellent JS resource
-
4.2 JavaScript & TypeScript crash-course (Office.js-tailored)
- 4.2.1 Variables
- 4.2.2 Variables & TypeScript
- 4.2.3 Strings
- 4.2.4 Assignments, comparisons, and logical operators
-
4.2.5
if,for,while - 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
-
4.3.3 Promises,
try/catch, andasync/await
-
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.2 The processing on the JavaScript side
- 5.3.3 The processing on the host application’s side
- 5.3.4 Loading properties: the bare basics
-
5.3.5 De-mystifying
context.sync()
-
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
loadconcepts-
7.1 Scalar vs. navigation properties – and their impact on
load - 7.2 Loading and re-loading
- 7.3 Loading collections
-
7.4 Understanding the
PropertyNotLoadederror- 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
run-s
- 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
syncconcepts-
8.1 Real-world example of multiple
sync-calls - 8.2 When to sync
-
8.3 The final
context.sync(in a multi-syncscenario) -
8.4 A more complex
context.syncexample: - 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
-
10
Excel.run(Word.run, etc.) advanced topics-
10.1 What does “
.run” do, and why do I need it? -
10.2 Using objects outside the “linear”
Excel.runorWord.runflow (e.g., in a button-click callback, in asetInterval, etc.)-
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.1 The JavaScript files
- 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 Appendix A: Using plain ES5 JavaScript (no
async/await)-
13.1 Passing in functions to Promise
.then-functions - 13.2 JavaScript-only version of the canonical code sample
-
13.3 JavaScript-specific
syncconcepts- 13.3.1 A JavaScript-based multi-sync template
-
13.3.2 Returning the
context.sync()promise -
13.3.3 Passing values across
.then-functions -
13.3.4 JavaScript example of multi-
synccalls
-
13.1 Passing in functions to Promise
-
14 Appendix B: Miscellanea
- 14.1 Script Lab: the story behind the project
- Notes
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
Do Well. Do Good.
Authors have earned$10,589,243writing, publishing and selling on Leanpub, earning 80% royalties while saving up to 25 million pounds of CO2 and up to 46,000 trees.
Learn more about writing on Leanpub
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.
Learn more about Leanpub's ebook formats and where to read them
Top Books
- #1
Functional Programming Made Easier
Charles ScalfaniA Functional Programming book from beginner to advanced without skipping a single step along the way.
In my 40 years of programming, I've felt that programming books always let me down, especially Functional Programming books. So, I wrote the book I wish I had 5 years ago.
Functional Programming will never be easy, but it can be easier.
- #2
Continuous Delivery Pipelines
Dave FarleyThis practical handbook provides a step-by-step guide for you to get the best continuous delivery pipeline for your software.
- #3
C++20
Rainer GrimmC++20 is the next big C++ standard after C++11. As C++11 did it, C++20 changes the way we program modern C++. This change is, in particular, due to the big four of C++20: ranges, coroutines, concepts, and modules.
- #4
CCIE SP v5.0
Łukasz Bromirski, Piotr Jablonski, and Nicholas RussoAre you striving to prepare to and pass CCIE SP lab exam? Take the opportunity and get this workbook! With the attached initial cfg files you will prepare yourself for the CCIE SP exam as well as learn SP technologies applicable to all kinds of today modern networks! This workbook covers blueprint topics and provides challenging examples.
- #5
C++20 - The Complete Guide
Nicolai M. JosuttisAll the new language and library features of C++20 (for those who know previous versions).
The book presents all new language and library features of C++20. Learn how this impacts day-to-day programming, to benefit in practice, to combine new features, and to avoid all new traps.
Buy early, pay less, free updates.
Other books:
- #6
Composing Software
Eric ElliottAll 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.
- #7
Concurrency with Modern C++
Rainer GrimmC++11 is the first C++ standard that deals with concurrency. The story goes on with C++17, C++20, and will continue with C++23.
I'll give you a detailed insight into the current and the upcoming concurrency in C++. This insight includes the theory and a lot of practice.
- #8
Discrete Mathematics for Computer Science
Alexander Shen, Alexander S. Kulikov, Vladimir Podolskii, and Alexander GolovnevThis book supplements the DM for CS Specialization at Coursera and contains many interactive puzzles, autograded quizzes, and code snippets. They are intended to help you to discover important ideas in discrete mathematics on your own. By purchasing the book, you will get all updates of the book free of charge when they are released.
- #9
Practical FP in Scala: A hands-on approach
Gabriel VolpeA 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.
- #10
Atomic Kotlin
Bruce Eckel and Svetlana IsakovaFor both beginning and experienced programmers! From the author of the multi-award-winning Thinking in C++ and Thinking in Java and a Kotlin team member comes a book that breaks concepts into small, easy-to-digest "atoms," along with exercises supported by hints and solutions directly inside IntelliJ IDEA! Full support at www.AtomicKotlin.com.
- #11
Ansible for DevOps
Jeff GeerlingAnsible is a simple, but powerful, server and configuration management tool. Learn to use Ansible effectively, whether you manage one server—or thousands.
- #12
R Programming for Data Science
Roger D. PengThis book brings the fundamentals of R programming to you, using the same material developed as part of the industry-leading Johns Hopkins Data Science Specialization. The skills taught in this book will lay the foundation for you to begin your journey learning data science. Printed copies of this book are available through Lulu.
- #13
Learning Algorithms Through Programming and Puzzle Solving
Alexander S. Kulikov and Pavel PevznerThis book powers our MicroMasters program on edX and specialization on Coursera, one of the ten most popular computer science courses on Coursera. Over half a million students have tried to solve many programming challenges and algorithmic puzzles described in this book. We invite you to join them! See the webpage of the book for more details.
- #14
C++ Best Practices
Jason TurnerLevel up your C++, get the tools working for you, eliminate common problems, and move on to more exciting things!
- #15
Advanced Web Application Architecture
Matthias NobackThe missing manual for making your web applications future-proof
- #16
Introducing EventStorming
Alberto BrandoliniThe deepest tutorial and explanation about EventStorming, straight from the inventor.
- #17
Thinking with Types
Sandy MaguireThis book aims to be the comprehensive manual for type-level programming. It's about getting you from here to there---from a competent Haskell programmer to one who convinces the compiler to do their work for them.
- #18
The Technological Future of Medical Specialties - 2021 Edition
Dr. Bertalan MeskoHow will the appearance of AI, sensors, wearables, VR/AR or robots affect each medical specialty? How can physicians of the various professions successfully prepare for the sweeping changes coming with the waves of technology? Read the eBook to find out
45-day Money-back guarantee: If you're not satisfied, simply return the book & get a full refund
- #19
The Hundred-Page Machine Learning Book
Andriy BurkovEverything you really need to know in Machine Learning in a hundred pages.
- #20
CCDE Practice Design Scenarios
Marwan AlshawiCreated by the author of the official 'CCDE Study Guide' book, and reviewed by CCDE Experts
By purchasing this book here, you will be entitled to all the updates and new additions to this book. These updates and additions are going to be very frequent to keep this book always as an interesting and valuable resource.
Top Bundles
- #1
Software Architecture for Developers: Volumes 1 & 2 - Technical leadership and communication
2 Books
"Software Architecture for Developers" is a practical and pragmatic guide to modern, lightweight software architecture, specifically aimed at developers. You'll learn:The essence of software architecture.Why the software architecture role should include coding, coaching and collaboration.The things that you really need to think about before... - #2
CCIE Service Provider Ultimate Study Bundle
2 Books
Piotr Jablonski, Lukasz Bromirski, and Nick Russo have joined forces to deliver the only CCIE Service Provider training resource you'll ever need. This bundle contains a detailed and challenging collection of workbook labs, plus an extensively detailed technical reference guide. All of us have earned the CCIE Service Provider certification... - #3
Software Architecture and Design Practice Reference
2 Books
Dive deeper in Software Architecture with the Design Practice Reference. Learn all about software architecture and design from the books in this bundle:Software Architecture covers topics from quality attributes to designing and modeling components, interfaces, connectors, and containers, all the way to services and microservices. The Design... - #4
All the Books of The Medical Futurist
6 Books
We put together the most popular books from The Medical Futurist to provide a clear picture about the major trends shaping the future of medicine and healthcare. Digital health technologies, artificial intelligence, the future of 20 medical specialties, big pharma, data privacy, digital health investments and how technology giants such as Amazon... - #6
Growing Agile: The Complete Coach's Guide
7 Books
Growing Agile: Coach's Guide Series This bundle provides a collection of training and workshop plans for a variety of agile topics. The series is aimed at agile coaches, trainers and ScrumMasters who often find themselves needing to help teams understand agile concepts. Each book in the series provides the plans, slides, handouts and activity... - #8
9 Books-Bundle: Shut Up and Code!
9 Books
"Shut up and code." Laughter in the audience. The hacker had just plugged in his notebook and started sharing his screen to present his super-smart Python script. "Shut up and code" The letters written in a white literal coding font on black background was the hackers' home screen background mantra. At the time, I was a first-year computer...
