Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3,792 changes: 1,896 additions & 1,896 deletions docs/docs-ref-autogen/excelscript/excelscript.chartseries.yml

Large diffs are not rendered by default.

7 changes: 3 additions & 4 deletions docs/docs-ref-autogen/excelscript/excelscript.range.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1002,8 +1002,7 @@ methods:
summary: >-
Returns a range object that includes the current range and up to the edge
of the range, based on the provided direction. This matches the
<kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>Arrow key</kbd> behavior in the
Excel on Windows UI.
Ctrl+Shift+Arrow key behavior in the Excel on Windows UI.
remarks: ''

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

isPreview: false
Expand Down
86 changes: 17 additions & 69 deletions docs/docs-ref-autogen/officescript.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ name: OfficeScript
type: package
summary: ''
interfaces:
- OfficeScript!OfficeScript.DownloadFileProperties:interface
- OfficeScript!OfficeScript.EmailAttachment:interface
- OfficeScript!OfficeScript.FileProperties:interface
- OfficeScript!OfficeScript.MailProperties:interface
enums:
- OfficeScript!OfficeScript.EmailContentType:enum
Expand All @@ -14,39 +14,21 @@ functions:
- name: OfficeScript.convertToPdf()
uid: OfficeScript!OfficeScript.convertToPdf:function(1)
package: OfficeScript!
summary: >-
Converts the document to a PDF and returns the text encoding of it. Note:
Recent changes made to the workbook in Excel on the web, through Office
Scripts or the Excel UI, may not be captured in the PDF.
summary: Converts the document to a PDF and returns the text encoding of it.
remarks: ''

isPreview: true
isPreview: false
isDeprecated: false
syntax:
content: 'export function convertToPdf(): string;'
return:
type: string
description: >-
description: |-
The content of the workbook as a string, in PDF format.


**Throws**: `ConvertToPdfEmptyWorkbook` The error thrown if the
document is empty.


**Throws**: `ConvertToPdfProtectedWorkbook` The error thrown if
the document is protected.


**Throws**: `ExternalApiTimeout` The error thrown if the API
reaches the timeout limit of 30 seconds.


#### Examples


```TypeScript

/**
* This script saves a worksheet as a PDF and emails that PDF to a recipient.
*/
Expand All @@ -63,7 +45,6 @@ functions:
attachments: [pdfFile]
})
}

```
- name: OfficeScript.downloadFile(fileProperties)
uid: OfficeScript!OfficeScript.downloadFile:function(1)
Expand All @@ -73,31 +54,18 @@ functions:
the local machine.
remarks: ''

isPreview: true
isPreview: false
isDeprecated: false
syntax:
content: 'export function downloadFile(fileProperties: FileProperties): void;'
content: >-
export function downloadFile(fileProperties: DownloadFileProperties):
void;
parameters:
- id: fileProperties
description: >-
The file to download.


**Throws**: `DownloadFileNameMissing` The error thrown if the
name is empty.


**Throws**: `DownloadFileContentMissing` The error thrown if the
content is empty.


**Throws**: `DownloadFileInvalidExtension` The error thrown if
the file name extension is not ".txt" or ".pdf".


**Throws**: `ExternalApiTimeout` The error thrown if the API
reaches the timeout limit of 30 seconds.
type: <xref uid="OfficeScript!OfficeScript.FileProperties:interface" />
description: The file to download.
type: >-
<xref
uid="OfficeScript!OfficeScript.DownloadFileProperties:interface" />
return:
type: void
description: ''
Expand All @@ -107,7 +75,7 @@ functions:
summary: Get the name of the currently running script.
remarks: ''

isPreview: true
isPreview: false
isDeprecated: false
syntax:
content: 'export function getScriptName(): string;'
Expand All @@ -119,10 +87,11 @@ functions:
package: OfficeScript!
summary: >-
Saves a copy of the current workbook in OneDrive, in the same directory as
the original file, with the specified file name.
the original file, with the specified file name. This API must be called
before other APIs.
remarks: ''

isPreview: true
isPreview: false
isDeprecated: false
syntax:
content: 'export function saveCopyAs(filename: string): void;'
Expand All @@ -131,27 +100,6 @@ functions:
description: >-
The file name of the copied and saved file. The file name must end
with ".xlsx".


**Throws**: `InvalidExtensionError` The error thrown if the file
name doesn't end with ".xlsx".


**Throws**: `SaveCopyAsFileMayAlreadyExistError` The error
thrown if the file name of the copy already exists.


**Throws**: `SaveCopyAsErrorInvalidCharacters` The error thrown
if the file name contains invalid characters.


**Throws**: `SaveCopyAsFileNotOnOneDriveError` The error thrown
if the document is not saved to OneDrive.


**Throws**: `ExternalApiTimeout` The error thrown if the API
reaches the timeout limit of 30 seconds. Note that the copy may
still be created.
type: string
return:
type: void
Expand All @@ -164,7 +112,7 @@ functions:
content and recipients of the email.
remarks: ''

isPreview: true
isPreview: false
isDeprecated: false
syntax:
content: 'export function sendMail(mailProperties: MailProperties): void;'
Expand Down
Original file line number Diff line number Diff line change
@@ -1,30 +1,30 @@
### YamlMime:TSType
name: OfficeScript.FileProperties
uid: OfficeScript!OfficeScript.FileProperties:interface
### YamlMime:TSType
name: OfficeScript.DownloadFileProperties
uid: OfficeScript!OfficeScript.DownloadFileProperties:interface
package: OfficeScript!
fullName: OfficeScript.FileProperties
fullName: OfficeScript.DownloadFileProperties
summary: The file to download.
remarks: ''

isPreview: true
isPreview: false
isDeprecated: false
type: interface
properties:
- name: content
uid: OfficeScript!OfficeScript.FileProperties#content:member
uid: OfficeScript!OfficeScript.DownloadFileProperties#content:member
package: OfficeScript!
fullName: content
summary: The content of the file.
remarks: ''

isPreview: true
isPreview: false
isDeprecated: false
syntax:
content: 'content: string;'
return:
type: string
- name: name
uid: OfficeScript!OfficeScript.FileProperties#name:member
uid: OfficeScript!OfficeScript.DownloadFileProperties#name:member
package: OfficeScript!
fullName: name
summary: >-
Expand All @@ -33,7 +33,7 @@ properties:
".txt".
remarks: ''

isPreview: true
isPreview: false
isDeprecated: false
syntax:
content: 'name: string;'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ summary: >-
enter a value for at least one of the "to", "cc", or "bcc" parameters."
remarks: ''

isPreview: true
isPreview: false
isDeprecated: false
type: interface
properties:
Expand All @@ -21,7 +21,7 @@ properties:
summary: The contents of the file.
remarks: ''

isPreview: true
isPreview: false
isDeprecated: false
syntax:
content: 'content: string;'
Expand All @@ -36,7 +36,7 @@ properties:
This string doesn't need to match the file name.
remarks: ''

isPreview: true
isPreview: false
isDeprecated: false
syntax:
content: 'name: string;'
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ fullName: OfficeScript.EmailContentType
summary: The type of the content. Possible values are text or HTML.
remarks: ''

isPreview: true
isPreview: false
isDeprecated: false
fields:
- name: html
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ summary: >-
importance values available in the Outlook UI.
remarks: ''

isPreview: true
isPreview: false
isDeprecated: false
fields:
- name: high
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ fullName: OfficeScript.MailProperties
summary: The properties of the email to be sent.
remarks: ''

isPreview: true
isPreview: false
isDeprecated: false
type: interface
properties:
Expand All @@ -19,7 +19,7 @@ properties:
Optional.
remarks: ''

isPreview: true
isPreview: false
isDeprecated: false
syntax:
content: 'attachments?: EmailAttachment | EmailAttachment[];'
Expand All @@ -36,7 +36,7 @@ properties:
Optional.
remarks: ''

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

isPreview: true
isPreview: false
isDeprecated: false
syntax:
content: 'cc?: string | string[];'
Expand All @@ -62,7 +62,7 @@ properties:
summary: The content of the email. Optional.
remarks: ''

isPreview: true
isPreview: false
isDeprecated: false
syntax:
content: 'content?: string;'
Expand All @@ -77,7 +77,7 @@ properties:
Optional.
remarks: ''

isPreview: true
isPreview: false
isDeprecated: false
syntax:
content: 'contentType?: EmailContentType;'
Expand All @@ -93,7 +93,7 @@ properties:
Optional.
remarks: ''

isPreview: true
isPreview: false
isDeprecated: false
syntax:
content: 'importance?: EmailImportance;'
Expand All @@ -106,7 +106,7 @@ properties:
summary: The subject of the email. Optional.
remarks: ''

isPreview: true
isPreview: false
isDeprecated: false
syntax:
content: 'subject?: string;'
Expand All @@ -119,7 +119,7 @@ properties:
summary: The direct recipient or recipients of the email. Optional.
remarks: ''

isPreview: true
isPreview: false
isDeprecated: false
syntax:
content: 'to?: string | string[];'
Expand Down
4 changes: 2 additions & 2 deletions docs/docs-ref-autogen/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -653,9 +653,9 @@ items:
uid: OfficeScript!OfficeScript.EmailContentType:enum
- name: EmailImportance
uid: OfficeScript!OfficeScript.EmailImportance:enum
- name: DownloadFileProperties
uid: OfficeScript!OfficeScript.DownloadFileProperties:interface
- name: EmailAttachment
uid: OfficeScript!OfficeScript.EmailAttachment:interface
- name: FileProperties
uid: OfficeScript!OfficeScript.FileProperties:interface
- name: MailProperties
uid: OfficeScript!OfficeScript.MailProperties:interface
17 changes: 0 additions & 17 deletions docs/includes/officescript-preview.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,2 @@
| Class | Fields | Description |
|:---|:---|:---|
|*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.|
||[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.|
||[getScriptName()](/javascript/api/office-scripts/officescript#officescript-officescript-getscriptname-function(1))|Get the name of the currently running script.|
||[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.|
||[sendMail(mailProperties: MailProperties)](/javascript/api/office-scripts/officescript#officescript-officescript-sendmail-function(1))|Send an email with an Office Script.|
|[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.|
||[name](/javascript/api/office-scripts/officescript/officescript.emailattachment#officescript-officescript-emailattachment-name-member)|The text that is displayed below the icon representing the attachment.|
|[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.|
||[name](/javascript/api/office-scripts/officescript/officescript.fileproperties#officescript-officescript-fileproperties-name-member)|The name of the file once downloaded.|
|[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.|
||[bcc](/javascript/api/office-scripts/officescript/officescript.mailproperties#officescript-officescript-mailproperties-bcc-member)|The blind carbon copy (BCC) recipient or recipients of the email.|
||[cc](/javascript/api/office-scripts/officescript/officescript.mailproperties#officescript-officescript-mailproperties-cc-member)|The carbon copy (CC) recipient or recipients of the email.|
||[content](/javascript/api/office-scripts/officescript/officescript.mailproperties#officescript-officescript-mailproperties-content-member)|The content of the email.|
||[contentType](/javascript/api/office-scripts/officescript/officescript.mailproperties#officescript-officescript-mailproperties-contenttype-member)|The type of the content in the email.|
||[importance](/javascript/api/office-scripts/officescript/officescript.mailproperties#officescript-officescript-mailproperties-importance-member)|The importance of the email.|
||[subject](/javascript/api/office-scripts/officescript/officescript.mailproperties#officescript-officescript-mailproperties-subject-member)|The subject of the email.|
||[to](/javascript/api/office-scripts/officescript/officescript.mailproperties#officescript-officescript-mailproperties-to-member)|The direct recipient or recipients of the email.|
Loading