Skip to content

Commit 4033cc3

Browse files
authored
Update packages and preview docs (#405)
* Update packages * Fix throws regex in preprocessor
1 parent 8ed5c49 commit 4033cc3

17 files changed

Lines changed: 2176 additions & 2053 deletions

File tree

docs/docs-ref-autogen/excelscript/excelscript.chartseries.yml

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

docs/docs-ref-autogen/excelscript/excelscript.range.yml

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1002,8 +1002,7 @@ methods:
10021002
summary: >-
10031003
Returns a range object that includes the current range and up to the edge
10041004
of the range, based on the provided direction. This matches the
1005-
<kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Arrow key</kbd> behavior in the
1006-
Excel on Windows UI.
1005+
Ctrl+Shift+Arrow key behavior in the Excel on Windows UI.
10071006
remarks: ''
10081007

10091008
isPreview: false
@@ -1749,8 +1748,8 @@ methods:
17491748
fullName: getRangeEdge(direction, activeCell)
17501749
summary: >-
17511750
Returns a range object that is the edge cell of the data region that
1752-
corresponds to the provided direction. This matches the
1753-
<kbd>Ctrl</kbd>+<kbd>Arrow key</kbd> behavior in the Excel on Windows UI.
1751+
corresponds to the provided direction. This matches the Ctrl+Arrow key
1752+
behavior in the Excel on Windows UI.
17541753
remarks: ''
17551754

17561755
isPreview: false

docs/docs-ref-autogen/officescript.yml

Lines changed: 44 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ name: OfficeScript
44
type: package
55
summary: ''
66
interfaces:
7+
- OfficeScript!OfficeScript.DownloadFileProperties:interface
78
- OfficeScript!OfficeScript.EmailAttachment:interface
8-
- OfficeScript!OfficeScript.FileProperties:interface
99
- OfficeScript!OfficeScript.MailProperties:interface
1010
enums:
1111
- OfficeScript!OfficeScript.EmailContentType:enum
@@ -14,13 +14,10 @@ functions:
1414
- name: OfficeScript.convertToPdf()
1515
uid: OfficeScript!OfficeScript.convertToPdf:function(1)
1616
package: OfficeScript!
17-
summary: >-
18-
Converts the document to a PDF and returns the text encoding of it. Note:
19-
Recent changes made to the workbook in Excel on the web, through Office
20-
Scripts or the Excel UI, may not be captured in the PDF.
17+
summary: Converts the document to a PDF and returns the text encoding of it.
2118
remarks: ''
2219

23-
isPreview: true
20+
isPreview: false
2421
isDeprecated: false
2522
syntax:
2623
content: 'export function convertToPdf(): string;'
@@ -30,16 +27,16 @@ functions:
3027
The content of the workbook as a string, in PDF format.
3128
3229
33-
**Throws**: `ConvertToPdfEmptyWorkbook` The error thrown if the
34-
document is empty.
30+
**Throws**: `ConvertToPdfEmptyWorkbook` Thrown if the document is
31+
empty.
3532
3633
37-
**Throws**: `ConvertToPdfProtectedWorkbook` The error thrown if
38-
the document is protected.
34+
**Throws**: `ConvertToPdfProtectedWorkbook` Thrown if the document
35+
is protected.
3936
4037
41-
**Throws**: `ExternalApiTimeout` The error thrown if the API
42-
reaches the timeout limit of 30 seconds.
38+
**Throws**: `ExternalApiTimeout` Thrown if the API reaches the
39+
timeout limit of 30 seconds.
4340
4441
4542
#### Examples
@@ -73,31 +70,35 @@ functions:
7370
the local machine.
7471
remarks: ''
7572

76-
isPreview: true
73+
isPreview: false
7774
isDeprecated: false
7875
syntax:
79-
content: 'export function downloadFile(fileProperties: FileProperties): void;'
76+
content: >-
77+
export function downloadFile(fileProperties: DownloadFileProperties):
78+
void;
8079
parameters:
8180
- id: fileProperties
8281
description: >-
8382
The file to download.
8483
8584
86-
**Throws**: `DownloadFileNameMissing` The error thrown if the
87-
name is empty.
85+
**Throws**: `DownloadFileNameMissing` Thrown if the name is
86+
empty.
8887
8988
90-
**Throws**: `DownloadFileContentMissing` The error thrown if the
91-
content is empty.
89+
**Throws**: `DownloadFileContentMissing` Thrown if the content
90+
is empty.
9291
9392
94-
**Throws**: `DownloadFileInvalidExtension` The error thrown if
95-
the file name extension is not ".txt" or ".pdf".
93+
**Throws**: `DownloadFileInvalidExtension` Thrown if the file
94+
name extension is not ".txt" or ".pdf".
9695
9796
98-
**Throws**: `ExternalApiTimeout` The error thrown if the API
99-
reaches the timeout limit of 30 seconds.
100-
type: <xref uid="OfficeScript!OfficeScript.FileProperties:interface" />
97+
**Throws**: `ExternalApiTimeout` Thrown if the API reaches the
98+
timeout limit of 30 seconds.
99+
type: >-
100+
<xref
101+
uid="OfficeScript!OfficeScript.DownloadFileProperties:interface" />
101102
return:
102103
type: void
103104
description: ''
@@ -107,7 +108,7 @@ functions:
107108
summary: Get the name of the currently running script.
108109
remarks: ''
109110

110-
isPreview: true
111+
isPreview: false
111112
isDeprecated: false
112113
syntax:
113114
content: 'export function getScriptName(): string;'
@@ -119,10 +120,11 @@ functions:
119120
package: OfficeScript!
120121
summary: >-
121122
Saves a copy of the current workbook in OneDrive, in the same directory as
122-
the original file, with the specified file name.
123+
the original file, with the specified file name. This API must be called
124+
before other APIs.
123125
remarks: ''
124126

125-
isPreview: true
127+
isPreview: false
126128
isDeprecated: false
127129
syntax:
128130
content: 'export function saveCopyAs(filename: string): void;'
@@ -133,25 +135,29 @@ functions:
133135
with ".xlsx".
134136
135137
136-
**Throws**: `InvalidExtensionError` The error thrown if the file
137-
name doesn't end with ".xlsx".
138+
**Throws**: `SaveCopyAsInvalidExtension` Thrown if the file name
139+
doesn't end with ".xlsx".
140+
141+
142+
**Throws**: `SaveCopyAsMustBeCalledFirst` Thrown if this method
143+
is called after other APIs.
138144
139145
140-
**Throws**: `SaveCopyAsFileMayAlreadyExistError` The error
141-
thrown if the file name of the copy already exists.
146+
**Throws**: `SaveCopyAsFileMayAlreadyExist` Thrown if the file
147+
name of the copy already exists.
142148
143149
144-
**Throws**: `SaveCopyAsErrorInvalidCharacters` The error thrown
145-
if the file name contains invalid characters.
150+
**Throws**: `SaveCopyAsInvalidCharacters` Thrown if the file
151+
name contains invalid characters.
146152
147153
148-
**Throws**: `SaveCopyAsFileNotOnOneDriveError` The error thrown
149-
if the document is not saved to OneDrive.
154+
**Throws**: `SaveCopyAsFileNotOnOneDrive` Thrown if the document
155+
is not saved to OneDrive.
150156
151157
152-
**Throws**: `ExternalApiTimeout` The error thrown if the API
153-
reaches the timeout limit of 30 seconds. Note that the copy may
154-
still be created.
158+
**Throws**: `ExternalApiTimeout` Thrown if the API reaches the
159+
timeout limit of 30 seconds. Note that the copy may still be
160+
created.
155161
type: string
156162
return:
157163
type: void
@@ -164,7 +170,7 @@ functions:
164170
content and recipients of the email.
165171
remarks: ''
166172

167-
isPreview: true
173+
isPreview: false
168174
isDeprecated: false
169175
syntax:
170176
content: 'export function sendMail(mailProperties: MailProperties): void;'

docs/docs-ref-autogen/officescript/officescript.fileproperties.yml renamed to docs/docs-ref-autogen/officescript/officescript.downloadfileproperties.yml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,30 @@
1-
### YamlMime:TSType
2-
name: OfficeScript.FileProperties
3-
uid: OfficeScript!OfficeScript.FileProperties:interface
1+
### YamlMime:TSType
2+
name: OfficeScript.DownloadFileProperties
3+
uid: OfficeScript!OfficeScript.DownloadFileProperties:interface
44
package: OfficeScript!
5-
fullName: OfficeScript.FileProperties
5+
fullName: OfficeScript.DownloadFileProperties
66
summary: The file to download.
77
remarks: ''
88

9-
isPreview: true
9+
isPreview: false
1010
isDeprecated: false
1111
type: interface
1212
properties:
1313
- name: content
14-
uid: OfficeScript!OfficeScript.FileProperties#content:member
14+
uid: OfficeScript!OfficeScript.DownloadFileProperties#content:member
1515
package: OfficeScript!
1616
fullName: content
1717
summary: The content of the file.
1818
remarks: ''
1919

20-
isPreview: true
20+
isPreview: false
2121
isDeprecated: false
2222
syntax:
2323
content: 'content: string;'
2424
return:
2525
type: string
2626
- name: name
27-
uid: OfficeScript!OfficeScript.FileProperties#name:member
27+
uid: OfficeScript!OfficeScript.DownloadFileProperties#name:member
2828
package: OfficeScript!
2929
fullName: name
3030
summary: >-
@@ -33,7 +33,7 @@ properties:
3333
".txt".
3434
remarks: ''
3535

36-
isPreview: true
36+
isPreview: false
3737
isDeprecated: false
3838
syntax:
3939
content: 'name: string;'

docs/docs-ref-autogen/officescript/officescript.emailattachment.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ summary: >-
1010
enter a value for at least one of the "to", "cc", or "bcc" parameters."
1111
remarks: ''
1212

13-
isPreview: true
13+
isPreview: false
1414
isDeprecated: false
1515
type: interface
1616
properties:
@@ -21,7 +21,7 @@ properties:
2121
summary: The contents of the file.
2222
remarks: ''
2323

24-
isPreview: true
24+
isPreview: false
2525
isDeprecated: false
2626
syntax:
2727
content: 'content: string;'
@@ -36,7 +36,7 @@ properties:
3636
This string doesn't need to match the file name.
3737
remarks: ''
3838

39-
isPreview: true
39+
isPreview: false
4040
isDeprecated: false
4141
syntax:
4242
content: 'name: string;'

docs/docs-ref-autogen/officescript/officescript.emailcontenttype.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ fullName: OfficeScript.EmailContentType
66
summary: The type of the content. Possible values are text or HTML.
77
remarks: ''
88

9-
isPreview: true
9+
isPreview: false
1010
isDeprecated: false
1111
fields:
1212
- name: html

docs/docs-ref-autogen/officescript/officescript.emailimportance.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ summary: >-
88
importance values available in the Outlook UI.
99
remarks: ''
1010

11-
isPreview: true
11+
isPreview: false
1212
isDeprecated: false
1313
fields:
1414
- name: high

docs/docs-ref-autogen/officescript/officescript.mailproperties.yml

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ fullName: OfficeScript.MailProperties
66
summary: The properties of the email to be sent.
77
remarks: ''
88

9-
isPreview: true
9+
isPreview: false
1010
isDeprecated: false
1111
type: interface
1212
properties:
@@ -19,7 +19,7 @@ properties:
1919
Optional.
2020
remarks: ''
2121

22-
isPreview: true
22+
isPreview: false
2323
isDeprecated: false
2424
syntax:
2525
content: 'attachments?: EmailAttachment | EmailAttachment[];'
@@ -36,7 +36,7 @@ properties:
3636
Optional.
3737
remarks: ''
3838

39-
isPreview: true
39+
isPreview: false
4040
isDeprecated: false
4141
syntax:
4242
content: 'bcc?: string | string[];'
@@ -49,7 +49,7 @@ properties:
4949
summary: The carbon copy (CC) recipient or recipients of the email. Optional.
5050
remarks: ''
5151

52-
isPreview: true
52+
isPreview: false
5353
isDeprecated: false
5454
syntax:
5555
content: 'cc?: string | string[];'
@@ -62,7 +62,7 @@ properties:
6262
summary: The content of the email. Optional.
6363
remarks: ''
6464

65-
isPreview: true
65+
isPreview: false
6666
isDeprecated: false
6767
syntax:
6868
content: 'content?: string;'
@@ -77,7 +77,7 @@ properties:
7777
Optional.
7878
remarks: ''
7979

80-
isPreview: true
80+
isPreview: false
8181
isDeprecated: false
8282
syntax:
8383
content: 'contentType?: EmailContentType;'
@@ -93,7 +93,7 @@ properties:
9393
Optional.
9494
remarks: ''
9595

96-
isPreview: true
96+
isPreview: false
9797
isDeprecated: false
9898
syntax:
9999
content: 'importance?: EmailImportance;'
@@ -106,7 +106,7 @@ properties:
106106
summary: The subject of the email. Optional.
107107
remarks: ''
108108

109-
isPreview: true
109+
isPreview: false
110110
isDeprecated: false
111111
syntax:
112112
content: 'subject?: string;'
@@ -119,7 +119,7 @@ properties:
119119
summary: The direct recipient or recipients of the email. Optional.
120120
remarks: ''
121121

122-
isPreview: true
122+
isPreview: false
123123
isDeprecated: false
124124
syntax:
125125
content: 'to?: string | string[];'

docs/docs-ref-autogen/toc.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -653,9 +653,9 @@ items:
653653
uid: OfficeScript!OfficeScript.EmailContentType:enum
654654
- name: EmailImportance
655655
uid: OfficeScript!OfficeScript.EmailImportance:enum
656+
- name: DownloadFileProperties
657+
uid: OfficeScript!OfficeScript.DownloadFileProperties:interface
656658
- name: EmailAttachment
657659
uid: OfficeScript!OfficeScript.EmailAttachment:interface
658-
- name: FileProperties
659-
uid: OfficeScript!OfficeScript.FileProperties:interface
660660
- name: MailProperties
661661
uid: OfficeScript!OfficeScript.MailProperties:interface
Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,2 @@
11
| Class | Fields | Description |
22
|:---|:---|:---|
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.|
5-
||[getScriptName()](/javascript/api/office-scripts/officescript#officescript-officescript-getscriptname-function(1))|Get the name of the currently running script.|
6-
||[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.|
7-
||[sendMail(mailProperties: MailProperties)](/javascript/api/office-scripts/officescript#officescript-officescript-sendmail-function(1))|Send an email with an Office Script.|
8-
|[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.|
9-
||[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.|
12-
|[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.|
13-
||[bcc](/javascript/api/office-scripts/officescript/officescript.mailproperties#officescript-officescript-mailproperties-bcc-member)|The blind carbon copy (BCC) recipient or recipients of the email.|
14-
||[cc](/javascript/api/office-scripts/officescript/officescript.mailproperties#officescript-officescript-mailproperties-cc-member)|The carbon copy (CC) recipient or recipients of the email.|
15-
||[content](/javascript/api/office-scripts/officescript/officescript.mailproperties#officescript-officescript-mailproperties-content-member)|The content of the email.|
16-
||[contentType](/javascript/api/office-scripts/officescript/officescript.mailproperties#officescript-officescript-mailproperties-contenttype-member)|The type of the content in the email.|
17-
||[importance](/javascript/api/office-scripts/officescript/officescript.mailproperties#officescript-officescript-mailproperties-importance-member)|The importance of the email.|
18-
||[subject](/javascript/api/office-scripts/officescript/officescript.mailproperties#officescript-officescript-mailproperties-subject-member)|The subject of the email.|
19-
||[to](/javascript/api/office-scripts/officescript/officescript.mailproperties#officescript-officescript-mailproperties-to-member)|The direct recipient or recipients of the email.|

0 commit comments

Comments
 (0)