Skip to content

Commit 2a2a254

Browse files
authored
Merge branch 'main' into alison-mk-intellisense-120425
2 parents a15328c + 5fa7bd9 commit 2a2a254

File tree

15 files changed

+3789
-4361
lines changed

15 files changed

+3789
-4361
lines changed

docs/docs-ref-autogen/preview-apis.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@ New Office Scripts APIs are first introduced in "preview", and then later releas
1414
1515
## API list
1616

17-
The following table lists the Office Scripts APIs currently in preview.
17+
Office Scripts APIs use two namespaces: `OfficeScript` for APIs that are not connected to an Excel workbook, and `ExcelScript` for APIs that work with Excel workbooks. Currently, the only preview APIs are in the `OfficeScript` namespace. The following section lists those APIs.
18+
19+
### OfficeScript namespace
1820

1921
<!-- [!INCLUDE[API table](../includes/officescript-preview.md)] -->
2022

docs/includes/officescript-preview.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
| Class | Fields | Description |
22
|:---|:---|:---|
3-
|*global*|[convertToPdf()](/javascript/api/office-scripts/officescript#officescript-officescript-converttopdf-function(1))|Return the text encoding of the document as a PDF.|
4-
||[downloadFile({ name, content, }: { name: string content: string })](/javascript/api/office-scripts/officescript#officescript-officescript-downloadfile-function(1))|Downloads a specified file to the default download location specified by the local machine.|
3+
|*global*|[convertToPdf()](/javascript/api/office-scripts/officescript#officescript-officescript-converttopdf-function(1))|Converts the document to a PDF and returns the text encoding of it.|
4+
||[downloadFile(fileProperties: FileProperties)](/javascript/api/office-scripts/officescript#officescript-officescript-downloadfile-function(1))|Downloads a specified file to the default download location specified by the local machine.|
55
||[getScriptName()](/javascript/api/office-scripts/officescript#officescript-officescript-getscriptname-function(1))|Get the name of the currently running script.|
66
||[saveCopyAs(filename: string)](/javascript/api/office-scripts/officescript#officescript-officescript-savecopyas-function(1))|Saves a copy of the current workbook in OneDrive, in the same directory as the original file, with the specified file name.|
77
||[sendMail(mailProperties: MailProperties)](/javascript/api/office-scripts/officescript#officescript-officescript-sendmail-function(1))|Send an email with an Office Script.|
88
|[EmailAttachment](/javascript/api/office-scripts/officescript/officescript.emailattachment)|[content](/javascript/api/office-scripts/officescript/officescript.emailattachment#officescript-officescript-emailattachment-content-member)|The contents of the file.|
99
||[name](/javascript/api/office-scripts/officescript/officescript.emailattachment#officescript-officescript-emailattachment-name-member)|The text that is displayed below the icon representing the attachment.|
10+
|[FileProperties](/javascript/api/office-scripts/officescript/officescript.fileproperties)|[content](/javascript/api/office-scripts/officescript/officescript.fileproperties#officescript-officescript-fileproperties-content-member)|The content of the file.|
11+
||[name](/javascript/api/office-scripts/officescript/officescript.fileproperties#officescript-officescript-fileproperties-name-member)|The name of the file once downloaded.|
1012
|[MailProperties](/javascript/api/office-scripts/officescript/officescript.mailproperties)|[attachments](/javascript/api/office-scripts/officescript/officescript.mailproperties#officescript-officescript-mailproperties-attachments-member)|A file (such as a text file or Excel workbook) attached to a message.|
1113
||[bcc](/javascript/api/office-scripts/officescript/officescript.mailproperties#officescript-officescript-mailproperties-bcc-member)|The blind carbon copy (BCC) recipient or recipients of the email.|
1214
||[cc](/javascript/api/office-scripts/officescript/officescript.mailproperties#officescript-officescript-mailproperties-cc-member)|The carbon copy (CC) recipient or recipients of the email.|

generate-docs/API Coverage Report.csv

Lines changed: 3453 additions & 3446 deletions
Large diffs are not rendered by default.

generate-docs/api-extractor-inputs-excelscript-release/tsdoc-metadata.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"toolPackages": [
66
{
77
"packageName": "@microsoft/api-extractor",
8-
"packageVersion": "7.52.11"
8+
"packageVersion": "7.53.1"
99
}
1010
]
1111
}

generate-docs/api-extractor-inputs-excelscript/tsdoc-metadata.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"toolPackages": [
66
{
77
"packageName": "@microsoft/api-extractor",
8-
"packageVersion": "7.52.11"
8+
"packageVersion": "7.53.1"
99
}
1010
]
1111
}

generate-docs/api-extractor-inputs-officescript-release/officescript.d.ts

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,11 @@ export declare namespace OfficeScript {
33

44

55

6-
6+
7+
8+
9+
10+
711

812

913

generate-docs/api-extractor-inputs-officescript-release/tsdoc-metadata.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"toolPackages": [
66
{
77
"packageName": "@microsoft/api-extractor",
8-
"packageVersion": "7.52.11"
8+
"packageVersion": "7.53.1"
99
}
1010
]
1111
}

generate-docs/api-extractor-inputs-officescript/tsdoc-metadata.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"toolPackages": [
66
{
77
"packageName": "@microsoft/api-extractor",
8-
"packageVersion": "7.52.11"
8+
"packageVersion": "7.53.1"
99
}
1010
]
1111
}

generate-docs/office-scripts-link-config.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
{
2+
"includeEnums": false,
23
"linkConfigs": [
34
{
45
"name": "Office Scripts",

0 commit comments

Comments
 (0)