Skip to content
This repository has been archived by the owner on Jun 17, 2024. It is now read-only.

Latest commit

 

History

History
154 lines (120 loc) · 7.98 KB

README.md

File metadata and controls

154 lines (120 loc) · 7.98 KB
Raw

OfficeJS Snippet Explorer

This Office Add-in sample uses Angular. It lets you explore and modify code snippets for ExcelJS and WordJS. You can browse the code snippets at these two locations:

IntelliSense is enabled so that you can see which properties and methods are available on each object. We highly suggest that you run this sample in Excel and Word after you browse the available snippets. The next two sections will show you how you can make this add-in available in Excel and Word.

Run OfficeJS Snippet Explorer in Excel 2016

Do the following steps to run this sample in Excel 2016:

  1. Create a folder on a network share called manifests.

  2. Create a file called snippet-explorer-excelJS.xml and place the following content in it:

    <?xml version="1.0" encoding="utf-8"?>
<OfficeApp xmlns="http://schemas.microsoft.com/office/appforoffice/1.1" 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:type="TaskPaneApp">
  <Id>6492a0e5-b158-47da-9145-6804c67ed8d9</Id>
  <Version>1.0</Version>
  <ProviderName>Microsoft</ProviderName>
  <DefaultLocale>EN-US</DefaultLocale>
  <DisplayName DefaultValue="excel-js-snippet-explorer"/>
  <Description DefaultValue="Contains snippets for ExcelJS."/>
  <Hosts>
    <Host Name="Workbook"/>
  </Hosts>

  <DefaultSettings>
    <SourceLocation DefaultValue="https://officesnippetexplorer.azurewebsites.net/#/add-in/excel"/>

  </DefaultSettings>
  <Permissions>ReadWriteDocument</Permissions>
</OfficeApp>

  3. Replace the guid in the <id> element with a guid you generate. Save the file.

  4. Open Excel 2016 with a new workbook.

  5. Select File > Options > Trust Center > Trust Center Settings > Trusted Add-in Catalogs.

  6. In the Catalog Url field, add the url to the manifests folder you created on the network share. Select the Add catalog button.

  7. Check the Show in menu button and then select OK.

  8. Select Insert > My Add-ins > Shared Folder.

  9. Select the add-in named excel-js-snippet-explorer and select Insert. The add-in will load.

  10. You can now run the code samples. We suggest that you play with the snippets in the code editor to see what you can do with ExcelJS.

Run OfficeJS Snippet Explorer in Word 2016

Do the following steps to run this sample in Word 2016:

  1. Create a folder on a network share called manifests.

  2. Create a file called snippet-explorer-wordJS.xml and place the following content in it:

    <?xml version="1.0" encoding="utf-8"?>
<OfficeApp xmlns="http://schemas.microsoft.com/office/appforoffice/1.1" 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:type="TaskPaneApp">
  <Id>6492a0e5-b158-47da-9145-6804c67ed8d9</Id>
  <Version>1.0</Version>
  <ProviderName>Microsoft</ProviderName>
  <DefaultLocale>EN-US</DefaultLocale>
  <DisplayName DefaultValue="word-js-snippet-explorer"/>
  <Description DefaultValue="Contains snippets for WordJS."/>
  <Hosts>
    <Host Name="Document"/>
  </Hosts>

  <DefaultSettings>
    <SourceLocation DefaultValue="https://officesnippetexplorer.azurewebsites.net/#/add-in/word"/>

  </DefaultSettings>
  <Permissions>ReadWriteDocument</Permissions>
</OfficeApp>

  3. Replace the guid in the <id> element with a guid you generate. Save the file.

  4. Open Word 2016 with a new document.

  5. Select File > Options > Trust Center > Trust Center Settings > Trusted Add-in Catalogs.

  6. In the Catalog Url field, add the url to the manifests folder you created on the network share. Select the Add catalog button.

  7. Check the Show in menu button and then select OK.

  8. Select Insert > My Add-ins > Shared Folder.

  9. Select the add-in named word-js-snippet-explorer and select Insert. The add-in will load.

  10. You can now run the code samples. We suggest that you play with the snippets in the code editor to see what you can do with WordJS.

Run OfficeJS Snippet Explorer in OneNote

Do the following steps to run this sample in OneNote:

  1. Create a file called snippet-explorer-onenote.xml and place the following content in it:

    <?xml version="1.0" encoding="utf-8"?>
<OfficeApp xmlns="http://schemas.microsoft.com/office/appforoffice/1.1" 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xsi:type="TaskPaneApp">
  <Id>6492a0e5-b158-47da-9145-6804c67ed8d9</Id>
  <Version>1.0</Version>
  <ProviderName>Microsoft</ProviderName>
  <DefaultLocale>EN-US</DefaultLocale>
  <DisplayName DefaultValue="onenote-js-snippet-explorer"/>
  <Description DefaultValue="Contains snippets for OneNoteJS."/>
  <Hosts>
    <Host Name="Notebook"/>
  </Hosts>

  <DefaultSettings>
    <SourceLocation DefaultValue="https://officesnippetexplorer.azurewebsites.net/#/add-in/onenote"/>

  </DefaultSettings>
  <Permissions>ReadWriteDocument</Permissions>
</OfficeApp>

  2. Replace the guid in the <id> element with a guid you generate. Save the file.

  3. Browse to onedrive.com and create a new notebook (or open an existing one)

  4. Select Insert > Upload Add-ins.

  5. Select the add-in named snippet-explorer-onenote.xml from step (1). The add-in will load.

  6. You can now run the code samples. We suggest that you play with the snippets in the code editor to see what you can do with OneNoteJS.

Contributing

You will need to sign a Contributor License Agreement before submitting your pull request. To complete the Contributor License Agreement (CLA), you will need to submit a request via the form and then electronically sign the Contributor License Agreement when you receive the email containing the link to the document.

This sample is open for pull requests to add snippets to this repository. You can add to the snippets in either the excel-snippets or word-snippets directories. Here's what you do to add a snippet:

  1. Create a fork of this repository.

  2. Create a JS file in the excel-snippets or word-snippets directory with a descriptive name. Take a look at the existing file names for ideas on how you should name the file.

  3. Add your snippet to the file.

  4. Open samples.json.

  5. Add an entry to the values array. Your entry will look like:

    { "done": true, "filename": "YOURFILENAME", "name": "DISPLAYNAME", "group": "GROUPNAMEFROMGROUPS", "description": "ASIMPLEDESCRIPTION"}

  6. Replace the value for the filename, name, group, and description fields with information that describes your snippet. The filename should take the form of {object}{method}{description}.js. The object name is required -- this makes the list of snippets easy to peruse. For example: paragraphClear.js or rangeInsertText.js.

  7. Save all of your changes, test it, push it, and open your pull request.

Additional resources

Learn more about these APIs by reading the documentation.

Visit http://dev.office.com for all your Office 365 Development needs