Giter Club home page Giter Club logo

dd-in-commands-samples's Introduction

page_type products languages extensions
sample
office-excel
office-word
office-powerpoint
office-365
typescript
javascript
contentType technologies createdDate
samples
Add-ins
11/6/2015 1:25:00 PM

Office Add-in Commands Samples

Overview

Add-in commands enable developers to extend the Office user interface such as the Office Ribbon to create awesome, efficient to use add-ins. Watch this channel9 video for a complete overview. The examples in this repo show you how to use add-in commands in Excel, Word and PowerPoint add-ins. If you are looking for information about commands for Outlook head to http://dev.outlook.com

Here is how the samples look when running:

Custom Tab (Simple Example)

Excel

Word

Existing Tab

PowerPoint

Quick Start

Step 1. Setup your environment

  • Office Desktop: Ensure that you have the latest version of Office installed. Add-in commands require build 16.0.6769.0000 or higher (16.0.6868.0000 recommended). Learn how to Install the latest version of Office applications.

  • Office Online: There is no additional setup. Please note that support for commands in Office Online for work/school accounts is in preview.

  • Office for Mac: Ensure that you have build 15.33+

Step 2. Create and validate your manifest

We strongly recommend you to use one of our sample manifests as a starting point, the Simple example is a good one to get going. Once you make it work then you can start making small modifications and test your changes often. If you make modifications, use the Manifest reference as a guide. You can also validate your xml using the Office Add-in Validator **. For Office Windows clients you can also use Runtime Logging to debug your manifest.

You can also use the latest Visual Studio Tools to create and debug your add-in. See next step.

Step 3. Deploy add-in manifest and test the add-in

To test your add-in you must register it with Office. Two methods are currently supported:

Sideload directly to the client

  • Office Desktop. Sideload your add-in via a network share.

    • Once sideloaded, go to Insert>My Add-ins>Shared Folder and click the Refresh button to ensure the Add-in shows. Do this any time you need to refresh your Ribbon.
  • Office Online. Open the Add-ins dialog via Insert>Office Add-ins then select [Manage My Add-ins]>Upload My Add-in and upload the manifest file you want to test. To remove a sideloaded add-in you have to clear your HTML LocalStorage

  • Office for Mac. Sideload your add-in on the Mac

    • Once sideloaded, goto Insert>Office Add-ins and click on the add-in to install it.

Visual Studio F5

  • Make sure you have at least version 16.0.6868.0000 of Office for Windows installed.
  • Make sure you have the latest Visual Studio tools.

Once you have the latest, the new VS templates include support for add-in commands. You can also deploy your add-ins to Windows Desktop clients using F5.

Documentation

This project has adopted the Microsoft Open Source Code of Conduct. For more information, see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

dd-in-commands-samples's People

Contributors

lezamax avatar o365devx avatar elizabethsamuel-msft avatar rick-kirkham avatar davidchesnut avatar panjkov avatar ruoyingliang avatar shakosteve avatar stewartadam avatar cf256 avatar

Watchers

James Cloos avatar Derrick Hinz avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.