Skip to content

Latest commit

 

History

History
46 lines (27 loc) · 3.77 KB

RUN_WITH_EXTENSION.md

File metadata and controls

46 lines (27 loc) · 3.77 KB
Raw

Run the add-in with Office Add-ins Development Kit extension

We recommend you try this sample by using the Office Add-ins Development Kit. The Office Add-ins Development Kit is an end-to-end developer tool for building Office Add-ins. It helps create, run, and debug an Office Add-in.

  1. Open the Office Add-ins Development Kit

    Select the Office Add-ins Development Kit icon in the Activity Bar to open the extension.

  2. Preview Your Office Add-in (F5)

    Select Preview Your Office Add-in(F5) to launch the add-in and debug the code. In the drop down menu, select the option Desktop (Edge Chromium).

    Screenshot shows Preview your Office add-in in Office Add-ins Development Kit

    The extension then checks that the prerequisites are met before debugging starts. Check the terminal for detailed information if there are issues with your environment. After this process, the Excel desktop application launches and opens a new workbook with the sample add-in.

  3. Stop Previewing Your Office Add-in

    Once you are finished testing and debugging the add-in, select Stop Previewing Your Office Add-in. This closes the web server and removes the add-in from the registry and cache.

Explore the add-in code

To explore an Office add-in project, you can start with the key files listed below.

  • The ./manifest.xml file in the root directory of the project defines the settings and capabilities of the add-in.
    You can check whether your manifest file is valid by selecting Validate Manifest File option from the Office Add-ins Development Kit.
  • The ./src/taskpane/taskpane.html file contains the HTML markup for the task pane.
  • The ./src/taskpane/taskpane.css file contains the CSS that's applied to content in the task pane.
  • The ./src/taskpane/taskpane.js file contains the Office JavaScript API code that facilitates interaction between the task pane and the Excel application.

Troubleshooting

If you have problems running the sample, take these steps.

  • Close any open instances of Excel.
  • Close the previous web server started for the sample with the Stop Previewing Your Office Add-in Office Add-ins Development Kit extension option.

If you still have problems, see troubleshoot development errors or create a GitHub issue and we'll help you.

For information on running the sample on Excel on the web, see Sideload Office Add-ins to Office on the web.

For information on debugging on older versions of Office, see Debug add-ins using developer tools in Microsoft Edge Legacy.

See also

Once you understand the sample, make it your own! All the information about Office Add-ins is found in our official documentation. You can also explore more samples in the Office Add-ins Development Kit. Select View Samples to see more samples of real-world scenarios.

Did you experience any problems with the sample? Create an issue and we'll help you out.

Want to learn more about new features and best practices for the Office platform? Join the Microsoft Office Add-ins community call.