Created
May 12, 2022 18:25
-
-
Save SLAPaper/afe390bcb4e4fa06485e1e1ab2b26f94 to your computer and use it in GitHub Desktop.
Performs a basic Excel API call using TypeScript.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Basic API call (TypeScript) | |
description: Performs a basic Excel API call using TypeScript. | |
host: EXCEL | |
api_set: {} | |
script: | |
content: | | |
$("#run").click(() => tryCatch(run)); | |
async function run() { | |
await Excel.run(async (context) => { | |
const range = context.workbook.getSelectedRange(); | |
range.format.fill.load("color"); | |
await context.sync(); | |
if (range.format.fill.color != "#FFFFFF") { | |
range.format.fill.clear(); | |
} else { | |
range.format.fill.color = "yellow"; | |
} | |
range.load("address"); | |
await context.sync(); | |
console.log(`The range address was "${range.address}".`); | |
}); | |
} | |
/** Default helper for invoking an action and handling errors. */ | |
async function tryCatch(callback) { | |
try { | |
await callback(); | |
} catch (error) { | |
// Note: In a production add-in, you'd want to notify the user through your add-in's UI. | |
console.error(error); | |
} | |
} | |
language: typescript | |
template: | |
content: |- | |
<section class="ms-font-m"> | |
<p class="ms-font-m">This sample demonstrates basic Excel API calls.</p> | |
</section> | |
<section class="samples ms-font-m"> | |
<h3>Try it out</h3> | |
<p class="ms-font-m">Select some cells in the worksheet, then press <b>Highlight selected range</b>.</p> | |
<button id="run" class="ms-Button"> | |
<span class="ms-Button-label">Toggle highlight selected range</span> | |
</button> | |
</section> | |
language: html | |
style: | |
content: |- | |
section.samples { | |
margin-top: 20px; | |
} | |
section.samples .ms-Button, section.setup .ms-Button { | |
display: block; | |
margin-bottom: 5px; | |
margin-left: 20px; | |
min-width: 80px; | |
} | |
language: css | |
libraries: | | |
https://appsforoffice.microsoft.com/lib/1/hosted/office.js | |
@types/office-js | |
office-ui-fabric-js@1.4.0/dist/css/fabric.min.css | |
office-ui-fabric-js@1.4.0/dist/css/fabric.components.min.css | |
core-js@2.4.1/client/core.min.js | |
@types/core-js | |
jquery@3.1.1 | |
@types/jquery@3.3.1 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment