officedev / add-in-content-sample Goto Github PK

   ____            _             _        _       _     _       _
  / ___|___  _ __ | |_ ___ _ __ | |_     / \   __| | __| |     (_)_ __  
 | |   / _ \| '_ \| __/ _ \ '_ \| __|   / _ \ / _` |/ _` |_____| | '_ \
 | |__| (_) | | | | ||  __/ | | | |_   / ___ \ (_| | (_| |_____| | | | |
  \____\___/|_| |_|\__\___|_| |_|\__| /_/   \_\__,_|\__,_|     |_|_| |_|

This sample showcases a simple add-in for Office that lets you get data from a document.

Follow these steps to run the sample:

1. Host these files on a local network share.

2. Open up an Office app (Excel or PowerPoint), open a document, and then select File > Options > Trust Center > Trust Center Settings > Trusted Add-in Catalogs. (On Office 2013, it is called "Trusted App Catalogs")

3. Type the location of the directory on your local network share into the Catalog Url text field, and click Add Catalog. Make sure the Show in Menu check box is selected.

4. Click OK. Close the Office app and launch it again so the changes take effect.

5. Go to Insert > My Apps > Shared Folder and select My First Content Add-in, and then click Insert. If you don't see the add-in, click Refresh.

6. The add-in is inserted in the middle of your document.

For more information, please read Sideload Office Add-ins on Windows

1. Host these files locally (on localhost) or online (e.g. AWS, Azure, Heroku, etc). In the manifest.xml file, change the DefaultValue of the SourceLocation to point to the URL where the index.html file is hosted.

2. Go to the Office 365 portal (https://portal.office.com) and click on Admin in the app launcher on the top left hand corner.

Note: You need to already have a subscription to Office 365. If you don't have one, Join the Office 365 Developer Program and get a free 1 year subscription to Office 365.

3. Select SharePoint > apps > App Catalog > Apps for Office. (If you don't have an App Catalog site, you need to create one.)

4. Select the "+" button to add a new add-in, and choose the manifest.xml file from your local directory. Press OK and the add-in will install.

5. Open the app launcher on the top left hand corner and select an Office app (Excel).

6. When the Office app opens, go to Insert > Apps for Office and select My First Content Add-in under My Organization. If you don't see the add-in, press Refresh. Press Insert and the add-in should appear.

For more information on publishing Office Add-ins, please read Sideload Office Add-ins in Office Online.

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.