Skip to content

Latest commit

 

History

History
113 lines (87 loc) · 6.78 KB

README_TEMPLATE.md

File metadata and controls

113 lines (87 loc) · 6.78 KB
Raw

DELETE_PUT_SAMPLE_TITLE_HERE_DELETE

Describe sample functionality, DELETE_EXAMPLE: This sample shows how to insert an existing template from an external Excel file into the currently open Excel file. Then it retrieves data from a JSON web service and populates the template for the customer.

Features

  • DELETE_Features of this sample: which APIs are used, what service is called....
  • DELETE_EXAMPLE: Use insertWorksheetsFromBase64 to insert a worksheet from another Excel file into the open Excel file.
  • DELETE_EXAMPLE: Get JSON data and add it to the worksheet.

How to run this sample

Prerequisites

Run the add-in using Office Add-ins Development Kit

Office Add-ins Development Kit is an end-to end developer tool for building Office add-ins. You can use this tool to easily creating, running and debugging, and managing the lifecycle of an Office add-in.

  1. Check and Install Dependencies

    Select Check and Install Dependencies to check your environment and install necessary dependencies in order to run and debug the add-in code.

  2. Preview Your Office Add-in (F5)

    Select Preview Your Office Add-in(F5) on the side panel to start running and debugging the add-in code. A Word/Excel/PowerPoint app will launch with the add-in sample side-loaded.

    If you meet sideload errors, please first confirm the following items and check troubleshoot development errors for common issues. If you still have problems, Create an issue and we'll help you out.

    • You have installed dependencies.
    • You have closed all Word/Excel/PowerPoint apps.
    • You have stopped your last add-in previewing session.

  3. Stop Previewing Your Office Add-in

    Select Stop Previewing Your Office Add-in to stop debugging.

How to use this sample

You can try out the sample add-in when it is sideloaded on Word/Excel/PowerPoint apps:

  1. DELETE_EXAMPLE: Put the steps about how to use this sample.
  2. DELETE_EXAMPLE: Register an API key in XXXXXX
  3. DELETE_EXAMPLE: Replace the API key in xxxxx.js
  4. DELETE_EXAMPLE

Explore sample files

To explore the components of the add-in project, review the key files listed below.
You can check whether your manifest file is valid by selecting Validate Manifest in the Office Add-ins Development Kit extension tree view.

DELETE_THIS_LINE:Use copilot chat @workspace to generate folder structure

| .eslintrc.json
| .gitignore
| .vscode/
|   | extensions.json
|   | launch.json               Launch and debug configurations
|   | settings.json             
|   | tasks.json                
| assets/                       Static assets like image/gif
| babel.config.json
| manifest.xml                 Manifest file
| package.json                  
| README.md                     Get started here
| SECURITY.md
| src/                          Add-ins source code
|   | commands/
|   |   | commands.html
|   |   | commands.js
|   | taskpane/
|   |   | taskpane.css          Taskpane style
|   |   | taskpane.html         Taskpane entry html
|   |   | taskpane.js           Add API calls and logic here
| webpack.config.js             Webpack config

Make code changes

GitHub Copilot extension for Office Add-ins: DELETE_THIS_LINE: Only shows in projects generated by GitHub Copilot extension.

  1. Type in @office to invoke the extension.
  2. Type in /generatecode and describe the feature you would like to build, then send the request to Copilot.
  3. Get the response from the extension and use the code.

Resources to learn more Office add-ins capabilities:

  • Select View Samples on Office Add-ins Development Kit tree view for real-world examples and code structures.
  • Read the documentation of Office add-ins.

Engage with the team

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

Want to learn more about new features, development practices, and additional information? Join the Microsoft Office Add-ins community call.

Copyright

Copyright (c) 2024 Microsoft Corporation. All rights reserved. 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.
Note: The taskpane.html file contains an image URL that tracks diagnostic data for this sample add-in. Please remove the image tag if you reuse this sample in your own code project.

Disclaimer

THIS CODE IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.