Skip to content

Commit 2f1e319

Browse files
authored
Merge pull request #385 from OfficeDev/main
[Admin] Publish
2 parents 3e848f5 + f2dead7 commit 2f1e319

File tree

345 files changed

+1615
-1517
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

345 files changed

+1615
-1517
lines changed

.openpublishing.publish.config.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@
5454
},
5555
"JoinTOCPlugin": [
5656
{
57-
"ReferenceTOC": "docs/docs-ref-autogen/excel/toc.yml",
57+
"ReferenceTOC": "docs/docs-ref-autogen/toc.yml",
5858
"ConceptualTOCUrl": "/office/dev/scripts/toc.json"
5959
}
6060
],

docs/docfx.json

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -56,15 +56,7 @@
5656
"**/*.yml"
5757
],
5858
"group": "office-scripts",
59-
"src": "docs-ref-autogen/excel",
60-
"dest": "api/office-scripts"
61-
},
62-
{
63-
"files": [
64-
"excel.yml"
65-
],
66-
"group": "office-scripts",
67-
"src": "docs-ref-autogen/excel",
59+
"src": "docs-ref-autogen",
6860
"dest": "api/office-scripts"
6961
},
7062
{

docs/docs-ref-autogen/excel/excelscript/excelscript.cellcontrol.yml

Lines changed: 0 additions & 25 deletions
This file was deleted.

docs/docs-ref-autogen/excel/excelscript/global.officescript.emailcontenttype.yml

Lines changed: 0 additions & 21 deletions
This file was deleted.

docs/docs-ref-autogen/excel/excelscript.yml renamed to docs/docs-ref-autogen/excelscript.yml

Lines changed: 1 addition & 121 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
### YamlMime:TSPackage
1+
### YamlMime:TSPackage
22
uid: ExcelScript!
33
name: ExcelScript
44
type: package
@@ -150,8 +150,6 @@ enums:
150150
- ExcelScript!ExcelScript.VerticalAlignment:enum
151151
- ExcelScript!ExcelScript.WorkbookLinksRefreshMode:enum
152152
- ExcelScript!ExcelScript.WorksheetPositionType:enum
153-
- ExcelScript!Global.OfficeScript.EmailContentType:enum
154-
- ExcelScript!Global.OfficeScript.EmailImportance:enum
155153
interfaces:
156154
- ExcelScript!ExcelScript.AllowEditRange:interface
157155
- ExcelScript!ExcelScript.AllowEditRangeOptions:interface
@@ -321,123 +319,5 @@ interfaces:
321319
- ExcelScript!ExcelScript.WorksheetProtection:interface
322320
- ExcelScript!ExcelScript.WorksheetProtectionOptions:interface
323321
- ExcelScript!ExcelScript.WorksheetSearchCriteria:interface
324-
- ExcelScript!Global.OfficeScript.EmailAttachment:interface
325-
- ExcelScript!Global.OfficeScript.MailProperties:interface
326322
typeAliases:
327323
- ExcelScript!ExcelScript.CellControl:type
328-
functions:
329-
- name: Global.OfficeScript.convertToPdf()
330-
uid: ExcelScript!Global.OfficeScript.convertToPdf:function(1)
331-
package: ExcelScript!
332-
summary: >-
333-
Return the text encoding of the document as a PDF. If the document is
334-
empty, then the following error is shown: "We didn't find anything to
335-
print". Some actions made prior to using this API may not be captured in
336-
the PDF in Excel on the web.
337-
remarks: ''
338-
339-
isPreview: true
340-
isDeprecated: false
341-
syntax:
342-
content: 'export function convertToPdf(): string;'
343-
return:
344-
type: string
345-
description: The content of the workbook as a string, in PDF format.
346-
- name: |-
347-
Global.OfficeScript.downloadFile({
348-
name,
349-
content,
350-
})
351-
uid: ExcelScript!Global.OfficeScript.downloadFile:function(1)
352-
package: ExcelScript!
353-
summary: >-
354-
Downloads a specified file to the default download location specified by
355-
the local machine.
356-
remarks: ''
357-
358-
isPreview: true
359-
isDeprecated: false
360-
syntax:
361-
content: |-
362-
export function downloadFile({
363-
name,
364-
content,
365-
}: {
366-
name: string;
367-
content: string;
368-
}): void;
369-
parameters:
370-
- id: |-
371-
{
372-
name,
373-
content,
374-
}
375-
description: ''
376-
type: |-
377-
{
378-
name: string;
379-
content: string;
380-
}
381-
return:
382-
type: void
383-
description: ''
384-
- name: Global.OfficeScript.Metadata.getScriptName()
385-
uid: ExcelScript!Global.OfficeScript.Metadata.getScriptName:function(1)
386-
package: ExcelScript!
387-
summary: Get the current executing scripts name.
388-
remarks: ''
389-
390-
isPreview: true
391-
isDeprecated: false
392-
syntax:
393-
content: 'export function getScriptName(): string;'
394-
return:
395-
type: string
396-
description: ''
397-
- name: Global.OfficeScript.saveCopyAs(filename)
398-
uid: ExcelScript!Global.OfficeScript.saveCopyAs:function(1)
399-
package: ExcelScript!
400-
summary: >-
401-
Saves a copy of the current workbook in OneDrive, in the same directory as
402-
the original file, with the specified file name. The API has a timeout
403-
limit of 30 seconds. This limit is rarely exceeded. Note: Timeout doesn't
404-
necessarily indicate that the API failed. The workbook copy may still be
405-
created, but after the timeout limit this API does not return a success or
406-
failure message.
407-
remarks: ''
408-
409-
isPreview: true
410-
isDeprecated: false
411-
syntax:
412-
content: 'export function saveCopyAs(filename: string): void;'
413-
parameters:
414-
- id: filename
415-
description: >-
416-
The file name of the copied and saved file. The file name must end
417-
with ".xlsx".
418-
type: string
419-
return:
420-
type: void
421-
description: ''
422-
- name: Global.OfficeScript.sendMail(mailProperties)
423-
uid: ExcelScript!Global.OfficeScript.sendMail:function(1)
424-
package: ExcelScript!
425-
summary: >-
426-
Send an email with an Office Script. Use `MailProperties` to specify the
427-
content and recipients of the email. If the request body includes content,
428-
this method returns 400 Bad request.
429-
remarks: ''
430-
431-
isPreview: true
432-
isDeprecated: false
433-
syntax:
434-
content: 'export function sendMail(mailProperties: MailProperties): void;'
435-
parameters:
436-
- id: mailProperties
437-
description: ''
438-
type: >-
439-
<xref uid="ExcelScript!Global.OfficeScript.MailProperties:interface"
440-
/>
441-
return:
442-
type: void
443-
description: ''

docs/docs-ref-autogen/excel/excelscript/excelscript.aggregationfunction.yml renamed to docs/docs-ref-autogen/excelscript/excelscript.aggregationfunction.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
### YamlMime:TSEnum
1+
### YamlMime:TSEnum
22
name: ExcelScript.AggregationFunction
33
uid: ExcelScript!ExcelScript.AggregationFunction:enum
44
package: ExcelScript!

docs/docs-ref-autogen/excel/excelscript/excelscript.alloweditrange.yml renamed to docs/docs-ref-autogen/excelscript/excelscript.alloweditrange.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
### YamlMime:TSType
1+
### YamlMime:TSType
22
name: ExcelScript.AllowEditRange
33
uid: ExcelScript!ExcelScript.AllowEditRange:interface
44
package: ExcelScript!

docs/docs-ref-autogen/excel/excelscript/excelscript.alloweditrangeoptions.yml renamed to docs/docs-ref-autogen/excelscript/excelscript.alloweditrangeoptions.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
### YamlMime:TSType
1+
### YamlMime:TSType
22
name: ExcelScript.AllowEditRangeOptions
33
uid: ExcelScript!ExcelScript.AllowEditRangeOptions:interface
44
package: ExcelScript!

docs/docs-ref-autogen/excel/excelscript/excelscript.application.yml renamed to docs/docs-ref-autogen/excelscript/excelscript.application.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
### YamlMime:TSType
1+
### YamlMime:TSType
22
name: ExcelScript.Application
33
uid: ExcelScript!ExcelScript.Application:interface
44
package: ExcelScript!

docs/docs-ref-autogen/excel/excelscript/excelscript.arrowheadlength.yml renamed to docs/docs-ref-autogen/excelscript/excelscript.arrowheadlength.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
### YamlMime:TSEnum
1+
### YamlMime:TSEnum
22
name: ExcelScript.ArrowheadLength
33
uid: ExcelScript!ExcelScript.ArrowheadLength:enum
44
package: ExcelScript!

0 commit comments

Comments
 (0)