From 5c9679edbd068c2fa4a00f0e97d3d1027d70fa24 Mon Sep 17 00:00:00 2001 From: Alison McKay Date: Tue, 2 Sep 2025 15:22:04 -0700 Subject: [PATCH] [all hosts] Get latest from CDN (#2338) --- docs/docs-ref-autogen/excel/excel.yml | 15 +++-- .../excel/excel/excel.cardlayout.yml | 11 +++- .../excel/excel/excel.cardlayoutsection.yml | 12 +++- .../excel/excel/excel.cellcontrol.yml | 42 ++++++++++++- .../excel/excel/excel.cellvalue.yml | 25 +++++++- .../excel.cellvalueandpropertymetadata.yml | 11 +++- .../excel/excel/excel.compactlayout.yml | 10 +++- .../excel/excel/excel.entitypropertytype.yml | 11 +++- .../excel/excel/excel.errorcellvalue.yml | 59 ++++++++++++++++++- .../excel/excel/excel.functioncellvalue.yml | 10 +++- .../excel.notavailableerrorcellvalue.yml | 6 +- ...xcel.notavailableerrorcellvaluesubtype.yml | 20 +++---- .../excel/excel/excel.range.yml | 14 +++-- .../excel/excel/excel.referencedvalue.yml | 15 ++++- .../excel/excel/excel.workbook.yml | 15 +++-- docs/docs-ref-autogen/excel_1_10/excel.yml | 15 +++-- docs/docs-ref-autogen/excel_1_11/excel.yml | 15 +++-- docs/docs-ref-autogen/excel_1_12/excel.yml | 15 +++-- docs/docs-ref-autogen/excel_1_13/excel.yml | 15 +++-- .../excel_1_13/excel/excel.range.yml | 14 +++-- .../excel_1_13/excel/excel.workbook.yml | 15 +++-- docs/docs-ref-autogen/excel_1_14/excel.yml | 15 +++-- .../excel_1_14/excel/excel.range.yml | 14 +++-- .../excel_1_14/excel/excel.workbook.yml | 15 +++-- docs/docs-ref-autogen/excel_1_15/excel.yml | 15 +++-- .../excel_1_15/excel/excel.range.yml | 14 +++-- .../excel_1_15/excel/excel.workbook.yml | 15 +++-- docs/docs-ref-autogen/excel_1_16/excel.yml | 15 +++-- .../excel_1_16/excel/excel.cardlayout.yml | 10 +++- .../excel/excel.cardlayoutsection.yml | 11 +++- .../excel_1_16/excel/excel.cellvalue.yml | 21 ++++++- .../excel.cellvalueandpropertymetadata.yml | 11 +++- .../excel_1_16/excel/excel.compactlayout.yml | 10 +++- .../excel/excel.entitypropertytype.yml | 11 +++- .../excel_1_16/excel/excel.errorcellvalue.yml | 57 +++++++++++++++++- .../excel.notavailableerrorcellvalue.yml | 6 +- .../excel_1_16/excel/excel.range.yml | 14 +++-- .../excel/excel.referencedvalue.yml | 15 ++++- .../excel_1_16/excel/excel.workbook.yml | 15 +++-- docs/docs-ref-autogen/excel_1_17/excel.yml | 15 +++-- .../excel_1_17/excel/excel.cardlayout.yml | 10 +++- .../excel/excel.cardlayoutsection.yml | 11 +++- .../excel_1_17/excel/excel.cellvalue.yml | 21 ++++++- .../excel.cellvalueandpropertymetadata.yml | 11 +++- .../excel_1_17/excel/excel.compactlayout.yml | 10 +++- .../excel/excel.entitypropertytype.yml | 11 +++- .../excel_1_17/excel/excel.errorcellvalue.yml | 57 +++++++++++++++++- .../excel.notavailableerrorcellvalue.yml | 6 +- .../excel_1_17/excel/excel.range.yml | 14 +++-- .../excel/excel.referencedvalue.yml | 15 ++++- .../excel_1_17/excel/excel.workbook.yml | 15 +++-- docs/docs-ref-autogen/excel_1_18/excel.yml | 15 +++-- .../excel_1_18/excel/excel.cardlayout.yml | 10 +++- .../excel/excel.cardlayoutsection.yml | 11 +++- .../excel_1_18/excel/excel.cellcontrol.yml | 42 ++++++++++++- .../excel_1_18/excel/excel.cellvalue.yml | 21 ++++++- .../excel.cellvalueandpropertymetadata.yml | 11 +++- .../excel_1_18/excel/excel.compactlayout.yml | 10 +++- .../excel/excel.entitypropertytype.yml | 11 +++- .../excel_1_18/excel/excel.errorcellvalue.yml | 57 +++++++++++++++++- .../excel.notavailableerrorcellvalue.yml | 6 +- .../excel_1_18/excel/excel.range.yml | 14 +++-- .../excel/excel.referencedvalue.yml | 15 ++++- .../excel_1_18/excel/excel.workbook.yml | 15 +++-- docs/docs-ref-autogen/excel_1_19/excel.yml | 15 +++-- .../excel_1_19/excel/excel.cardlayout.yml | 10 +++- .../excel/excel.cardlayoutsection.yml | 12 +++- .../excel_1_19/excel/excel.cellcontrol.yml | 42 ++++++++++++- .../excel_1_19/excel/excel.cellvalue.yml | 23 +++++++- .../excel.cellvalueandpropertymetadata.yml | 11 +++- .../excel_1_19/excel/excel.compactlayout.yml | 10 +++- .../excel/excel.entitypropertytype.yml | 11 +++- .../excel_1_19/excel/excel.errorcellvalue.yml | 57 +++++++++++++++++- .../excel/excel.functioncellvalue.yml | 10 +++- .../excel.notavailableerrorcellvalue.yml | 6 +- .../excel_1_19/excel/excel.range.yml | 14 +++-- .../excel/excel.referencedvalue.yml | 15 ++++- .../excel_1_19/excel/excel.workbook.yml | 15 +++-- docs/docs-ref-autogen/excel_1_8/excel.yml | 15 +++-- docs/docs-ref-autogen/excel_1_9/excel.yml | 15 +++-- docs/docs-ref-autogen/excel_online/excel.yml | 15 +++-- .../excel_online/excel/excel.cardlayout.yml | 10 +++- .../excel/excel.cardlayoutsection.yml | 12 +++- .../excel_online/excel/excel.cellcontrol.yml | 42 ++++++++++++- .../excel_online/excel/excel.cellvalue.yml | 23 +++++++- .../excel.cellvalueandpropertymetadata.yml | 11 +++- .../excel/excel.compactlayout.yml | 10 +++- .../excel/excel.entitypropertytype.yml | 11 +++- .../excel/excel.errorcellvalue.yml | 57 +++++++++++++++++- .../excel/excel.functioncellvalue.yml | 10 +++- .../excel.notavailableerrorcellvalue.yml | 6 +- .../excel_online/excel/excel.range.yml | 14 +++-- .../excel/excel.referencedvalue.yml | 15 ++++- .../excel_online/excel/excel.workbook.yml | 15 +++-- generate-docs/API Coverage Report.csv | 2 +- .../Excel_1_10/excel.d.ts | 1 + .../Excel_1_11/excel.d.ts | 1 + .../Excel_1_12/excel.d.ts | 1 + .../Excel_1_13/excel.d.ts | 14 +++-- .../Excel_1_14/excel.d.ts | 14 +++-- .../Excel_1_15/excel.d.ts | 14 +++-- .../Excel_1_16/excel.d.ts | 18 +++--- .../Excel_1_17/excel.d.ts | 18 +++--- .../Excel_1_18/excel.d.ts | 18 +++--- .../Excel_1_19/excel.d.ts | 18 +++--- .../Excel_1_8/excel.d.ts | 1 + .../Excel_1_9/excel.d.ts | 1 + .../Excel_online/excel.d.ts | 18 +++--- .../api-extractor-inputs-excel/excel.d.ts | 38 ++++++------ generate-docs/script-inputs/office.d.ts | 18 +++--- .../script-inputs/office_preview.d.ts | 38 ++++++------ 111 files changed, 1493 insertions(+), 355 deletions(-) diff --git a/docs/docs-ref-autogen/excel/excel.yml b/docs/docs-ref-autogen/excel/excel.yml index 622dbb624b..feafe80f34 100644 --- a/docs/docs-ref-autogen/excel/excel.yml +++ b/docs/docs-ref-autogen/excel/excel.yml @@ -1141,11 +1141,16 @@ functions: package: excel! summary: >- Creates and opens a new workbook. Optionally, the workbook can be - pre-populated with a Base64-encoded .xlsx file. Note: Macros can be a - security risk. If this API is used to create a workbook that includes a - macro, the add-in user will be prompted with a "Trust this add-in?" dialog - in the Excel UI. The user must select the "Trust add-in" button to - proceed. + pre-populated with a Base64-encoded .xlsx file. The `extensionHardening` + Windows registry key affects the `base64File` param. The file extension + defined by the param must match the real file type of the file. If + `extensionHardening` is set to deny mismatches and the file extension does + not match the real file type, this API throws the following error: "This + operation is not allowed due to the extension hardening policy." Note: + Macros can be a security risk. If this API is used to create a workbook + that includes a macro, the add-in user will be prompted with a "Trust this + add-in?" dialog in the Excel UI. The user must select the "Trust add-in" + button to proceed. \[ [API set: ExcelApi diff --git a/docs/docs-ref-autogen/excel/excel/excel.cardlayout.yml b/docs/docs-ref-autogen/excel/excel/excel.cardlayout.yml index 13bd37ee71..ad538d6d8e 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.cardlayout.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.cardlayout.yml @@ -4,7 +4,16 @@ uid: excel!Excel.CardLayout:type package: excel! fullName: Excel.CardLayout summary: Represents the layout of a card in card view. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout), [Excel.EntityArrayCardLayout](/javascript/api/excel/excel.entityarraycardlayout)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout), + [Excel.EntityArrayCardLayout](/javascript/api/excel/excel.entityarraycardlayout) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excel/excel.cardlayoutsection.yml b/docs/docs-ref-autogen/excel/excel/excel.cardlayoutsection.yml index 5491f6727f..cca1b0c56e 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.cardlayoutsection.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.cardlayoutsection.yml @@ -4,7 +4,17 @@ uid: excel!Excel.CardLayoutSection:type package: excel! fullName: Excel.CardLayoutSection summary: Represents the layout of a section of a card in card view. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection), [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection), [Excel.CardLayoutTwoColumnSection](/javascript/api/excel/excel.cardlayouttwocolumnsection)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection), + [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection), + [Excel.CardLayoutTwoColumnSection](/javascript/api/excel/excel.cardlayouttwocolumnsection) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excel/excel.cellcontrol.yml b/docs/docs-ref-autogen/excel/excel/excel.cellcontrol.yml index ecd03dccf2..5e5954d3df 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.cellcontrol.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.cellcontrol.yml @@ -4,7 +4,47 @@ uid: excel!Excel.CellControl:type package: excel! fullName: Excel.CellControl summary: Represents an interactable control inside of a cell. -remarks: "\\[ [API set: ExcelApi 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\n\n\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.UnknownCellControl](/javascript/api/excel/excel.unknowncellcontrol), [Excel.EmptyCellControl](/javascript/api/excel/excel.emptycellcontrol), [Excel.MixedCellControl](/javascript/api/excel/excel.mixedcellcontrol), [Excel.CheckboxCellControl](/javascript/api/excel/excel.checkboxcellcontrol)\r\n\r\n#### Examples\n\n```TypeScript\n// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml\n\n// Add checkboxes to the table.\nawait Excel.run(async (context) => {\n const sheet = context.workbook.worksheets.getActiveWorksheet();\n\n // Get the second column in the table, without the header.\n const range = sheet.tables.getItem(\"FruitTable\").columns.getItem(\"Analysis\").getDataBodyRange();\n\n // Change the boolean values to checkboxes.\n range.control = {\n type: Excel.CellControlType.checkbox\n };\n await context.sync();\n});\n```" +remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + + + Learn more about the types in this type alias through the following links. + + + [Excel.UnknownCellControl](/javascript/api/excel/excel.unknowncellcontrol), + [Excel.EmptyCellControl](/javascript/api/excel/excel.emptycellcontrol), + [Excel.MixedCellControl](/javascript/api/excel/excel.mixedcellcontrol), + [Excel.CheckboxCellControl](/javascript/api/excel/excel.checkboxcellcontrol) + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml + + + // Add checkboxes to the table. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Get the second column in the table, without the header. + const range = sheet.tables.getItem("FruitTable").columns.getItem("Analysis").getDataBodyRange(); + + // Change the boolean values to checkboxes. + range.control = { + type: Excel.CellControlType.checkbox + }; + await context.sync(); + }); + + ``` isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excel/excel.cellvalue.yml b/docs/docs-ref-autogen/excel/excel/excel.cellvalue.yml index 62429faa0a..57f85ca484 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.cellvalue.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.cellvalue.yml @@ -4,7 +4,30 @@ uid: excel!Excel.CellValue:type package: excel! fullName: Excel.CellValue summary: Represents the value in a cell. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue), [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), [Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue), [Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue), [Excel.ExternalCodeServiceObjectCellValue](/javascript/api/excel/excel.externalcodeserviceobjectcellvalue), [Excel.FormattedNumberCellValue](/javascript/api/excel/excel.formattednumbercellvalue), [Excel.FunctionCellValue](/javascript/api/excel/excel.functioncellvalue), [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue), [Excel.LocalImageCellValue](/javascript/api/excel/excel.localimagecellvalue), [Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue), [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), [Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue), [Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue), [Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), + [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue), + [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), + [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), + [Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue), + [Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue), + [Excel.ExternalCodeServiceObjectCellValue](/javascript/api/excel/excel.externalcodeserviceobjectcellvalue), + [Excel.FormattedNumberCellValue](/javascript/api/excel/excel.formattednumbercellvalue), + [Excel.FunctionCellValue](/javascript/api/excel/excel.functioncellvalue), + [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue), + [Excel.LocalImageCellValue](/javascript/api/excel/excel.localimagecellvalue), + [Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue), + [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), + [Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue), + [Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue), + [Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excel/excel.cellvalueandpropertymetadata.yml b/docs/docs-ref-autogen/excel/excel/excel.cellvalueandpropertymetadata.yml index 566432a914..5f661bb32f 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.cellvalueandpropertymetadata.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.cellvalueandpropertymetadata.yml @@ -6,7 +6,16 @@ fullName: Excel.CellValueAndPropertyMetadata summary: >- Represents the value and metadata of a property. The metadata applies to the property (and not the value), but it is combined with the value in this type. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValue](/javascript/api/excel/excel.cellvalue), [Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CellValue](/javascript/api/excel/excel.cellvalue), + [Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excel/excel.compactlayout.yml b/docs/docs-ref-autogen/excel/excel/excel.compactlayout.yml index 3f25496779..5bb689c662 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.compactlayout.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.compactlayout.yml @@ -6,7 +6,15 @@ fullName: Excel.CompactLayout summary: >- Represents the layout used when there is limited space to represent the entity. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excel/excel.entitypropertytype.yml b/docs/docs-ref-autogen/excel/excel/excel.entitypropertytype.yml index 41a8cc7fcf..bc54a6eff6 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.entitypropertytype.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.entitypropertytype.yml @@ -4,7 +4,16 @@ uid: excel!Excel.EntityPropertyType:type package: excel! fullName: Excel.EntityPropertyType summary: Represents the value of a property. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata), [Excel.CellValue](/javascript/api/excel/excel.cellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata), + [Excel.CellValue](/javascript/api/excel/excel.cellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excel/excel.errorcellvalue.yml b/docs/docs-ref-autogen/excel/excel/excel.errorcellvalue.yml index cd381f72c8..f5e56306dd 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.errorcellvalue.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.errorcellvalue.yml @@ -4,7 +4,64 @@ uid: excel!Excel.ErrorCellValue:type package: excel! fullName: Excel.ErrorCellValue summary: Represents a cell value which contains an error. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\n\n\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue), [Excel.BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue), [Excel.CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue), [Excel.ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue), [Excel.Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue), [Excel.ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue), [Excel.FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue), [Excel.GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue), [Excel.NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue), [Excel.NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue), [Excel.NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue), [Excel.NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue), [Excel.PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue), [Excel.PythonErrorCellValue](/javascript/api/excel/excel.pythonerrorcellvalue), [Excel.RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue), [Excel.SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue), [Excel.TimeoutErrorCellValue](/javascript/api/excel/excel.timeouterrorcellvalue), [Excel.ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue)\r\n\r\n#### Examples\n\n```TypeScript\n// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml\n\n// This function sets the value of cell A1 to a #BUSY! error using data types.\nawait Excel.run(async (context) => {\n // Retrieve the Sample worksheet and cell A1 on that sheet.\n const sheet = context.workbook.worksheets.getItemOrNullObject(\"Sample\");\n const range = sheet.getRange(\"A1\");\n\n // Get the error data type and set its type to `busy`.\n const error: Excel.ErrorCellValue = {\n type: Excel.CellValueType.error,\n errorType: Excel.ErrorCellValueType.busy\n };\n\n // Set cell A1 as the busy error.\n range.valuesAsJson = [[error]];\n await context.sync();\n});\n```" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + + + Learn more about the types in this type alias through the following links. + + + [Excel.BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue), + [Excel.BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue), + [Excel.CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue), + [Excel.ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue), + [Excel.Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue), + [Excel.ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue), + [Excel.FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue), + [Excel.GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue), + [Excel.NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue), + [Excel.NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue), + [Excel.NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue), + [Excel.NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue), + [Excel.PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue), + [Excel.PythonErrorCellValue](/javascript/api/excel/excel.pythonerrorcellvalue), + [Excel.RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue), + [Excel.SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue), + [Excel.TimeoutErrorCellValue](/javascript/api/excel/excel.timeouterrorcellvalue), + [Excel.ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue) + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml + + + // This function sets the value of cell A1 to a #BUSY! error using data types. + + await Excel.run(async (context) => { + // Retrieve the Sample worksheet and cell A1 on that sheet. + const sheet = context.workbook.worksheets.getItemOrNullObject("Sample"); + const range = sheet.getRange("A1"); + + // Get the error data type and set its type to `busy`. + const error: Excel.ErrorCellValue = { + type: Excel.CellValueType.error, + errorType: Excel.ErrorCellValueType.busy + }; + + // Set cell A1 as the busy error. + range.valuesAsJson = [[error]]; + await context.sync(); + }); + + ``` isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excel/excel.functioncellvalue.yml b/docs/docs-ref-autogen/excel/excel/excel.functioncellvalue.yml index 50b7239609..b1f83d2ff4 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.functioncellvalue.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.functioncellvalue.yml @@ -4,7 +4,15 @@ uid: excel!Excel.FunctionCellValue:type package: excel! fullName: Excel.FunctionCellValue summary: Represents a cell value which can be evaluated as a function. -remarks: "\\[ [API set: ExcelApi 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.JavaScriptCustomFunctionReferenceCellValue](/javascript/api/excel/excel.javascriptcustomfunctionreferencecellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.JavaScriptCustomFunctionReferenceCellValue](/javascript/api/excel/excel.javascriptcustomfunctionreferencecellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excel/excel.notavailableerrorcellvalue.yml b/docs/docs-ref-autogen/excel/excel/excel.notavailableerrorcellvalue.yml index cf47303c1d..4153e80174 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.notavailableerrorcellvalue.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.notavailableerrorcellvalue.yml @@ -3,7 +3,7 @@ name: Excel.NotAvailableErrorCellValue uid: excel!Excel.NotAvailableErrorCellValue:interface package: excel! fullName: Excel.NotAvailableErrorCellValue -summary: Represents the value of a cell containing a \#N/A! error. +summary: Represents the value of a cell containing a \#N/A error. remarks: >- \[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] @@ -48,9 +48,9 @@ properties: isPreview: false isDeprecated: false syntax: - content: 'basicValue?: "#N/A!" | string;' + content: 'basicValue?: "#N/A" | string;' return: - type: '"#N/A!" | string' + type: '"#N/A" | string' - name: errorSubType uid: excel!Excel.NotAvailableErrorCellValue#errorSubType:member package: excel! diff --git a/docs/docs-ref-autogen/excel/excel/excel.notavailableerrorcellvaluesubtype.yml b/docs/docs-ref-autogen/excel/excel/excel.notavailableerrorcellvaluesubtype.yml index 3fd09742e8..e1529765be 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.notavailableerrorcellvaluesubtype.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.notavailableerrorcellvaluesubtype.yml @@ -3,7 +3,7 @@ name: Excel.NotAvailableErrorCellValueSubType uid: excel!Excel.NotAvailableErrorCellValueSubType:enum package: excel! fullName: Excel.NotAvailableErrorCellValueSubType -summary: Represents types of \#N/A! errors. +summary: Represents types of \#N/A errors. remarks: >- \[ [API set: ExcelApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] @@ -15,7 +15,7 @@ fields: uid: excel!Excel.NotAvailableErrorCellValueSubType.eRegexMatchNoCapture:member package: excel! summary: >- - No capture groups were matched. Displays as error type \#N/A! in Excel. + No capture groups were matched. Displays as error type \#N/A in Excel. * \[ [API set: ExcelApi BETA (PREVIEW @@ -27,7 +27,7 @@ fields: package: excel! summary: >- No match was found for the pattern in the text provided. Displays as error - type \#N/A! in Excel. + type \#N/A in Excel. * \[ [API set: ExcelApi BETA (PREVIEW @@ -40,7 +40,7 @@ fields: package: excel! summary: >- Occurrence is greater than the total number of matches. Displays as error - type \#N/A! in Excel. + type \#N/A in Excel. * \[ [API set: ExcelApi BETA (PREVIEW @@ -52,7 +52,7 @@ fields: package: excel! summary: >- An error caused by `HLOOKUP` not finding its `lookup_value` in the search - range. Displays as error type \#N/A! in Excel. + range. Displays as error type \#N/A in Excel. * \[ [API set: ExcelApi BETA (PREVIEW @@ -64,7 +64,7 @@ fields: package: excel! summary: >- An error caused by an external code service returning an unknown object. - Displays as error type \#N/A! in Excel. + Displays as error type \#N/A in Excel. * \[ [API set: ExcelApi BETA (PREVIEW @@ -77,7 +77,7 @@ fields: package: excel! summary: >- An error caused by an invalid property argument to `STOCKHISTORY`. - Displays as error type \#N/A! in Excel. + Displays as error type \#N/A in Excel. * \[ [API set: ExcelApi BETA (PREVIEW @@ -89,7 +89,7 @@ fields: package: excel! summary: >- An error caused by no data being available for a `STOCKHISTORY` function. - Displays as error type \#N/A! in Excel. + Displays as error type \#N/A in Excel. * \[ [API set: ExcelApi BETA (PREVIEW @@ -100,7 +100,7 @@ fields: uid: excel!Excel.NotAvailableErrorCellValueSubType.unknown:member package: excel! summary: >- - An unknown type of error. Displays as error type \#N/A! in Excel. + An unknown type of error. Displays as error type \#N/A in Excel. * \[ [API set: ExcelApi BETA (PREVIEW @@ -112,7 +112,7 @@ fields: package: excel! summary: >- An error caused by `VLOOKUP` not finding its `lookup_value` in the search - range. Displays as error type \#N/A! in Excel. + range. Displays as error type \#N/A in Excel. * \[ [API set: ExcelApi BETA (PREVIEW diff --git a/docs/docs-ref-autogen/excel/excel/excel.range.yml b/docs/docs-ref-autogen/excel/excel/excel.range.yml index 8b6e770ae1..0ae0df5a37 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.range.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.range.yml @@ -2120,7 +2120,8 @@ 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 - Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. + Ctrl+Shift+Arrow key behavior in the + Excel on Windows UI. remarks: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) @@ -2185,7 +2186,8 @@ 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 - Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. + Ctrl+Shift+Arrow key behavior in the + Excel on Windows UI. remarks: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) @@ -2701,8 +2703,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 Ctrl+Arrow key - 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: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) @@ -2766,8 +2768,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 Ctrl+Arrow key - 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: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) diff --git a/docs/docs-ref-autogen/excel/excel/excel.referencedvalue.yml b/docs/docs-ref-autogen/excel/excel/excel.referencedvalue.yml index 57044e8ebe..168b4928ba 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.referencedvalue.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.referencedvalue.yml @@ -4,7 +4,20 @@ uid: excel!Excel.ReferencedValue:type package: excel! fullName: Excel.ReferencedValue summary: Represents the value in a cell. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), [Excel.RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue), [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), + [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), + [Excel.RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue), + [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), + [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), + [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel/excel/excel.workbook.yml b/docs/docs-ref-autogen/excel/excel/excel.workbook.yml index 33a78133b7..714a988b1a 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.workbook.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.workbook.yml @@ -1155,17 +1155,22 @@ methods: fullName: insertWorksheetsFromBase64(base64File, options) summary: >- Inserts the specified worksheets from a source workbook into the current - workbook. - - - *Note**: This API is currently only supported for Office on Windows, - Mac, and the web. + workbook. The `extensionHardening` Windows registry key affects this API. + The file extension defined by the `base64File` param must match the real + file type of the inserted file. If `extensionHardening` is set to deny + mismatches and the file extension does not match the real file type, this + API throws the following error: "This operation is not allowed due to the + extension hardening policy." remarks: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + This API is currently only supported for Office on Windows, Mac, and the + web. + + #### Examples diff --git a/docs/docs-ref-autogen/excel_1_10/excel.yml b/docs/docs-ref-autogen/excel_1_10/excel.yml index 070e1b6158..2f4bed538c 100644 --- a/docs/docs-ref-autogen/excel_1_10/excel.yml +++ b/docs/docs-ref-autogen/excel_1_10/excel.yml @@ -911,11 +911,16 @@ functions: package: excel! summary: >- Creates and opens a new workbook. Optionally, the workbook can be - pre-populated with a Base64-encoded .xlsx file. Note: Macros can be a - security risk. If this API is used to create a workbook that includes a - macro, the add-in user will be prompted with a "Trust this add-in?" dialog - in the Excel UI. The user must select the "Trust add-in" button to - proceed. + pre-populated with a Base64-encoded .xlsx file. The `extensionHardening` + Windows registry key affects the `base64File` param. The file extension + defined by the param must match the real file type of the file. If + `extensionHardening` is set to deny mismatches and the file extension does + not match the real file type, this API throws the following error: "This + operation is not allowed due to the extension hardening policy." Note: + Macros can be a security risk. If this API is used to create a workbook + that includes a macro, the add-in user will be prompted with a "Trust this + add-in?" dialog in the Excel UI. The user must select the "Trust add-in" + button to proceed. \[ [API set: ExcelApi diff --git a/docs/docs-ref-autogen/excel_1_11/excel.yml b/docs/docs-ref-autogen/excel_1_11/excel.yml index a129e2d49c..adcab0d63f 100644 --- a/docs/docs-ref-autogen/excel_1_11/excel.yml +++ b/docs/docs-ref-autogen/excel_1_11/excel.yml @@ -919,11 +919,16 @@ functions: package: excel! summary: >- Creates and opens a new workbook. Optionally, the workbook can be - pre-populated with a Base64-encoded .xlsx file. Note: Macros can be a - security risk. If this API is used to create a workbook that includes a - macro, the add-in user will be prompted with a "Trust this add-in?" dialog - in the Excel UI. The user must select the "Trust add-in" button to - proceed. + pre-populated with a Base64-encoded .xlsx file. The `extensionHardening` + Windows registry key affects the `base64File` param. The file extension + defined by the param must match the real file type of the file. If + `extensionHardening` is set to deny mismatches and the file extension does + not match the real file type, this API throws the following error: "This + operation is not allowed due to the extension hardening policy." Note: + Macros can be a security risk. If this API is used to create a workbook + that includes a macro, the add-in user will be prompted with a "Trust this + add-in?" dialog in the Excel UI. The user must select the "Trust add-in" + button to proceed. \[ [API set: ExcelApi diff --git a/docs/docs-ref-autogen/excel_1_12/excel.yml b/docs/docs-ref-autogen/excel_1_12/excel.yml index 3aa1af9780..700865849c 100644 --- a/docs/docs-ref-autogen/excel_1_12/excel.yml +++ b/docs/docs-ref-autogen/excel_1_12/excel.yml @@ -949,11 +949,16 @@ functions: package: excel! summary: >- Creates and opens a new workbook. Optionally, the workbook can be - pre-populated with a Base64-encoded .xlsx file. Note: Macros can be a - security risk. If this API is used to create a workbook that includes a - macro, the add-in user will be prompted with a "Trust this add-in?" dialog - in the Excel UI. The user must select the "Trust add-in" button to - proceed. + pre-populated with a Base64-encoded .xlsx file. The `extensionHardening` + Windows registry key affects the `base64File` param. The file extension + defined by the param must match the real file type of the file. If + `extensionHardening` is set to deny mismatches and the file extension does + not match the real file type, this API throws the following error: "This + operation is not allowed due to the extension hardening policy." Note: + Macros can be a security risk. If this API is used to create a workbook + that includes a macro, the add-in user will be prompted with a "Trust this + add-in?" dialog in the Excel UI. The user must select the "Trust add-in" + button to proceed. \[ [API set: ExcelApi diff --git a/docs/docs-ref-autogen/excel_1_13/excel.yml b/docs/docs-ref-autogen/excel_1_13/excel.yml index 71daef7478..e47c892273 100644 --- a/docs/docs-ref-autogen/excel_1_13/excel.yml +++ b/docs/docs-ref-autogen/excel_1_13/excel.yml @@ -954,11 +954,16 @@ functions: package: excel! summary: >- Creates and opens a new workbook. Optionally, the workbook can be - pre-populated with a Base64-encoded .xlsx file. Note: Macros can be a - security risk. If this API is used to create a workbook that includes a - macro, the add-in user will be prompted with a "Trust this add-in?" dialog - in the Excel UI. The user must select the "Trust add-in" button to - proceed. + pre-populated with a Base64-encoded .xlsx file. The `extensionHardening` + Windows registry key affects the `base64File` param. The file extension + defined by the param must match the real file type of the file. If + `extensionHardening` is set to deny mismatches and the file extension does + not match the real file type, this API throws the following error: "This + operation is not allowed due to the extension hardening policy." Note: + Macros can be a security risk. If this API is used to create a workbook + that includes a macro, the add-in user will be prompted with a "Trust this + add-in?" dialog in the Excel UI. The user must select the "Trust add-in" + button to proceed. \[ [API set: ExcelApi diff --git a/docs/docs-ref-autogen/excel_1_13/excel/excel.range.yml b/docs/docs-ref-autogen/excel_1_13/excel/excel.range.yml index f516b0ab4d..4aadff9fb1 100644 --- a/docs/docs-ref-autogen/excel_1_13/excel/excel.range.yml +++ b/docs/docs-ref-autogen/excel_1_13/excel/excel.range.yml @@ -1860,7 +1860,8 @@ 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 - Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. + Ctrl+Shift+Arrow key behavior in the + Excel on Windows UI. remarks: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) @@ -1925,7 +1926,8 @@ 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 - Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. + Ctrl+Shift+Arrow key behavior in the + Excel on Windows UI. remarks: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) @@ -2389,8 +2391,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 Ctrl+Arrow key - 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: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) @@ -2454,8 +2456,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 Ctrl+Arrow key - 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: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) diff --git a/docs/docs-ref-autogen/excel_1_13/excel/excel.workbook.yml b/docs/docs-ref-autogen/excel_1_13/excel/excel.workbook.yml index 29e3b36faf..1e77ea8497 100644 --- a/docs/docs-ref-autogen/excel_1_13/excel/excel.workbook.yml +++ b/docs/docs-ref-autogen/excel_1_13/excel/excel.workbook.yml @@ -831,17 +831,22 @@ methods: fullName: insertWorksheetsFromBase64(base64File, options) summary: >- Inserts the specified worksheets from a source workbook into the current - workbook. - - - *Note**: This API is currently only supported for Office on Windows, - Mac, and the web. + workbook. The `extensionHardening` Windows registry key affects this API. + The file extension defined by the `base64File` param must match the real + file type of the inserted file. If `extensionHardening` is set to deny + mismatches and the file extension does not match the real file type, this + API throws the following error: "This operation is not allowed due to the + extension hardening policy." remarks: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + This API is currently only supported for Office on Windows, Mac, and the + web. + + #### Examples diff --git a/docs/docs-ref-autogen/excel_1_14/excel.yml b/docs/docs-ref-autogen/excel_1_14/excel.yml index edf8cee980..a8023db474 100644 --- a/docs/docs-ref-autogen/excel_1_14/excel.yml +++ b/docs/docs-ref-autogen/excel_1_14/excel.yml @@ -967,11 +967,16 @@ functions: package: excel! summary: >- Creates and opens a new workbook. Optionally, the workbook can be - pre-populated with a Base64-encoded .xlsx file. Note: Macros can be a - security risk. If this API is used to create a workbook that includes a - macro, the add-in user will be prompted with a "Trust this add-in?" dialog - in the Excel UI. The user must select the "Trust add-in" button to - proceed. + pre-populated with a Base64-encoded .xlsx file. The `extensionHardening` + Windows registry key affects the `base64File` param. The file extension + defined by the param must match the real file type of the file. If + `extensionHardening` is set to deny mismatches and the file extension does + not match the real file type, this API throws the following error: "This + operation is not allowed due to the extension hardening policy." Note: + Macros can be a security risk. If this API is used to create a workbook + that includes a macro, the add-in user will be prompted with a "Trust this + add-in?" dialog in the Excel UI. The user must select the "Trust add-in" + button to proceed. \[ [API set: ExcelApi diff --git a/docs/docs-ref-autogen/excel_1_14/excel/excel.range.yml b/docs/docs-ref-autogen/excel_1_14/excel/excel.range.yml index 85409db82b..f897b8e338 100644 --- a/docs/docs-ref-autogen/excel_1_14/excel/excel.range.yml +++ b/docs/docs-ref-autogen/excel_1_14/excel/excel.range.yml @@ -1860,7 +1860,8 @@ 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 - Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. + Ctrl+Shift+Arrow key behavior in the + Excel on Windows UI. remarks: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) @@ -1925,7 +1926,8 @@ 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 - Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. + Ctrl+Shift+Arrow key behavior in the + Excel on Windows UI. remarks: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) @@ -2441,8 +2443,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 Ctrl+Arrow key - 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: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) @@ -2506,8 +2508,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 Ctrl+Arrow key - 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: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) diff --git a/docs/docs-ref-autogen/excel_1_14/excel/excel.workbook.yml b/docs/docs-ref-autogen/excel_1_14/excel/excel.workbook.yml index 2047e07342..84e3a57f90 100644 --- a/docs/docs-ref-autogen/excel_1_14/excel/excel.workbook.yml +++ b/docs/docs-ref-autogen/excel_1_14/excel/excel.workbook.yml @@ -847,17 +847,22 @@ methods: fullName: insertWorksheetsFromBase64(base64File, options) summary: >- Inserts the specified worksheets from a source workbook into the current - workbook. - - - *Note**: This API is currently only supported for Office on Windows, - Mac, and the web. + workbook. The `extensionHardening` Windows registry key affects this API. + The file extension defined by the `base64File` param must match the real + file type of the inserted file. If `extensionHardening` is set to deny + mismatches and the file extension does not match the real file type, this + API throws the following error: "This operation is not allowed due to the + extension hardening policy." remarks: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + This API is currently only supported for Office on Windows, Mac, and the + web. + + #### Examples diff --git a/docs/docs-ref-autogen/excel_1_15/excel.yml b/docs/docs-ref-autogen/excel_1_15/excel.yml index 04c2f042ce..9b0464797b 100644 --- a/docs/docs-ref-autogen/excel_1_15/excel.yml +++ b/docs/docs-ref-autogen/excel_1_15/excel.yml @@ -969,11 +969,16 @@ functions: package: excel! summary: >- Creates and opens a new workbook. Optionally, the workbook can be - pre-populated with a Base64-encoded .xlsx file. Note: Macros can be a - security risk. If this API is used to create a workbook that includes a - macro, the add-in user will be prompted with a "Trust this add-in?" dialog - in the Excel UI. The user must select the "Trust add-in" button to - proceed. + pre-populated with a Base64-encoded .xlsx file. The `extensionHardening` + Windows registry key affects the `base64File` param. The file extension + defined by the param must match the real file type of the file. If + `extensionHardening` is set to deny mismatches and the file extension does + not match the real file type, this API throws the following error: "This + operation is not allowed due to the extension hardening policy." Note: + Macros can be a security risk. If this API is used to create a workbook + that includes a macro, the add-in user will be prompted with a "Trust this + add-in?" dialog in the Excel UI. The user must select the "Trust add-in" + button to proceed. \[ [API set: ExcelApi diff --git a/docs/docs-ref-autogen/excel_1_15/excel/excel.range.yml b/docs/docs-ref-autogen/excel_1_15/excel/excel.range.yml index 6f26ff15f7..9ff26954e8 100644 --- a/docs/docs-ref-autogen/excel_1_15/excel/excel.range.yml +++ b/docs/docs-ref-autogen/excel_1_15/excel/excel.range.yml @@ -1916,7 +1916,8 @@ 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 - Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. + Ctrl+Shift+Arrow key behavior in the + Excel on Windows UI. remarks: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) @@ -1981,7 +1982,8 @@ 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 - Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. + Ctrl+Shift+Arrow key behavior in the + Excel on Windows UI. remarks: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) @@ -2497,8 +2499,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 Ctrl+Arrow key - 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: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) @@ -2562,8 +2564,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 Ctrl+Arrow key - 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: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) diff --git a/docs/docs-ref-autogen/excel_1_15/excel/excel.workbook.yml b/docs/docs-ref-autogen/excel_1_15/excel/excel.workbook.yml index 2047e07342..84e3a57f90 100644 --- a/docs/docs-ref-autogen/excel_1_15/excel/excel.workbook.yml +++ b/docs/docs-ref-autogen/excel_1_15/excel/excel.workbook.yml @@ -847,17 +847,22 @@ methods: fullName: insertWorksheetsFromBase64(base64File, options) summary: >- Inserts the specified worksheets from a source workbook into the current - workbook. - - - *Note**: This API is currently only supported for Office on Windows, - Mac, and the web. + workbook. The `extensionHardening` Windows registry key affects this API. + The file extension defined by the `base64File` param must match the real + file type of the inserted file. If `extensionHardening` is set to deny + mismatches and the file extension does not match the real file type, this + API throws the following error: "This operation is not allowed due to the + extension hardening policy." remarks: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + This API is currently only supported for Office on Windows, Mac, and the + web. + + #### Examples diff --git a/docs/docs-ref-autogen/excel_1_16/excel.yml b/docs/docs-ref-autogen/excel_1_16/excel.yml index c27f5b5e22..1cb8041a97 100644 --- a/docs/docs-ref-autogen/excel_1_16/excel.yml +++ b/docs/docs-ref-autogen/excel_1_16/excel.yml @@ -1034,11 +1034,16 @@ functions: package: excel! summary: >- Creates and opens a new workbook. Optionally, the workbook can be - pre-populated with a Base64-encoded .xlsx file. Note: Macros can be a - security risk. If this API is used to create a workbook that includes a - macro, the add-in user will be prompted with a "Trust this add-in?" dialog - in the Excel UI. The user must select the "Trust add-in" button to - proceed. + pre-populated with a Base64-encoded .xlsx file. The `extensionHardening` + Windows registry key affects the `base64File` param. The file extension + defined by the param must match the real file type of the file. If + `extensionHardening` is set to deny mismatches and the file extension does + not match the real file type, this API throws the following error: "This + operation is not allowed due to the extension hardening policy." Note: + Macros can be a security risk. If this API is used to create a workbook + that includes a macro, the add-in user will be prompted with a "Trust this + add-in?" dialog in the Excel UI. The user must select the "Trust add-in" + button to proceed. \[ [API set: ExcelApi diff --git a/docs/docs-ref-autogen/excel_1_16/excel/excel.cardlayout.yml b/docs/docs-ref-autogen/excel_1_16/excel/excel.cardlayout.yml index 4de2b1d604..07ebbc46e3 100644 --- a/docs/docs-ref-autogen/excel_1_16/excel/excel.cardlayout.yml +++ b/docs/docs-ref-autogen/excel_1_16/excel/excel.cardlayout.yml @@ -4,7 +4,15 @@ uid: excel!Excel.CardLayout:type package: excel! fullName: Excel.CardLayout summary: Represents the layout of a card in card view. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_16/excel/excel.cardlayoutsection.yml b/docs/docs-ref-autogen/excel_1_16/excel/excel.cardlayoutsection.yml index b54480411d..97e90f572d 100644 --- a/docs/docs-ref-autogen/excel_1_16/excel/excel.cardlayoutsection.yml +++ b/docs/docs-ref-autogen/excel_1_16/excel/excel.cardlayoutsection.yml @@ -4,7 +4,16 @@ uid: excel!Excel.CardLayoutSection:type package: excel! fullName: Excel.CardLayoutSection summary: Represents the layout of a section of a card in card view. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection), [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection), + [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_16/excel/excel.cellvalue.yml b/docs/docs-ref-autogen/excel_1_16/excel/excel.cellvalue.yml index 63e5befd22..b679b81429 100644 --- a/docs/docs-ref-autogen/excel_1_16/excel/excel.cellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_16/excel/excel.cellvalue.yml @@ -4,7 +4,26 @@ uid: excel!Excel.CellValue:type package: excel! fullName: Excel.CellValue summary: Represents the value in a cell. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue), [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), [Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue), [Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue), [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue), [Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue), [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), [Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue), [Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue), [Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), + [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue), + [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), + [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), + [Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue), + [Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue), + [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue), + [Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue), + [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), + [Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue), + [Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue), + [Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_16/excel/excel.cellvalueandpropertymetadata.yml b/docs/docs-ref-autogen/excel_1_16/excel/excel.cellvalueandpropertymetadata.yml index 566432a914..5f661bb32f 100644 --- a/docs/docs-ref-autogen/excel_1_16/excel/excel.cellvalueandpropertymetadata.yml +++ b/docs/docs-ref-autogen/excel_1_16/excel/excel.cellvalueandpropertymetadata.yml @@ -6,7 +6,16 @@ fullName: Excel.CellValueAndPropertyMetadata summary: >- Represents the value and metadata of a property. The metadata applies to the property (and not the value), but it is combined with the value in this type. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValue](/javascript/api/excel/excel.cellvalue), [Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CellValue](/javascript/api/excel/excel.cellvalue), + [Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_16/excel/excel.compactlayout.yml b/docs/docs-ref-autogen/excel_1_16/excel/excel.compactlayout.yml index 3f25496779..5bb689c662 100644 --- a/docs/docs-ref-autogen/excel_1_16/excel/excel.compactlayout.yml +++ b/docs/docs-ref-autogen/excel_1_16/excel/excel.compactlayout.yml @@ -6,7 +6,15 @@ fullName: Excel.CompactLayout summary: >- Represents the layout used when there is limited space to represent the entity. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_16/excel/excel.entitypropertytype.yml b/docs/docs-ref-autogen/excel_1_16/excel/excel.entitypropertytype.yml index 41a8cc7fcf..bc54a6eff6 100644 --- a/docs/docs-ref-autogen/excel_1_16/excel/excel.entitypropertytype.yml +++ b/docs/docs-ref-autogen/excel_1_16/excel/excel.entitypropertytype.yml @@ -4,7 +4,16 @@ uid: excel!Excel.EntityPropertyType:type package: excel! fullName: Excel.EntityPropertyType summary: Represents the value of a property. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata), [Excel.CellValue](/javascript/api/excel/excel.cellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata), + [Excel.CellValue](/javascript/api/excel/excel.cellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_16/excel/excel.errorcellvalue.yml b/docs/docs-ref-autogen/excel_1_16/excel/excel.errorcellvalue.yml index e5addcc22f..b88b1959c2 100644 --- a/docs/docs-ref-autogen/excel_1_16/excel/excel.errorcellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_16/excel/excel.errorcellvalue.yml @@ -4,7 +4,62 @@ uid: excel!Excel.ErrorCellValue:type package: excel! fullName: Excel.ErrorCellValue summary: Represents a cell value which contains an error. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\n\n\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue), [Excel.BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue), [Excel.CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue), [Excel.ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue), [Excel.Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue), [Excel.ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue), [Excel.FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue), [Excel.GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue), [Excel.NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue), [Excel.NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue), [Excel.NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue), [Excel.NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue), [Excel.PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue), [Excel.RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue), [Excel.SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue), [Excel.ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue)\r\n\r\n#### Examples\n\n```TypeScript\n// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml\n\n// This function sets the value of cell A1 to a #BUSY! error using data types.\nawait Excel.run(async (context) => {\n // Retrieve the Sample worksheet and cell A1 on that sheet.\n const sheet = context.workbook.worksheets.getItemOrNullObject(\"Sample\");\n const range = sheet.getRange(\"A1\");\n\n // Get the error data type and set its type to `busy`.\n const error: Excel.ErrorCellValue = {\n type: Excel.CellValueType.error,\n errorType: Excel.ErrorCellValueType.busy\n };\n\n // Set cell A1 as the busy error.\n range.valuesAsJson = [[error]];\n await context.sync();\n});\n```" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + + + Learn more about the types in this type alias through the following links. + + + [Excel.BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue), + [Excel.BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue), + [Excel.CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue), + [Excel.ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue), + [Excel.Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue), + [Excel.ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue), + [Excel.FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue), + [Excel.GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue), + [Excel.NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue), + [Excel.NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue), + [Excel.NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue), + [Excel.NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue), + [Excel.PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue), + [Excel.RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue), + [Excel.SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue), + [Excel.ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue) + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml + + + // This function sets the value of cell A1 to a #BUSY! error using data types. + + await Excel.run(async (context) => { + // Retrieve the Sample worksheet and cell A1 on that sheet. + const sheet = context.workbook.worksheets.getItemOrNullObject("Sample"); + const range = sheet.getRange("A1"); + + // Get the error data type and set its type to `busy`. + const error: Excel.ErrorCellValue = { + type: Excel.CellValueType.error, + errorType: Excel.ErrorCellValueType.busy + }; + + // Set cell A1 as the busy error. + range.valuesAsJson = [[error]]; + await context.sync(); + }); + + ``` isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_16/excel/excel.notavailableerrorcellvalue.yml b/docs/docs-ref-autogen/excel_1_16/excel/excel.notavailableerrorcellvalue.yml index 408016466d..0587e033ac 100644 --- a/docs/docs-ref-autogen/excel_1_16/excel/excel.notavailableerrorcellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_16/excel/excel.notavailableerrorcellvalue.yml @@ -3,7 +3,7 @@ name: Excel.NotAvailableErrorCellValue uid: excel!Excel.NotAvailableErrorCellValue:interface package: excel! fullName: Excel.NotAvailableErrorCellValue -summary: Represents the value of a cell containing a \#N/A! error. +summary: Represents the value of a cell containing a \#N/A error. remarks: >- \[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] @@ -48,9 +48,9 @@ properties: isPreview: false isDeprecated: false syntax: - content: 'basicValue?: "#N/A!" | string;' + content: 'basicValue?: "#N/A" | string;' return: - type: '"#N/A!" | string' + type: '"#N/A" | string' - name: errorType uid: excel!Excel.NotAvailableErrorCellValue#errorType:member package: excel! diff --git a/docs/docs-ref-autogen/excel_1_16/excel/excel.range.yml b/docs/docs-ref-autogen/excel_1_16/excel/excel.range.yml index 9a3d2380ba..19fcc66cb3 100644 --- a/docs/docs-ref-autogen/excel_1_16/excel/excel.range.yml +++ b/docs/docs-ref-autogen/excel_1_16/excel/excel.range.yml @@ -1994,7 +1994,8 @@ 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 - Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. + Ctrl+Shift+Arrow key behavior in the + Excel on Windows UI. remarks: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) @@ -2059,7 +2060,8 @@ 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 - Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. + Ctrl+Shift+Arrow key behavior in the + Excel on Windows UI. remarks: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) @@ -2575,8 +2577,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 Ctrl+Arrow key - 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: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) @@ -2640,8 +2642,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 Ctrl+Arrow key - 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: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) diff --git a/docs/docs-ref-autogen/excel_1_16/excel/excel.referencedvalue.yml b/docs/docs-ref-autogen/excel_1_16/excel/excel.referencedvalue.yml index 57044e8ebe..168b4928ba 100644 --- a/docs/docs-ref-autogen/excel_1_16/excel/excel.referencedvalue.yml +++ b/docs/docs-ref-autogen/excel_1_16/excel/excel.referencedvalue.yml @@ -4,7 +4,20 @@ uid: excel!Excel.ReferencedValue:type package: excel! fullName: Excel.ReferencedValue summary: Represents the value in a cell. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), [Excel.RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue), [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), + [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), + [Excel.RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue), + [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), + [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), + [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_16/excel/excel.workbook.yml b/docs/docs-ref-autogen/excel_1_16/excel/excel.workbook.yml index 74d0c35c9f..ff7ee83f85 100644 --- a/docs/docs-ref-autogen/excel_1_16/excel/excel.workbook.yml +++ b/docs/docs-ref-autogen/excel_1_16/excel/excel.workbook.yml @@ -876,17 +876,22 @@ methods: fullName: insertWorksheetsFromBase64(base64File, options) summary: >- Inserts the specified worksheets from a source workbook into the current - workbook. - - - *Note**: This API is currently only supported for Office on Windows, - Mac, and the web. + workbook. The `extensionHardening` Windows registry key affects this API. + The file extension defined by the `base64File` param must match the real + file type of the inserted file. If `extensionHardening` is set to deny + mismatches and the file extension does not match the real file type, this + API throws the following error: "This operation is not allowed due to the + extension hardening policy." remarks: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + This API is currently only supported for Office on Windows, Mac, and the + web. + + #### Examples diff --git a/docs/docs-ref-autogen/excel_1_17/excel.yml b/docs/docs-ref-autogen/excel_1_17/excel.yml index 9db593c911..1f223c14f3 100644 --- a/docs/docs-ref-autogen/excel_1_17/excel.yml +++ b/docs/docs-ref-autogen/excel_1_17/excel.yml @@ -1037,11 +1037,16 @@ functions: package: excel! summary: >- Creates and opens a new workbook. Optionally, the workbook can be - pre-populated with a Base64-encoded .xlsx file. Note: Macros can be a - security risk. If this API is used to create a workbook that includes a - macro, the add-in user will be prompted with a "Trust this add-in?" dialog - in the Excel UI. The user must select the "Trust add-in" button to - proceed. + pre-populated with a Base64-encoded .xlsx file. The `extensionHardening` + Windows registry key affects the `base64File` param. The file extension + defined by the param must match the real file type of the file. If + `extensionHardening` is set to deny mismatches and the file extension does + not match the real file type, this API throws the following error: "This + operation is not allowed due to the extension hardening policy." Note: + Macros can be a security risk. If this API is used to create a workbook + that includes a macro, the add-in user will be prompted with a "Trust this + add-in?" dialog in the Excel UI. The user must select the "Trust add-in" + button to proceed. \[ [API set: ExcelApi diff --git a/docs/docs-ref-autogen/excel_1_17/excel/excel.cardlayout.yml b/docs/docs-ref-autogen/excel_1_17/excel/excel.cardlayout.yml index 4de2b1d604..07ebbc46e3 100644 --- a/docs/docs-ref-autogen/excel_1_17/excel/excel.cardlayout.yml +++ b/docs/docs-ref-autogen/excel_1_17/excel/excel.cardlayout.yml @@ -4,7 +4,15 @@ uid: excel!Excel.CardLayout:type package: excel! fullName: Excel.CardLayout summary: Represents the layout of a card in card view. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_17/excel/excel.cardlayoutsection.yml b/docs/docs-ref-autogen/excel_1_17/excel/excel.cardlayoutsection.yml index b54480411d..97e90f572d 100644 --- a/docs/docs-ref-autogen/excel_1_17/excel/excel.cardlayoutsection.yml +++ b/docs/docs-ref-autogen/excel_1_17/excel/excel.cardlayoutsection.yml @@ -4,7 +4,16 @@ uid: excel!Excel.CardLayoutSection:type package: excel! fullName: Excel.CardLayoutSection summary: Represents the layout of a section of a card in card view. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection), [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection), + [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_17/excel/excel.cellvalue.yml b/docs/docs-ref-autogen/excel_1_17/excel/excel.cellvalue.yml index 63e5befd22..b679b81429 100644 --- a/docs/docs-ref-autogen/excel_1_17/excel/excel.cellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_17/excel/excel.cellvalue.yml @@ -4,7 +4,26 @@ uid: excel!Excel.CellValue:type package: excel! fullName: Excel.CellValue summary: Represents the value in a cell. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue), [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), [Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue), [Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue), [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue), [Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue), [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), [Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue), [Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue), [Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), + [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue), + [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), + [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), + [Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue), + [Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue), + [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue), + [Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue), + [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), + [Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue), + [Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue), + [Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_17/excel/excel.cellvalueandpropertymetadata.yml b/docs/docs-ref-autogen/excel_1_17/excel/excel.cellvalueandpropertymetadata.yml index 566432a914..5f661bb32f 100644 --- a/docs/docs-ref-autogen/excel_1_17/excel/excel.cellvalueandpropertymetadata.yml +++ b/docs/docs-ref-autogen/excel_1_17/excel/excel.cellvalueandpropertymetadata.yml @@ -6,7 +6,16 @@ fullName: Excel.CellValueAndPropertyMetadata summary: >- Represents the value and metadata of a property. The metadata applies to the property (and not the value), but it is combined with the value in this type. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValue](/javascript/api/excel/excel.cellvalue), [Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CellValue](/javascript/api/excel/excel.cellvalue), + [Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_17/excel/excel.compactlayout.yml b/docs/docs-ref-autogen/excel_1_17/excel/excel.compactlayout.yml index 3f25496779..5bb689c662 100644 --- a/docs/docs-ref-autogen/excel_1_17/excel/excel.compactlayout.yml +++ b/docs/docs-ref-autogen/excel_1_17/excel/excel.compactlayout.yml @@ -6,7 +6,15 @@ fullName: Excel.CompactLayout summary: >- Represents the layout used when there is limited space to represent the entity. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_17/excel/excel.entitypropertytype.yml b/docs/docs-ref-autogen/excel_1_17/excel/excel.entitypropertytype.yml index 41a8cc7fcf..bc54a6eff6 100644 --- a/docs/docs-ref-autogen/excel_1_17/excel/excel.entitypropertytype.yml +++ b/docs/docs-ref-autogen/excel_1_17/excel/excel.entitypropertytype.yml @@ -4,7 +4,16 @@ uid: excel!Excel.EntityPropertyType:type package: excel! fullName: Excel.EntityPropertyType summary: Represents the value of a property. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata), [Excel.CellValue](/javascript/api/excel/excel.cellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata), + [Excel.CellValue](/javascript/api/excel/excel.cellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_17/excel/excel.errorcellvalue.yml b/docs/docs-ref-autogen/excel_1_17/excel/excel.errorcellvalue.yml index e5addcc22f..b88b1959c2 100644 --- a/docs/docs-ref-autogen/excel_1_17/excel/excel.errorcellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_17/excel/excel.errorcellvalue.yml @@ -4,7 +4,62 @@ uid: excel!Excel.ErrorCellValue:type package: excel! fullName: Excel.ErrorCellValue summary: Represents a cell value which contains an error. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\n\n\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue), [Excel.BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue), [Excel.CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue), [Excel.ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue), [Excel.Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue), [Excel.ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue), [Excel.FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue), [Excel.GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue), [Excel.NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue), [Excel.NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue), [Excel.NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue), [Excel.NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue), [Excel.PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue), [Excel.RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue), [Excel.SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue), [Excel.ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue)\r\n\r\n#### Examples\n\n```TypeScript\n// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml\n\n// This function sets the value of cell A1 to a #BUSY! error using data types.\nawait Excel.run(async (context) => {\n // Retrieve the Sample worksheet and cell A1 on that sheet.\n const sheet = context.workbook.worksheets.getItemOrNullObject(\"Sample\");\n const range = sheet.getRange(\"A1\");\n\n // Get the error data type and set its type to `busy`.\n const error: Excel.ErrorCellValue = {\n type: Excel.CellValueType.error,\n errorType: Excel.ErrorCellValueType.busy\n };\n\n // Set cell A1 as the busy error.\n range.valuesAsJson = [[error]];\n await context.sync();\n});\n```" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + + + Learn more about the types in this type alias through the following links. + + + [Excel.BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue), + [Excel.BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue), + [Excel.CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue), + [Excel.ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue), + [Excel.Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue), + [Excel.ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue), + [Excel.FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue), + [Excel.GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue), + [Excel.NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue), + [Excel.NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue), + [Excel.NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue), + [Excel.NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue), + [Excel.PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue), + [Excel.RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue), + [Excel.SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue), + [Excel.ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue) + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml + + + // This function sets the value of cell A1 to a #BUSY! error using data types. + + await Excel.run(async (context) => { + // Retrieve the Sample worksheet and cell A1 on that sheet. + const sheet = context.workbook.worksheets.getItemOrNullObject("Sample"); + const range = sheet.getRange("A1"); + + // Get the error data type and set its type to `busy`. + const error: Excel.ErrorCellValue = { + type: Excel.CellValueType.error, + errorType: Excel.ErrorCellValueType.busy + }; + + // Set cell A1 as the busy error. + range.valuesAsJson = [[error]]; + await context.sync(); + }); + + ``` isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_17/excel/excel.notavailableerrorcellvalue.yml b/docs/docs-ref-autogen/excel_1_17/excel/excel.notavailableerrorcellvalue.yml index 408016466d..0587e033ac 100644 --- a/docs/docs-ref-autogen/excel_1_17/excel/excel.notavailableerrorcellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_17/excel/excel.notavailableerrorcellvalue.yml @@ -3,7 +3,7 @@ name: Excel.NotAvailableErrorCellValue uid: excel!Excel.NotAvailableErrorCellValue:interface package: excel! fullName: Excel.NotAvailableErrorCellValue -summary: Represents the value of a cell containing a \#N/A! error. +summary: Represents the value of a cell containing a \#N/A error. remarks: >- \[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] @@ -48,9 +48,9 @@ properties: isPreview: false isDeprecated: false syntax: - content: 'basicValue?: "#N/A!" | string;' + content: 'basicValue?: "#N/A" | string;' return: - type: '"#N/A!" | string' + type: '"#N/A" | string' - name: errorType uid: excel!Excel.NotAvailableErrorCellValue#errorType:member package: excel! diff --git a/docs/docs-ref-autogen/excel_1_17/excel/excel.range.yml b/docs/docs-ref-autogen/excel_1_17/excel/excel.range.yml index 9a3d2380ba..19fcc66cb3 100644 --- a/docs/docs-ref-autogen/excel_1_17/excel/excel.range.yml +++ b/docs/docs-ref-autogen/excel_1_17/excel/excel.range.yml @@ -1994,7 +1994,8 @@ 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 - Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. + Ctrl+Shift+Arrow key behavior in the + Excel on Windows UI. remarks: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) @@ -2059,7 +2060,8 @@ 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 - Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. + Ctrl+Shift+Arrow key behavior in the + Excel on Windows UI. remarks: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) @@ -2575,8 +2577,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 Ctrl+Arrow key - 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: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) @@ -2640,8 +2642,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 Ctrl+Arrow key - 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: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) diff --git a/docs/docs-ref-autogen/excel_1_17/excel/excel.referencedvalue.yml b/docs/docs-ref-autogen/excel_1_17/excel/excel.referencedvalue.yml index 57044e8ebe..168b4928ba 100644 --- a/docs/docs-ref-autogen/excel_1_17/excel/excel.referencedvalue.yml +++ b/docs/docs-ref-autogen/excel_1_17/excel/excel.referencedvalue.yml @@ -4,7 +4,20 @@ uid: excel!Excel.ReferencedValue:type package: excel! fullName: Excel.ReferencedValue summary: Represents the value in a cell. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), [Excel.RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue), [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), + [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), + [Excel.RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue), + [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), + [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), + [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_17/excel/excel.workbook.yml b/docs/docs-ref-autogen/excel_1_17/excel/excel.workbook.yml index 74d0c35c9f..ff7ee83f85 100644 --- a/docs/docs-ref-autogen/excel_1_17/excel/excel.workbook.yml +++ b/docs/docs-ref-autogen/excel_1_17/excel/excel.workbook.yml @@ -876,17 +876,22 @@ methods: fullName: insertWorksheetsFromBase64(base64File, options) summary: >- Inserts the specified worksheets from a source workbook into the current - workbook. - - - *Note**: This API is currently only supported for Office on Windows, - Mac, and the web. + workbook. The `extensionHardening` Windows registry key affects this API. + The file extension defined by the `base64File` param must match the real + file type of the inserted file. If `extensionHardening` is set to deny + mismatches and the file extension does not match the real file type, this + API throws the following error: "This operation is not allowed due to the + extension hardening policy." remarks: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + This API is currently only supported for Office on Windows, Mac, and the + web. + + #### Examples diff --git a/docs/docs-ref-autogen/excel_1_18/excel.yml b/docs/docs-ref-autogen/excel_1_18/excel.yml index 462fb5c2d9..3a002668e6 100644 --- a/docs/docs-ref-autogen/excel_1_18/excel.yml +++ b/docs/docs-ref-autogen/excel_1_18/excel.yml @@ -1048,11 +1048,16 @@ functions: package: excel! summary: >- Creates and opens a new workbook. Optionally, the workbook can be - pre-populated with a Base64-encoded .xlsx file. Note: Macros can be a - security risk. If this API is used to create a workbook that includes a - macro, the add-in user will be prompted with a "Trust this add-in?" dialog - in the Excel UI. The user must select the "Trust add-in" button to - proceed. + pre-populated with a Base64-encoded .xlsx file. The `extensionHardening` + Windows registry key affects the `base64File` param. The file extension + defined by the param must match the real file type of the file. If + `extensionHardening` is set to deny mismatches and the file extension does + not match the real file type, this API throws the following error: "This + operation is not allowed due to the extension hardening policy." Note: + Macros can be a security risk. If this API is used to create a workbook + that includes a macro, the add-in user will be prompted with a "Trust this + add-in?" dialog in the Excel UI. The user must select the "Trust add-in" + button to proceed. \[ [API set: ExcelApi diff --git a/docs/docs-ref-autogen/excel_1_18/excel/excel.cardlayout.yml b/docs/docs-ref-autogen/excel_1_18/excel/excel.cardlayout.yml index 4de2b1d604..07ebbc46e3 100644 --- a/docs/docs-ref-autogen/excel_1_18/excel/excel.cardlayout.yml +++ b/docs/docs-ref-autogen/excel_1_18/excel/excel.cardlayout.yml @@ -4,7 +4,15 @@ uid: excel!Excel.CardLayout:type package: excel! fullName: Excel.CardLayout summary: Represents the layout of a card in card view. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_18/excel/excel.cardlayoutsection.yml b/docs/docs-ref-autogen/excel_1_18/excel/excel.cardlayoutsection.yml index b54480411d..97e90f572d 100644 --- a/docs/docs-ref-autogen/excel_1_18/excel/excel.cardlayoutsection.yml +++ b/docs/docs-ref-autogen/excel_1_18/excel/excel.cardlayoutsection.yml @@ -4,7 +4,16 @@ uid: excel!Excel.CardLayoutSection:type package: excel! fullName: Excel.CardLayoutSection summary: Represents the layout of a section of a card in card view. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection), [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection), + [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_18/excel/excel.cellcontrol.yml b/docs/docs-ref-autogen/excel_1_18/excel/excel.cellcontrol.yml index ecd03dccf2..5e5954d3df 100644 --- a/docs/docs-ref-autogen/excel_1_18/excel/excel.cellcontrol.yml +++ b/docs/docs-ref-autogen/excel_1_18/excel/excel.cellcontrol.yml @@ -4,7 +4,47 @@ uid: excel!Excel.CellControl:type package: excel! fullName: Excel.CellControl summary: Represents an interactable control inside of a cell. -remarks: "\\[ [API set: ExcelApi 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\n\n\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.UnknownCellControl](/javascript/api/excel/excel.unknowncellcontrol), [Excel.EmptyCellControl](/javascript/api/excel/excel.emptycellcontrol), [Excel.MixedCellControl](/javascript/api/excel/excel.mixedcellcontrol), [Excel.CheckboxCellControl](/javascript/api/excel/excel.checkboxcellcontrol)\r\n\r\n#### Examples\n\n```TypeScript\n// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml\n\n// Add checkboxes to the table.\nawait Excel.run(async (context) => {\n const sheet = context.workbook.worksheets.getActiveWorksheet();\n\n // Get the second column in the table, without the header.\n const range = sheet.tables.getItem(\"FruitTable\").columns.getItem(\"Analysis\").getDataBodyRange();\n\n // Change the boolean values to checkboxes.\n range.control = {\n type: Excel.CellControlType.checkbox\n };\n await context.sync();\n});\n```" +remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + + + Learn more about the types in this type alias through the following links. + + + [Excel.UnknownCellControl](/javascript/api/excel/excel.unknowncellcontrol), + [Excel.EmptyCellControl](/javascript/api/excel/excel.emptycellcontrol), + [Excel.MixedCellControl](/javascript/api/excel/excel.mixedcellcontrol), + [Excel.CheckboxCellControl](/javascript/api/excel/excel.checkboxcellcontrol) + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml + + + // Add checkboxes to the table. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Get the second column in the table, without the header. + const range = sheet.tables.getItem("FruitTable").columns.getItem("Analysis").getDataBodyRange(); + + // Change the boolean values to checkboxes. + range.control = { + type: Excel.CellControlType.checkbox + }; + await context.sync(); + }); + + ``` isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_18/excel/excel.cellvalue.yml b/docs/docs-ref-autogen/excel_1_18/excel/excel.cellvalue.yml index 63e5befd22..b679b81429 100644 --- a/docs/docs-ref-autogen/excel_1_18/excel/excel.cellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_18/excel/excel.cellvalue.yml @@ -4,7 +4,26 @@ uid: excel!Excel.CellValue:type package: excel! fullName: Excel.CellValue summary: Represents the value in a cell. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue), [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), [Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue), [Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue), [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue), [Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue), [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), [Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue), [Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue), [Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), + [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue), + [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), + [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), + [Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue), + [Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue), + [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue), + [Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue), + [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), + [Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue), + [Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue), + [Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_18/excel/excel.cellvalueandpropertymetadata.yml b/docs/docs-ref-autogen/excel_1_18/excel/excel.cellvalueandpropertymetadata.yml index 566432a914..5f661bb32f 100644 --- a/docs/docs-ref-autogen/excel_1_18/excel/excel.cellvalueandpropertymetadata.yml +++ b/docs/docs-ref-autogen/excel_1_18/excel/excel.cellvalueandpropertymetadata.yml @@ -6,7 +6,16 @@ fullName: Excel.CellValueAndPropertyMetadata summary: >- Represents the value and metadata of a property. The metadata applies to the property (and not the value), but it is combined with the value in this type. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValue](/javascript/api/excel/excel.cellvalue), [Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CellValue](/javascript/api/excel/excel.cellvalue), + [Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_18/excel/excel.compactlayout.yml b/docs/docs-ref-autogen/excel_1_18/excel/excel.compactlayout.yml index 3f25496779..5bb689c662 100644 --- a/docs/docs-ref-autogen/excel_1_18/excel/excel.compactlayout.yml +++ b/docs/docs-ref-autogen/excel_1_18/excel/excel.compactlayout.yml @@ -6,7 +6,15 @@ fullName: Excel.CompactLayout summary: >- Represents the layout used when there is limited space to represent the entity. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_18/excel/excel.entitypropertytype.yml b/docs/docs-ref-autogen/excel_1_18/excel/excel.entitypropertytype.yml index 41a8cc7fcf..bc54a6eff6 100644 --- a/docs/docs-ref-autogen/excel_1_18/excel/excel.entitypropertytype.yml +++ b/docs/docs-ref-autogen/excel_1_18/excel/excel.entitypropertytype.yml @@ -4,7 +4,16 @@ uid: excel!Excel.EntityPropertyType:type package: excel! fullName: Excel.EntityPropertyType summary: Represents the value of a property. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata), [Excel.CellValue](/javascript/api/excel/excel.cellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata), + [Excel.CellValue](/javascript/api/excel/excel.cellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_18/excel/excel.errorcellvalue.yml b/docs/docs-ref-autogen/excel_1_18/excel/excel.errorcellvalue.yml index e5addcc22f..b88b1959c2 100644 --- a/docs/docs-ref-autogen/excel_1_18/excel/excel.errorcellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_18/excel/excel.errorcellvalue.yml @@ -4,7 +4,62 @@ uid: excel!Excel.ErrorCellValue:type package: excel! fullName: Excel.ErrorCellValue summary: Represents a cell value which contains an error. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\n\n\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue), [Excel.BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue), [Excel.CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue), [Excel.ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue), [Excel.Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue), [Excel.ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue), [Excel.FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue), [Excel.GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue), [Excel.NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue), [Excel.NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue), [Excel.NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue), [Excel.NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue), [Excel.PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue), [Excel.RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue), [Excel.SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue), [Excel.ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue)\r\n\r\n#### Examples\n\n```TypeScript\n// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml\n\n// This function sets the value of cell A1 to a #BUSY! error using data types.\nawait Excel.run(async (context) => {\n // Retrieve the Sample worksheet and cell A1 on that sheet.\n const sheet = context.workbook.worksheets.getItemOrNullObject(\"Sample\");\n const range = sheet.getRange(\"A1\");\n\n // Get the error data type and set its type to `busy`.\n const error: Excel.ErrorCellValue = {\n type: Excel.CellValueType.error,\n errorType: Excel.ErrorCellValueType.busy\n };\n\n // Set cell A1 as the busy error.\n range.valuesAsJson = [[error]];\n await context.sync();\n});\n```" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + + + Learn more about the types in this type alias through the following links. + + + [Excel.BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue), + [Excel.BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue), + [Excel.CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue), + [Excel.ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue), + [Excel.Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue), + [Excel.ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue), + [Excel.FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue), + [Excel.GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue), + [Excel.NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue), + [Excel.NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue), + [Excel.NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue), + [Excel.NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue), + [Excel.PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue), + [Excel.RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue), + [Excel.SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue), + [Excel.ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue) + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml + + + // This function sets the value of cell A1 to a #BUSY! error using data types. + + await Excel.run(async (context) => { + // Retrieve the Sample worksheet and cell A1 on that sheet. + const sheet = context.workbook.worksheets.getItemOrNullObject("Sample"); + const range = sheet.getRange("A1"); + + // Get the error data type and set its type to `busy`. + const error: Excel.ErrorCellValue = { + type: Excel.CellValueType.error, + errorType: Excel.ErrorCellValueType.busy + }; + + // Set cell A1 as the busy error. + range.valuesAsJson = [[error]]; + await context.sync(); + }); + + ``` isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_18/excel/excel.notavailableerrorcellvalue.yml b/docs/docs-ref-autogen/excel_1_18/excel/excel.notavailableerrorcellvalue.yml index 408016466d..0587e033ac 100644 --- a/docs/docs-ref-autogen/excel_1_18/excel/excel.notavailableerrorcellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_18/excel/excel.notavailableerrorcellvalue.yml @@ -3,7 +3,7 @@ name: Excel.NotAvailableErrorCellValue uid: excel!Excel.NotAvailableErrorCellValue:interface package: excel! fullName: Excel.NotAvailableErrorCellValue -summary: Represents the value of a cell containing a \#N/A! error. +summary: Represents the value of a cell containing a \#N/A error. remarks: >- \[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] @@ -48,9 +48,9 @@ properties: isPreview: false isDeprecated: false syntax: - content: 'basicValue?: "#N/A!" | string;' + content: 'basicValue?: "#N/A" | string;' return: - type: '"#N/A!" | string' + type: '"#N/A" | string' - name: errorType uid: excel!Excel.NotAvailableErrorCellValue#errorType:member package: excel! diff --git a/docs/docs-ref-autogen/excel_1_18/excel/excel.range.yml b/docs/docs-ref-autogen/excel_1_18/excel/excel.range.yml index 0fdbd601d1..3a50551fba 100644 --- a/docs/docs-ref-autogen/excel_1_18/excel/excel.range.yml +++ b/docs/docs-ref-autogen/excel_1_18/excel/excel.range.yml @@ -2087,7 +2087,8 @@ 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 - Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. + Ctrl+Shift+Arrow key behavior in the + Excel on Windows UI. remarks: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) @@ -2152,7 +2153,8 @@ 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 - Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. + Ctrl+Shift+Arrow key behavior in the + Excel on Windows UI. remarks: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) @@ -2668,8 +2670,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 Ctrl+Arrow key - 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: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) @@ -2733,8 +2735,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 Ctrl+Arrow key - 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: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) diff --git a/docs/docs-ref-autogen/excel_1_18/excel/excel.referencedvalue.yml b/docs/docs-ref-autogen/excel_1_18/excel/excel.referencedvalue.yml index 57044e8ebe..168b4928ba 100644 --- a/docs/docs-ref-autogen/excel_1_18/excel/excel.referencedvalue.yml +++ b/docs/docs-ref-autogen/excel_1_18/excel/excel.referencedvalue.yml @@ -4,7 +4,20 @@ uid: excel!Excel.ReferencedValue:type package: excel! fullName: Excel.ReferencedValue summary: Represents the value in a cell. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), [Excel.RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue), [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), + [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), + [Excel.RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue), + [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), + [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), + [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_18/excel/excel.workbook.yml b/docs/docs-ref-autogen/excel_1_18/excel/excel.workbook.yml index 877ed68f7e..48669d8a8a 100644 --- a/docs/docs-ref-autogen/excel_1_18/excel/excel.workbook.yml +++ b/docs/docs-ref-autogen/excel_1_18/excel/excel.workbook.yml @@ -892,17 +892,22 @@ methods: fullName: insertWorksheetsFromBase64(base64File, options) summary: >- Inserts the specified worksheets from a source workbook into the current - workbook. - - - *Note**: This API is currently only supported for Office on Windows, - Mac, and the web. + workbook. The `extensionHardening` Windows registry key affects this API. + The file extension defined by the `base64File` param must match the real + file type of the inserted file. If `extensionHardening` is set to deny + mismatches and the file extension does not match the real file type, this + API throws the following error: "This operation is not allowed due to the + extension hardening policy." remarks: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + This API is currently only supported for Office on Windows, Mac, and the + web. + + #### Examples diff --git a/docs/docs-ref-autogen/excel_1_19/excel.yml b/docs/docs-ref-autogen/excel_1_19/excel.yml index 5fc3db46eb..1badd608ac 100644 --- a/docs/docs-ref-autogen/excel_1_19/excel.yml +++ b/docs/docs-ref-autogen/excel_1_19/excel.yml @@ -1075,11 +1075,16 @@ functions: package: excel! summary: >- Creates and opens a new workbook. Optionally, the workbook can be - pre-populated with a Base64-encoded .xlsx file. Note: Macros can be a - security risk. If this API is used to create a workbook that includes a - macro, the add-in user will be prompted with a "Trust this add-in?" dialog - in the Excel UI. The user must select the "Trust add-in" button to - proceed. + pre-populated with a Base64-encoded .xlsx file. The `extensionHardening` + Windows registry key affects the `base64File` param. The file extension + defined by the param must match the real file type of the file. If + `extensionHardening` is set to deny mismatches and the file extension does + not match the real file type, this API throws the following error: "This + operation is not allowed due to the extension hardening policy." Note: + Macros can be a security risk. If this API is used to create a workbook + that includes a macro, the add-in user will be prompted with a "Trust this + add-in?" dialog in the Excel UI. The user must select the "Trust add-in" + button to proceed. \[ [API set: ExcelApi diff --git a/docs/docs-ref-autogen/excel_1_19/excel/excel.cardlayout.yml b/docs/docs-ref-autogen/excel_1_19/excel/excel.cardlayout.yml index 4de2b1d604..07ebbc46e3 100644 --- a/docs/docs-ref-autogen/excel_1_19/excel/excel.cardlayout.yml +++ b/docs/docs-ref-autogen/excel_1_19/excel/excel.cardlayout.yml @@ -4,7 +4,15 @@ uid: excel!Excel.CardLayout:type package: excel! fullName: Excel.CardLayout summary: Represents the layout of a card in card view. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_19/excel/excel.cardlayoutsection.yml b/docs/docs-ref-autogen/excel_1_19/excel/excel.cardlayoutsection.yml index 5491f6727f..cca1b0c56e 100644 --- a/docs/docs-ref-autogen/excel_1_19/excel/excel.cardlayoutsection.yml +++ b/docs/docs-ref-autogen/excel_1_19/excel/excel.cardlayoutsection.yml @@ -4,7 +4,17 @@ uid: excel!Excel.CardLayoutSection:type package: excel! fullName: Excel.CardLayoutSection summary: Represents the layout of a section of a card in card view. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection), [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection), [Excel.CardLayoutTwoColumnSection](/javascript/api/excel/excel.cardlayouttwocolumnsection)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection), + [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection), + [Excel.CardLayoutTwoColumnSection](/javascript/api/excel/excel.cardlayouttwocolumnsection) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_19/excel/excel.cellcontrol.yml b/docs/docs-ref-autogen/excel_1_19/excel/excel.cellcontrol.yml index ecd03dccf2..5e5954d3df 100644 --- a/docs/docs-ref-autogen/excel_1_19/excel/excel.cellcontrol.yml +++ b/docs/docs-ref-autogen/excel_1_19/excel/excel.cellcontrol.yml @@ -4,7 +4,47 @@ uid: excel!Excel.CellControl:type package: excel! fullName: Excel.CellControl summary: Represents an interactable control inside of a cell. -remarks: "\\[ [API set: ExcelApi 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\n\n\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.UnknownCellControl](/javascript/api/excel/excel.unknowncellcontrol), [Excel.EmptyCellControl](/javascript/api/excel/excel.emptycellcontrol), [Excel.MixedCellControl](/javascript/api/excel/excel.mixedcellcontrol), [Excel.CheckboxCellControl](/javascript/api/excel/excel.checkboxcellcontrol)\r\n\r\n#### Examples\n\n```TypeScript\n// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml\n\n// Add checkboxes to the table.\nawait Excel.run(async (context) => {\n const sheet = context.workbook.worksheets.getActiveWorksheet();\n\n // Get the second column in the table, without the header.\n const range = sheet.tables.getItem(\"FruitTable\").columns.getItem(\"Analysis\").getDataBodyRange();\n\n // Change the boolean values to checkboxes.\n range.control = {\n type: Excel.CellControlType.checkbox\n };\n await context.sync();\n});\n```" +remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + + + Learn more about the types in this type alias through the following links. + + + [Excel.UnknownCellControl](/javascript/api/excel/excel.unknowncellcontrol), + [Excel.EmptyCellControl](/javascript/api/excel/excel.emptycellcontrol), + [Excel.MixedCellControl](/javascript/api/excel/excel.mixedcellcontrol), + [Excel.CheckboxCellControl](/javascript/api/excel/excel.checkboxcellcontrol) + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml + + + // Add checkboxes to the table. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Get the second column in the table, without the header. + const range = sheet.tables.getItem("FruitTable").columns.getItem("Analysis").getDataBodyRange(); + + // Change the boolean values to checkboxes. + range.control = { + type: Excel.CellControlType.checkbox + }; + await context.sync(); + }); + + ``` isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_19/excel/excel.cellvalue.yml b/docs/docs-ref-autogen/excel_1_19/excel/excel.cellvalue.yml index ef4aaccfd2..4722937ebb 100644 --- a/docs/docs-ref-autogen/excel_1_19/excel/excel.cellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_19/excel/excel.cellvalue.yml @@ -4,7 +4,28 @@ uid: excel!Excel.CellValue:type package: excel! fullName: Excel.CellValue summary: Represents the value in a cell. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue), [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), [Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue), [Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue), [Excel.FormattedNumberCellValue](/javascript/api/excel/excel.formattednumbercellvalue), [Excel.FunctionCellValue](/javascript/api/excel/excel.functioncellvalue), [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue), [Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue), [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), [Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue), [Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue), [Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), + [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue), + [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), + [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), + [Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue), + [Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue), + [Excel.FormattedNumberCellValue](/javascript/api/excel/excel.formattednumbercellvalue), + [Excel.FunctionCellValue](/javascript/api/excel/excel.functioncellvalue), + [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue), + [Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue), + [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), + [Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue), + [Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue), + [Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_19/excel/excel.cellvalueandpropertymetadata.yml b/docs/docs-ref-autogen/excel_1_19/excel/excel.cellvalueandpropertymetadata.yml index 566432a914..5f661bb32f 100644 --- a/docs/docs-ref-autogen/excel_1_19/excel/excel.cellvalueandpropertymetadata.yml +++ b/docs/docs-ref-autogen/excel_1_19/excel/excel.cellvalueandpropertymetadata.yml @@ -6,7 +6,16 @@ fullName: Excel.CellValueAndPropertyMetadata summary: >- Represents the value and metadata of a property. The metadata applies to the property (and not the value), but it is combined with the value in this type. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValue](/javascript/api/excel/excel.cellvalue), [Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CellValue](/javascript/api/excel/excel.cellvalue), + [Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_19/excel/excel.compactlayout.yml b/docs/docs-ref-autogen/excel_1_19/excel/excel.compactlayout.yml index 3f25496779..5bb689c662 100644 --- a/docs/docs-ref-autogen/excel_1_19/excel/excel.compactlayout.yml +++ b/docs/docs-ref-autogen/excel_1_19/excel/excel.compactlayout.yml @@ -6,7 +6,15 @@ fullName: Excel.CompactLayout summary: >- Represents the layout used when there is limited space to represent the entity. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_19/excel/excel.entitypropertytype.yml b/docs/docs-ref-autogen/excel_1_19/excel/excel.entitypropertytype.yml index 41a8cc7fcf..bc54a6eff6 100644 --- a/docs/docs-ref-autogen/excel_1_19/excel/excel.entitypropertytype.yml +++ b/docs/docs-ref-autogen/excel_1_19/excel/excel.entitypropertytype.yml @@ -4,7 +4,16 @@ uid: excel!Excel.EntityPropertyType:type package: excel! fullName: Excel.EntityPropertyType summary: Represents the value of a property. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata), [Excel.CellValue](/javascript/api/excel/excel.cellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata), + [Excel.CellValue](/javascript/api/excel/excel.cellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_19/excel/excel.errorcellvalue.yml b/docs/docs-ref-autogen/excel_1_19/excel/excel.errorcellvalue.yml index e5addcc22f..b88b1959c2 100644 --- a/docs/docs-ref-autogen/excel_1_19/excel/excel.errorcellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_19/excel/excel.errorcellvalue.yml @@ -4,7 +4,62 @@ uid: excel!Excel.ErrorCellValue:type package: excel! fullName: Excel.ErrorCellValue summary: Represents a cell value which contains an error. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\n\n\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue), [Excel.BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue), [Excel.CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue), [Excel.ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue), [Excel.Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue), [Excel.ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue), [Excel.FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue), [Excel.GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue), [Excel.NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue), [Excel.NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue), [Excel.NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue), [Excel.NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue), [Excel.PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue), [Excel.RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue), [Excel.SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue), [Excel.ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue)\r\n\r\n#### Examples\n\n```TypeScript\n// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml\n\n// This function sets the value of cell A1 to a #BUSY! error using data types.\nawait Excel.run(async (context) => {\n // Retrieve the Sample worksheet and cell A1 on that sheet.\n const sheet = context.workbook.worksheets.getItemOrNullObject(\"Sample\");\n const range = sheet.getRange(\"A1\");\n\n // Get the error data type and set its type to `busy`.\n const error: Excel.ErrorCellValue = {\n type: Excel.CellValueType.error,\n errorType: Excel.ErrorCellValueType.busy\n };\n\n // Set cell A1 as the busy error.\n range.valuesAsJson = [[error]];\n await context.sync();\n});\n```" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + + + Learn more about the types in this type alias through the following links. + + + [Excel.BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue), + [Excel.BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue), + [Excel.CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue), + [Excel.ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue), + [Excel.Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue), + [Excel.ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue), + [Excel.FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue), + [Excel.GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue), + [Excel.NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue), + [Excel.NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue), + [Excel.NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue), + [Excel.NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue), + [Excel.PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue), + [Excel.RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue), + [Excel.SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue), + [Excel.ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue) + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml + + + // This function sets the value of cell A1 to a #BUSY! error using data types. + + await Excel.run(async (context) => { + // Retrieve the Sample worksheet and cell A1 on that sheet. + const sheet = context.workbook.worksheets.getItemOrNullObject("Sample"); + const range = sheet.getRange("A1"); + + // Get the error data type and set its type to `busy`. + const error: Excel.ErrorCellValue = { + type: Excel.CellValueType.error, + errorType: Excel.ErrorCellValueType.busy + }; + + // Set cell A1 as the busy error. + range.valuesAsJson = [[error]]; + await context.sync(); + }); + + ``` isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_19/excel/excel.functioncellvalue.yml b/docs/docs-ref-autogen/excel_1_19/excel/excel.functioncellvalue.yml index 50b7239609..b1f83d2ff4 100644 --- a/docs/docs-ref-autogen/excel_1_19/excel/excel.functioncellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_19/excel/excel.functioncellvalue.yml @@ -4,7 +4,15 @@ uid: excel!Excel.FunctionCellValue:type package: excel! fullName: Excel.FunctionCellValue summary: Represents a cell value which can be evaluated as a function. -remarks: "\\[ [API set: ExcelApi 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.JavaScriptCustomFunctionReferenceCellValue](/javascript/api/excel/excel.javascriptcustomfunctionreferencecellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.JavaScriptCustomFunctionReferenceCellValue](/javascript/api/excel/excel.javascriptcustomfunctionreferencecellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_19/excel/excel.notavailableerrorcellvalue.yml b/docs/docs-ref-autogen/excel_1_19/excel/excel.notavailableerrorcellvalue.yml index 408016466d..0587e033ac 100644 --- a/docs/docs-ref-autogen/excel_1_19/excel/excel.notavailableerrorcellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_19/excel/excel.notavailableerrorcellvalue.yml @@ -3,7 +3,7 @@ name: Excel.NotAvailableErrorCellValue uid: excel!Excel.NotAvailableErrorCellValue:interface package: excel! fullName: Excel.NotAvailableErrorCellValue -summary: Represents the value of a cell containing a \#N/A! error. +summary: Represents the value of a cell containing a \#N/A error. remarks: >- \[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] @@ -48,9 +48,9 @@ properties: isPreview: false isDeprecated: false syntax: - content: 'basicValue?: "#N/A!" | string;' + content: 'basicValue?: "#N/A" | string;' return: - type: '"#N/A!" | string' + type: '"#N/A" | string' - name: errorType uid: excel!Excel.NotAvailableErrorCellValue#errorType:member package: excel! diff --git a/docs/docs-ref-autogen/excel_1_19/excel/excel.range.yml b/docs/docs-ref-autogen/excel_1_19/excel/excel.range.yml index 1accde8c5f..1fa17ecebd 100644 --- a/docs/docs-ref-autogen/excel_1_19/excel/excel.range.yml +++ b/docs/docs-ref-autogen/excel_1_19/excel/excel.range.yml @@ -2120,7 +2120,8 @@ 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 - Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. + Ctrl+Shift+Arrow key behavior in the + Excel on Windows UI. remarks: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) @@ -2185,7 +2186,8 @@ 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 - Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. + Ctrl+Shift+Arrow key behavior in the + Excel on Windows UI. remarks: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) @@ -2701,8 +2703,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 Ctrl+Arrow key - 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: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) @@ -2766,8 +2768,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 Ctrl+Arrow key - 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: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) diff --git a/docs/docs-ref-autogen/excel_1_19/excel/excel.referencedvalue.yml b/docs/docs-ref-autogen/excel_1_19/excel/excel.referencedvalue.yml index 57044e8ebe..168b4928ba 100644 --- a/docs/docs-ref-autogen/excel_1_19/excel/excel.referencedvalue.yml +++ b/docs/docs-ref-autogen/excel_1_19/excel/excel.referencedvalue.yml @@ -4,7 +4,20 @@ uid: excel!Excel.ReferencedValue:type package: excel! fullName: Excel.ReferencedValue summary: Represents the value in a cell. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), [Excel.RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue), [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), + [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), + [Excel.RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue), + [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), + [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), + [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_1_19/excel/excel.workbook.yml b/docs/docs-ref-autogen/excel_1_19/excel/excel.workbook.yml index 6222650850..bc73fc30d6 100644 --- a/docs/docs-ref-autogen/excel_1_19/excel/excel.workbook.yml +++ b/docs/docs-ref-autogen/excel_1_19/excel/excel.workbook.yml @@ -988,17 +988,22 @@ methods: fullName: insertWorksheetsFromBase64(base64File, options) summary: >- Inserts the specified worksheets from a source workbook into the current - workbook. - - - *Note**: This API is currently only supported for Office on Windows, - Mac, and the web. + workbook. The `extensionHardening` Windows registry key affects this API. + The file extension defined by the `base64File` param must match the real + file type of the inserted file. If `extensionHardening` is set to deny + mismatches and the file extension does not match the real file type, this + API throws the following error: "This operation is not allowed due to the + extension hardening policy." remarks: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + This API is currently only supported for Office on Windows, Mac, and the + web. + + #### Examples diff --git a/docs/docs-ref-autogen/excel_1_8/excel.yml b/docs/docs-ref-autogen/excel_1_8/excel.yml index e59f627060..bad520f776 100644 --- a/docs/docs-ref-autogen/excel_1_8/excel.yml +++ b/docs/docs-ref-autogen/excel_1_8/excel.yml @@ -733,11 +733,16 @@ functions: package: excel! summary: >- Creates and opens a new workbook. Optionally, the workbook can be - pre-populated with a Base64-encoded .xlsx file. Note: Macros can be a - security risk. If this API is used to create a workbook that includes a - macro, the add-in user will be prompted with a "Trust this add-in?" dialog - in the Excel UI. The user must select the "Trust add-in" button to - proceed. + pre-populated with a Base64-encoded .xlsx file. The `extensionHardening` + Windows registry key affects the `base64File` param. The file extension + defined by the param must match the real file type of the file. If + `extensionHardening` is set to deny mismatches and the file extension does + not match the real file type, this API throws the following error: "This + operation is not allowed due to the extension hardening policy." Note: + Macros can be a security risk. If this API is used to create a workbook + that includes a macro, the add-in user will be prompted with a "Trust this + add-in?" dialog in the Excel UI. The user must select the "Trust add-in" + button to proceed. \[ [API set: ExcelApi diff --git a/docs/docs-ref-autogen/excel_1_9/excel.yml b/docs/docs-ref-autogen/excel_1_9/excel.yml index c1d148c4b7..78da41ef4b 100644 --- a/docs/docs-ref-autogen/excel_1_9/excel.yml +++ b/docs/docs-ref-autogen/excel_1_9/excel.yml @@ -873,11 +873,16 @@ functions: package: excel! summary: >- Creates and opens a new workbook. Optionally, the workbook can be - pre-populated with a Base64-encoded .xlsx file. Note: Macros can be a - security risk. If this API is used to create a workbook that includes a - macro, the add-in user will be prompted with a "Trust this add-in?" dialog - in the Excel UI. The user must select the "Trust add-in" button to - proceed. + pre-populated with a Base64-encoded .xlsx file. The `extensionHardening` + Windows registry key affects the `base64File` param. The file extension + defined by the param must match the real file type of the file. If + `extensionHardening` is set to deny mismatches and the file extension does + not match the real file type, this API throws the following error: "This + operation is not allowed due to the extension hardening policy." Note: + Macros can be a security risk. If this API is used to create a workbook + that includes a macro, the add-in user will be prompted with a "Trust this + add-in?" dialog in the Excel UI. The user must select the "Trust add-in" + button to proceed. \[ [API set: ExcelApi diff --git a/docs/docs-ref-autogen/excel_online/excel.yml b/docs/docs-ref-autogen/excel_online/excel.yml index e26f352418..e4bce20e9e 100644 --- a/docs/docs-ref-autogen/excel_online/excel.yml +++ b/docs/docs-ref-autogen/excel_online/excel.yml @@ -1089,11 +1089,16 @@ functions: package: excel! summary: >- Creates and opens a new workbook. Optionally, the workbook can be - pre-populated with a Base64-encoded .xlsx file. Note: Macros can be a - security risk. If this API is used to create a workbook that includes a - macro, the add-in user will be prompted with a "Trust this add-in?" dialog - in the Excel UI. The user must select the "Trust add-in" button to - proceed. + pre-populated with a Base64-encoded .xlsx file. The `extensionHardening` + Windows registry key affects the `base64File` param. The file extension + defined by the param must match the real file type of the file. If + `extensionHardening` is set to deny mismatches and the file extension does + not match the real file type, this API throws the following error: "This + operation is not allowed due to the extension hardening policy." Note: + Macros can be a security risk. If this API is used to create a workbook + that includes a macro, the add-in user will be prompted with a "Trust this + add-in?" dialog in the Excel UI. The user must select the "Trust add-in" + button to proceed. \[ [API set: ExcelApi diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.cardlayout.yml b/docs/docs-ref-autogen/excel_online/excel/excel.cardlayout.yml index 4de2b1d604..07ebbc46e3 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.cardlayout.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.cardlayout.yml @@ -4,7 +4,15 @@ uid: excel!Excel.CardLayout:type package: excel! fullName: Excel.CardLayout summary: Represents the layout of a card in card view. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.EntityCardLayout](/javascript/api/excel/excel.entitycardlayout) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.cardlayoutsection.yml b/docs/docs-ref-autogen/excel_online/excel/excel.cardlayoutsection.yml index 5491f6727f..cca1b0c56e 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.cardlayoutsection.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.cardlayoutsection.yml @@ -4,7 +4,17 @@ uid: excel!Excel.CardLayoutSection:type package: excel! fullName: Excel.CardLayoutSection summary: Represents the layout of a section of a card in card view. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection), [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection), [Excel.CardLayoutTwoColumnSection](/javascript/api/excel/excel.cardlayouttwocolumnsection)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CardLayoutListSection](/javascript/api/excel/excel.cardlayoutlistsection), + [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection), + [Excel.CardLayoutTwoColumnSection](/javascript/api/excel/excel.cardlayouttwocolumnsection) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.cellcontrol.yml b/docs/docs-ref-autogen/excel_online/excel/excel.cellcontrol.yml index ecd03dccf2..5e5954d3df 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.cellcontrol.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.cellcontrol.yml @@ -4,7 +4,47 @@ uid: excel!Excel.CellControl:type package: excel! fullName: Excel.CellControl summary: Represents an interactable control inside of a cell. -remarks: "\\[ [API set: ExcelApi 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\n\n\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.UnknownCellControl](/javascript/api/excel/excel.unknowncellcontrol), [Excel.EmptyCellControl](/javascript/api/excel/excel.emptycellcontrol), [Excel.MixedCellControl](/javascript/api/excel/excel.mixedcellcontrol), [Excel.CheckboxCellControl](/javascript/api/excel/excel.checkboxcellcontrol)\r\n\r\n#### Examples\n\n```TypeScript\n// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml\n\n// Add checkboxes to the table.\nawait Excel.run(async (context) => {\n const sheet = context.workbook.worksheets.getActiveWorksheet();\n\n // Get the second column in the table, without the header.\n const range = sheet.tables.getItem(\"FruitTable\").columns.getItem(\"Analysis\").getDataBodyRange();\n\n // Change the boolean values to checkboxes.\n range.control = {\n type: Excel.CellControlType.checkbox\n };\n await context.sync();\n});\n```" +remarks: >- + \[ [API set: ExcelApi + 1.18](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + + + Learn more about the types in this type alias through the following links. + + + [Excel.UnknownCellControl](/javascript/api/excel/excel.unknowncellcontrol), + [Excel.EmptyCellControl](/javascript/api/excel/excel.emptycellcontrol), + [Excel.MixedCellControl](/javascript/api/excel/excel.mixedcellcontrol), + [Excel.CheckboxCellControl](/javascript/api/excel/excel.checkboxcellcontrol) + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-cell-control.yaml + + + // Add checkboxes to the table. + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Get the second column in the table, without the header. + const range = sheet.tables.getItem("FruitTable").columns.getItem("Analysis").getDataBodyRange(); + + // Change the boolean values to checkboxes. + range.control = { + type: Excel.CellControlType.checkbox + }; + await context.sync(); + }); + + ``` isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.cellvalue.yml b/docs/docs-ref-autogen/excel_online/excel/excel.cellvalue.yml index ef4aaccfd2..4722937ebb 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.cellvalue.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.cellvalue.yml @@ -4,7 +4,28 @@ uid: excel!Excel.CellValue:type package: excel! fullName: Excel.CellValue summary: Represents the value in a cell. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue), [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), [Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue), [Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue), [Excel.FormattedNumberCellValue](/javascript/api/excel/excel.formattednumbercellvalue), [Excel.FunctionCellValue](/javascript/api/excel/excel.functioncellvalue), [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue), [Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue), [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), [Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue), [Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue), [Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), + [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue), + [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), + [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), + [Excel.EmptyCellValue](/javascript/api/excel/excel.emptycellvalue), + [Excel.ErrorCellValue](/javascript/api/excel/excel.errorcellvalue), + [Excel.FormattedNumberCellValue](/javascript/api/excel/excel.formattednumbercellvalue), + [Excel.FunctionCellValue](/javascript/api/excel/excel.functioncellvalue), + [Excel.LinkedEntityCellValue](/javascript/api/excel/excel.linkedentitycellvalue), + [Excel.ReferenceCellValue](/javascript/api/excel/excel.referencecellvalue), + [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), + [Excel.ValueTypeNotAvailableCellValue](/javascript/api/excel/excel.valuetypenotavailablecellvalue), + [Excel.WebImageCellValue](/javascript/api/excel/excel.webimagecellvalue), + [Excel.CellValueExtraProperties](/javascript/api/excel/excel.cellvalueextraproperties) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.cellvalueandpropertymetadata.yml b/docs/docs-ref-autogen/excel_online/excel/excel.cellvalueandpropertymetadata.yml index 566432a914..5f661bb32f 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.cellvalueandpropertymetadata.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.cellvalueandpropertymetadata.yml @@ -6,7 +6,16 @@ fullName: Excel.CellValueAndPropertyMetadata summary: >- Represents the value and metadata of a property. The metadata applies to the property (and not the value), but it is combined with the value in this type. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValue](/javascript/api/excel/excel.cellvalue), [Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CellValue](/javascript/api/excel/excel.cellvalue), + [Excel.EntityPropertyExtraProperties](/javascript/api/excel/excel.entitypropertyextraproperties) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.compactlayout.yml b/docs/docs-ref-autogen/excel_online/excel/excel.compactlayout.yml index 3f25496779..5bb689c662 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.compactlayout.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.compactlayout.yml @@ -6,7 +6,15 @@ fullName: Excel.CompactLayout summary: >- Represents the layout used when there is limited space to represent the entity. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.EntityCompactLayout](/javascript/api/excel/excel.entitycompactlayout) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.entitypropertytype.yml b/docs/docs-ref-autogen/excel_online/excel/excel.entitypropertytype.yml index 41a8cc7fcf..bc54a6eff6 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.entitypropertytype.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.entitypropertytype.yml @@ -4,7 +4,16 @@ uid: excel!Excel.EntityPropertyType:type package: excel! fullName: Excel.EntityPropertyType summary: Represents the value of a property. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata), [Excel.CellValue](/javascript/api/excel/excel.cellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.CellValueAndPropertyMetadata](/javascript/api/excel/excel.cellvalueandpropertymetadata), + [Excel.CellValue](/javascript/api/excel/excel.cellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.errorcellvalue.yml b/docs/docs-ref-autogen/excel_online/excel/excel.errorcellvalue.yml index e5addcc22f..b88b1959c2 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.errorcellvalue.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.errorcellvalue.yml @@ -4,7 +4,62 @@ uid: excel!Excel.ErrorCellValue:type package: excel! fullName: Excel.ErrorCellValue summary: Represents a cell value which contains an error. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\n\n\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue), [Excel.BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue), [Excel.CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue), [Excel.ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue), [Excel.Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue), [Excel.ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue), [Excel.FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue), [Excel.GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue), [Excel.NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue), [Excel.NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue), [Excel.NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue), [Excel.NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue), [Excel.PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue), [Excel.RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue), [Excel.SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue), [Excel.ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue)\r\n\r\n#### Examples\n\n```TypeScript\n// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml\n\n// This function sets the value of cell A1 to a #BUSY! error using data types.\nawait Excel.run(async (context) => {\n // Retrieve the Sample worksheet and cell A1 on that sheet.\n const sheet = context.workbook.worksheets.getItemOrNullObject(\"Sample\");\n const range = sheet.getRange(\"A1\");\n\n // Get the error data type and set its type to `busy`.\n const error: Excel.ErrorCellValue = {\n type: Excel.CellValueType.error,\n errorType: Excel.ErrorCellValueType.busy\n };\n\n // Set cell A1 as the busy error.\n range.valuesAsJson = [[error]];\n await context.sync();\n});\n```" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + + + Learn more about the types in this type alias through the following links. + + + [Excel.BlockedErrorCellValue](/javascript/api/excel/excel.blockederrorcellvalue), + [Excel.BusyErrorCellValue](/javascript/api/excel/excel.busyerrorcellvalue), + [Excel.CalcErrorCellValue](/javascript/api/excel/excel.calcerrorcellvalue), + [Excel.ConnectErrorCellValue](/javascript/api/excel/excel.connecterrorcellvalue), + [Excel.Div0ErrorCellValue](/javascript/api/excel/excel.div0errorcellvalue), + [Excel.ExternalErrorCellValue](/javascript/api/excel/excel.externalerrorcellvalue), + [Excel.FieldErrorCellValue](/javascript/api/excel/excel.fielderrorcellvalue), + [Excel.GettingDataErrorCellValue](/javascript/api/excel/excel.gettingdataerrorcellvalue), + [Excel.NotAvailableErrorCellValue](/javascript/api/excel/excel.notavailableerrorcellvalue), + [Excel.NameErrorCellValue](/javascript/api/excel/excel.nameerrorcellvalue), + [Excel.NullErrorCellValue](/javascript/api/excel/excel.nullerrorcellvalue), + [Excel.NumErrorCellValue](/javascript/api/excel/excel.numerrorcellvalue), + [Excel.PlaceholderErrorCellValue](/javascript/api/excel/excel.placeholdererrorcellvalue), + [Excel.RefErrorCellValue](/javascript/api/excel/excel.referrorcellvalue), + [Excel.SpillErrorCellValue](/javascript/api/excel/excel.spillerrorcellvalue), + [Excel.ValueErrorCellValue](/javascript/api/excel/excel.valueerrorcellvalue) + + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-error-values.yaml + + + // This function sets the value of cell A1 to a #BUSY! error using data types. + + await Excel.run(async (context) => { + // Retrieve the Sample worksheet and cell A1 on that sheet. + const sheet = context.workbook.worksheets.getItemOrNullObject("Sample"); + const range = sheet.getRange("A1"); + + // Get the error data type and set its type to `busy`. + const error: Excel.ErrorCellValue = { + type: Excel.CellValueType.error, + errorType: Excel.ErrorCellValueType.busy + }; + + // Set cell A1 as the busy error. + range.valuesAsJson = [[error]]; + await context.sync(); + }); + + ``` isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.functioncellvalue.yml b/docs/docs-ref-autogen/excel_online/excel/excel.functioncellvalue.yml index 50b7239609..b1f83d2ff4 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.functioncellvalue.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.functioncellvalue.yml @@ -4,7 +4,15 @@ uid: excel!Excel.FunctionCellValue:type package: excel! fullName: Excel.FunctionCellValue summary: Represents a cell value which can be evaluated as a function. -remarks: "\\[ [API set: ExcelApi 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.JavaScriptCustomFunctionReferenceCellValue](/javascript/api/excel/excel.javascriptcustomfunctionreferencecellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.JavaScriptCustomFunctionReferenceCellValue](/javascript/api/excel/excel.javascriptcustomfunctionreferencecellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.notavailableerrorcellvalue.yml b/docs/docs-ref-autogen/excel_online/excel/excel.notavailableerrorcellvalue.yml index 408016466d..0587e033ac 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.notavailableerrorcellvalue.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.notavailableerrorcellvalue.yml @@ -3,7 +3,7 @@ name: Excel.NotAvailableErrorCellValue uid: excel!Excel.NotAvailableErrorCellValue:interface package: excel! fullName: Excel.NotAvailableErrorCellValue -summary: Represents the value of a cell containing a \#N/A! error. +summary: Represents the value of a cell containing a \#N/A error. remarks: >- \[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] @@ -48,9 +48,9 @@ properties: isPreview: false isDeprecated: false syntax: - content: 'basicValue?: "#N/A!" | string;' + content: 'basicValue?: "#N/A" | string;' return: - type: '"#N/A!" | string' + type: '"#N/A" | string' - name: errorType uid: excel!Excel.NotAvailableErrorCellValue#errorType:member package: excel! diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.range.yml b/docs/docs-ref-autogen/excel_online/excel/excel.range.yml index 1accde8c5f..1fa17ecebd 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.range.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.range.yml @@ -2120,7 +2120,8 @@ 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 - Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. + Ctrl+Shift+Arrow key behavior in the + Excel on Windows UI. remarks: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) @@ -2185,7 +2186,8 @@ 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 - Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. + Ctrl+Shift+Arrow key behavior in the + Excel on Windows UI. remarks: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) @@ -2701,8 +2703,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 Ctrl+Arrow key - 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: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) @@ -2766,8 +2768,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 Ctrl+Arrow key - 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: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.referencedvalue.yml b/docs/docs-ref-autogen/excel_online/excel/excel.referencedvalue.yml index 57044e8ebe..168b4928ba 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.referencedvalue.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.referencedvalue.yml @@ -4,7 +4,20 @@ uid: excel!Excel.ReferencedValue:type package: excel! fullName: Excel.ReferencedValue summary: Represents the value in a cell. -remarks: "\\[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \\]\r\n\r\nLearn more about the types in this type alias through the following links. \r\n\r\n[Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), [Excel.RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue), [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue)" +remarks: >- + \[ [API set: ExcelApi + 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + + Learn more about the types in this type alias through the following links. + + + [Excel.ArrayCellValue](/javascript/api/excel/excel.arraycellvalue), + [Excel.EntityCellValue](/javascript/api/excel/excel.entitycellvalue), + [Excel.RootReferenceCellValue](/javascript/api/excel/excel.rootreferencecellvalue), + [Excel.DoubleCellValue](/javascript/api/excel/excel.doublecellvalue), + [Excel.StringCellValue](/javascript/api/excel/excel.stringcellvalue), + [Excel.BooleanCellValue](/javascript/api/excel/excel.booleancellvalue) isPreview: false isDeprecated: false diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.workbook.yml b/docs/docs-ref-autogen/excel_online/excel/excel.workbook.yml index 484099bd67..668381c7a1 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.workbook.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.workbook.yml @@ -1006,17 +1006,22 @@ methods: fullName: insertWorksheetsFromBase64(base64File, options) summary: >- Inserts the specified worksheets from a source workbook into the current - workbook. - - - *Note**: This API is currently only supported for Office on Windows, - Mac, and the web. + workbook. The `extensionHardening` Windows registry key affects this API. + The file extension defined by the `base64File` param must match the real + file type of the inserted file. If `extensionHardening` is set to deny + mismatches and the file extension does not match the real file type, this + API throws the following error: "This operation is not allowed due to the + extension hardening policy." remarks: >- \[ [API set: ExcelApi 1.13](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + This API is currently only supported for Office on Windows, Mac, and the + web. + + #### Examples diff --git a/generate-docs/API Coverage Report.csv b/generate-docs/API Coverage Report.csv index ff48b46528..5125fcd5be 100644 --- a/generate-docs/API Coverage Report.csv +++ b/generate-docs/API Coverage Report.csv @@ -6676,7 +6676,7 @@ Excel.Workbook,"getIsActiveCollabSession()",Method,Excellent,false Excel.Workbook,"getLinkedEntityCellValue(linkedEntityCellValueId)",Method,Great,false Excel.Workbook,"getSelectedRange()",Method,Excellent,true Excel.Workbook,"getSelectedRanges()",Method,Excellent,true -Excel.Workbook,"insertWorksheetsFromBase64(base64File, options)",Method,Good,true +Excel.Workbook,"insertWorksheetsFromBase64(base64File, options)",Method,Great,true Excel.Workbook,"load(options)",Method,Excellent,false Excel.Workbook,"load(propertyNames)",Method,Excellent,false Excel.Workbook,"load(propertyNamesAndPaths)",Method,Excellent,false diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_10/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_10/excel.d.ts index 9fe1343c86..964afc00e7 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_10/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_10/excel.d.ts @@ -581,6 +581,7 @@ export declare namespace Excel { /** * * Creates and opens a new workbook. Optionally, the workbook can be pre-populated with a Base64-encoded .xlsx file. + * The `extensionHardening` Windows registry key affects the `base64File` param. The file extension defined by the param must match the real file type of the file. If `extensionHardening` is set to deny mismatches and the file extension does not match the real file type, this API throws the following error: "This operation is not allowed due to the extension hardening policy." * Note: Macros can be a security risk. If this API is used to create a workbook that includes a macro, the add-in user will be prompted with a "Trust this add-in?" dialog in the Excel UI. The user must select the "Trust add-in" button to proceed. * * [Api set: ExcelApi 1.8] diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_11/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_11/excel.d.ts index ee1d1872a6..cbb2fdfcd8 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_11/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_11/excel.d.ts @@ -581,6 +581,7 @@ export declare namespace Excel { /** * * Creates and opens a new workbook. Optionally, the workbook can be pre-populated with a Base64-encoded .xlsx file. + * The `extensionHardening` Windows registry key affects the `base64File` param. The file extension defined by the param must match the real file type of the file. If `extensionHardening` is set to deny mismatches and the file extension does not match the real file type, this API throws the following error: "This operation is not allowed due to the extension hardening policy." * Note: Macros can be a security risk. If this API is used to create a workbook that includes a macro, the add-in user will be prompted with a "Trust this add-in?" dialog in the Excel UI. The user must select the "Trust add-in" button to proceed. * * [Api set: ExcelApi 1.8] diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_12/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_12/excel.d.ts index 4dddbf04eb..fd15f26769 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_12/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_12/excel.d.ts @@ -581,6 +581,7 @@ export declare namespace Excel { /** * * Creates and opens a new workbook. Optionally, the workbook can be pre-populated with a Base64-encoded .xlsx file. + * The `extensionHardening` Windows registry key affects the `base64File` param. The file extension defined by the param must match the real file type of the file. If `extensionHardening` is set to deny mismatches and the file extension does not match the real file type, this API throws the following error: "This operation is not allowed due to the extension hardening policy." * Note: Macros can be a security risk. If this API is used to create a workbook that includes a macro, the add-in user will be prompted with a "Trust this add-in?" dialog in the Excel UI. The user must select the "Trust add-in" button to proceed. * * [Api set: ExcelApi 1.8] diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_13/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_13/excel.d.ts index 8a811f675c..0ef0959ace 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_13/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_13/excel.d.ts @@ -581,6 +581,7 @@ export declare namespace Excel { /** * * Creates and opens a new workbook. Optionally, the workbook can be pre-populated with a Base64-encoded .xlsx file. + * The `extensionHardening` Windows registry key affects the `base64File` param. The file extension defined by the param must match the real file type of the file. If `extensionHardening` is set to deny mismatches and the file extension does not match the real file type, this API throws the following error: "This operation is not allowed due to the extension hardening policy." * Note: Macros can be a security risk. If this API is used to create a workbook that includes a macro, the add-in user will be prompted with a "Trust this add-in?" dialog in the Excel UI. The user must select the "Trust add-in" button to proceed. * * [Api set: ExcelApi 1.8] @@ -3324,11 +3325,12 @@ export declare namespace Excel { getSelectedRanges(): Excel.RangeAreas; /** * Inserts the specified worksheets from a source workbook into the current workbook. - - **Note**: This API is currently only supported for Office on Windows, Mac, and the web. + * The `extensionHardening` Windows registry key affects this API. The file extension defined by the `base64File` param must match the real file type of the inserted file. If `extensionHardening` is set to deny mismatches and the file extension does not match the real file type, this API throws the following error: "This operation is not allowed due to the extension hardening policy." * * @remarks * [Api set: ExcelApi 1.13] + * + * This API is currently only supported for Office on Windows, Mac, and the web. * * @param base64File - Required. The Base64-encoded string representing the source workbook file. * @param options - Optional. The options that define which worksheets to insert and where in the workbook the new worksheets will be inserted. By default, all the worksheets from the source workbook are inserted at the end of the current workbook. @@ -5055,7 +5057,7 @@ export declare namespace Excel { */ getEntireRow(): Excel.Range; /** - * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. + * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] @@ -5065,7 +5067,7 @@ export declare namespace Excel { */ getExtendedRange(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range; /** - * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. + * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] @@ -5153,7 +5155,7 @@ export declare namespace Excel { getPivotTables(fullyContained?: boolean): Excel.PivotTableScopedCollection; /** - * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. + * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] @@ -5163,7 +5165,7 @@ export declare namespace Excel { */ getRangeEdge(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range; /** - * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. + * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_14/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_14/excel.d.ts index c2e4a36fa5..189d99e7e8 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_14/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_14/excel.d.ts @@ -581,6 +581,7 @@ export declare namespace Excel { /** * * Creates and opens a new workbook. Optionally, the workbook can be pre-populated with a Base64-encoded .xlsx file. + * The `extensionHardening` Windows registry key affects the `base64File` param. The file extension defined by the param must match the real file type of the file. If `extensionHardening` is set to deny mismatches and the file extension does not match the real file type, this API throws the following error: "This operation is not allowed due to the extension hardening policy." * Note: Macros can be a security risk. If this API is used to create a workbook that includes a macro, the add-in user will be prompted with a "Trust this add-in?" dialog in the Excel UI. The user must select the "Trust add-in" button to proceed. * * [Api set: ExcelApi 1.8] @@ -3609,11 +3610,12 @@ export declare namespace Excel { getSelectedRanges(): Excel.RangeAreas; /** * Inserts the specified worksheets from a source workbook into the current workbook. - - **Note**: This API is currently only supported for Office on Windows, Mac, and the web. + * The `extensionHardening` Windows registry key affects this API. The file extension defined by the `base64File` param must match the real file type of the inserted file. If `extensionHardening` is set to deny mismatches and the file extension does not match the real file type, this API throws the following error: "This operation is not allowed due to the extension hardening policy." * * @remarks * [Api set: ExcelApi 1.13] + * + * This API is currently only supported for Office on Windows, Mac, and the web. * * @param base64File - Required. The Base64-encoded string representing the source workbook file. * @param options - Optional. The options that define which worksheets to insert and where in the workbook the new worksheets will be inserted. By default, all the worksheets from the source workbook are inserted at the end of the current workbook. @@ -5362,7 +5364,7 @@ export declare namespace Excel { */ getEntireRow(): Excel.Range; /** - * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. + * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] @@ -5372,7 +5374,7 @@ export declare namespace Excel { */ getExtendedRange(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range; /** - * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. + * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] @@ -5467,7 +5469,7 @@ export declare namespace Excel { */ getPrecedents(): Excel.WorkbookRangeAreas; /** - * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. + * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] @@ -5477,7 +5479,7 @@ export declare namespace Excel { */ getRangeEdge(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range; /** - * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. + * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_15/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_15/excel.d.ts index 83a32424b8..481cf89fdd 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_15/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_15/excel.d.ts @@ -581,6 +581,7 @@ export declare namespace Excel { /** * * Creates and opens a new workbook. Optionally, the workbook can be pre-populated with a Base64-encoded .xlsx file. + * The `extensionHardening` Windows registry key affects the `base64File` param. The file extension defined by the param must match the real file type of the file. If `extensionHardening` is set to deny mismatches and the file extension does not match the real file type, this API throws the following error: "This operation is not allowed due to the extension hardening policy." * Note: Macros can be a security risk. If this API is used to create a workbook that includes a macro, the add-in user will be prompted with a "Trust this add-in?" dialog in the Excel UI. The user must select the "Trust add-in" button to proceed. * * [Api set: ExcelApi 1.8] @@ -3634,11 +3635,12 @@ export declare namespace Excel { getSelectedRanges(): Excel.RangeAreas; /** * Inserts the specified worksheets from a source workbook into the current workbook. - - **Note**: This API is currently only supported for Office on Windows, Mac, and the web. + * The `extensionHardening` Windows registry key affects this API. The file extension defined by the `base64File` param must match the real file type of the inserted file. If `extensionHardening` is set to deny mismatches and the file extension does not match the real file type, this API throws the following error: "This operation is not allowed due to the extension hardening policy." * * @remarks * [Api set: ExcelApi 1.13] + * + * This API is currently only supported for Office on Windows, Mac, and the web. * * @param base64File - Required. The Base64-encoded string representing the source workbook file. * @param options - Optional. The options that define which worksheets to insert and where in the workbook the new worksheets will be inserted. By default, all the worksheets from the source workbook are inserted at the end of the current workbook. @@ -5394,7 +5396,7 @@ export declare namespace Excel { */ getEntireRow(): Excel.Range; /** - * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. + * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] @@ -5404,7 +5406,7 @@ export declare namespace Excel { */ getExtendedRange(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range; /** - * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. + * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] @@ -5499,7 +5501,7 @@ export declare namespace Excel { */ getPrecedents(): Excel.WorkbookRangeAreas; /** - * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. + * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] @@ -5509,7 +5511,7 @@ export declare namespace Excel { */ getRangeEdge(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range; /** - * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. + * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_16/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_16/excel.d.ts index 5fc47f25ba..a3db684dec 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_16/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_16/excel.d.ts @@ -5661,7 +5661,7 @@ export declare namespace Excel { provider?: CellValueProviderAttributes; } /** - * Represents the value of a cell containing a #N/A! error. + * Represents the value of a cell containing a #N/A error. * * @remarks * [Api set: ExcelApi 1.16] @@ -5682,7 +5682,7 @@ export declare namespace Excel { * @remarks * [Api set: ExcelApi 1.16] */ - basicValue?: "#N/A!" | string; + basicValue?: "#N/A" | string; /** * Represents the value that would be returned by `Range.valueTypes` for a cell with this value. * @@ -6854,6 +6854,7 @@ export declare namespace Excel { /** * * Creates and opens a new workbook. Optionally, the workbook can be pre-populated with a Base64-encoded .xlsx file. + * The `extensionHardening` Windows registry key affects the `base64File` param. The file extension defined by the param must match the real file type of the file. If `extensionHardening` is set to deny mismatches and the file extension does not match the real file type, this API throws the following error: "This operation is not allowed due to the extension hardening policy." * Note: Macros can be a security risk. If this API is used to create a workbook that includes a macro, the add-in user will be prompted with a "Trust this add-in?" dialog in the Excel UI. The user must select the "Trust add-in" button to proceed. * * [Api set: ExcelApi 1.8] @@ -9929,11 +9930,12 @@ export declare namespace Excel { getSelectedRanges(): Excel.RangeAreas; /** * Inserts the specified worksheets from a source workbook into the current workbook. - - **Note**: This API is currently only supported for Office on Windows, Mac, and the web. + * The `extensionHardening` Windows registry key affects this API. The file extension defined by the `base64File` param must match the real file type of the inserted file. If `extensionHardening` is set to deny mismatches and the file extension does not match the real file type, this API throws the following error: "This operation is not allowed due to the extension hardening policy." * * @remarks * [Api set: ExcelApi 1.13] + * + * This API is currently only supported for Office on Windows, Mac, and the web. * * @param base64File - Required. The Base64-encoded string representing the source workbook file. * @param options - Optional. The options that define which worksheets to insert and where in the workbook the new worksheets will be inserted. By default, all the worksheets from the source workbook are inserted at the end of the current workbook. @@ -11705,7 +11707,7 @@ export declare namespace Excel { */ getEntireRow(): Excel.Range; /** - * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. + * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] @@ -11715,7 +11717,7 @@ export declare namespace Excel { */ getExtendedRange(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range; /** - * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. + * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] @@ -11810,7 +11812,7 @@ export declare namespace Excel { */ getPrecedents(): Excel.WorkbookRangeAreas; /** - * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. + * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] @@ -11820,7 +11822,7 @@ export declare namespace Excel { */ getRangeEdge(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range; /** - * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. + * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_17/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_17/excel.d.ts index 5bf16bea86..7b390b6ee1 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_17/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_17/excel.d.ts @@ -5661,7 +5661,7 @@ export declare namespace Excel { provider?: CellValueProviderAttributes; } /** - * Represents the value of a cell containing a #N/A! error. + * Represents the value of a cell containing a #N/A error. * * @remarks * [Api set: ExcelApi 1.16] @@ -5682,7 +5682,7 @@ export declare namespace Excel { * @remarks * [Api set: ExcelApi 1.16] */ - basicValue?: "#N/A!" | string; + basicValue?: "#N/A" | string; /** * Represents the value that would be returned by `Range.valueTypes` for a cell with this value. * @@ -6854,6 +6854,7 @@ export declare namespace Excel { /** * * Creates and opens a new workbook. Optionally, the workbook can be pre-populated with a Base64-encoded .xlsx file. + * The `extensionHardening` Windows registry key affects the `base64File` param. The file extension defined by the param must match the real file type of the file. If `extensionHardening` is set to deny mismatches and the file extension does not match the real file type, this API throws the following error: "This operation is not allowed due to the extension hardening policy." * Note: Macros can be a security risk. If this API is used to create a workbook that includes a macro, the add-in user will be prompted with a "Trust this add-in?" dialog in the Excel UI. The user must select the "Trust add-in" button to proceed. * * [Api set: ExcelApi 1.8] @@ -10062,11 +10063,12 @@ export declare namespace Excel { getSelectedRanges(): Excel.RangeAreas; /** * Inserts the specified worksheets from a source workbook into the current workbook. - - **Note**: This API is currently only supported for Office on Windows, Mac, and the web. + * The `extensionHardening` Windows registry key affects this API. The file extension defined by the `base64File` param must match the real file type of the inserted file. If `extensionHardening` is set to deny mismatches and the file extension does not match the real file type, this API throws the following error: "This operation is not allowed due to the extension hardening policy." * * @remarks * [Api set: ExcelApi 1.13] + * + * This API is currently only supported for Office on Windows, Mac, and the web. * * @param base64File - Required. The Base64-encoded string representing the source workbook file. * @param options - Optional. The options that define which worksheets to insert and where in the workbook the new worksheets will be inserted. By default, all the worksheets from the source workbook are inserted at the end of the current workbook. @@ -11878,7 +11880,7 @@ export declare namespace Excel { */ getEntireRow(): Excel.Range; /** - * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. + * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] @@ -11888,7 +11890,7 @@ export declare namespace Excel { */ getExtendedRange(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range; /** - * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. + * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] @@ -11983,7 +11985,7 @@ export declare namespace Excel { */ getPrecedents(): Excel.WorkbookRangeAreas; /** - * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. + * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] @@ -11993,7 +11995,7 @@ export declare namespace Excel { */ getRangeEdge(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range; /** - * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. + * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_18/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_18/excel.d.ts index ff23b30548..d3e120a2d3 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_18/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_18/excel.d.ts @@ -5702,7 +5702,7 @@ export declare namespace Excel { provider?: CellValueProviderAttributes; } /** - * Represents the value of a cell containing a #N/A! error. + * Represents the value of a cell containing a #N/A error. * * @remarks * [Api set: ExcelApi 1.16] @@ -5723,7 +5723,7 @@ export declare namespace Excel { * @remarks * [Api set: ExcelApi 1.16] */ - basicValue?: "#N/A!" | string; + basicValue?: "#N/A" | string; /** * Represents the value that would be returned by `Range.valueTypes` for a cell with this value. * @@ -6907,6 +6907,7 @@ export declare namespace Excel { /** * * Creates and opens a new workbook. Optionally, the workbook can be pre-populated with a Base64-encoded .xlsx file. + * The `extensionHardening` Windows registry key affects the `base64File` param. The file extension defined by the param must match the real file type of the file. If `extensionHardening` is set to deny mismatches and the file extension does not match the real file type, this API throws the following error: "This operation is not allowed due to the extension hardening policy." * Note: Macros can be a security risk. If this API is used to create a workbook that includes a macro, the add-in user will be prompted with a "Trust this add-in?" dialog in the Excel UI. The user must select the "Trust add-in" button to proceed. * * [Api set: ExcelApi 1.8] @@ -10153,11 +10154,12 @@ export declare namespace Excel { getSelectedRanges(): Excel.RangeAreas; /** * Inserts the specified worksheets from a source workbook into the current workbook. - - **Note**: This API is currently only supported for Office on Windows, Mac, and the web. + * The `extensionHardening` Windows registry key affects this API. The file extension defined by the `base64File` param must match the real file type of the inserted file. If `extensionHardening` is set to deny mismatches and the file extension does not match the real file type, this API throws the following error: "This operation is not allowed due to the extension hardening policy." * * @remarks * [Api set: ExcelApi 1.13] + * + * This API is currently only supported for Office on Windows, Mac, and the web. * * @param base64File - Required. The Base64-encoded string representing the source workbook file. * @param options - Optional. The options that define which worksheets to insert and where in the workbook the new worksheets will be inserted. By default, all the worksheets from the source workbook are inserted at the end of the current workbook. @@ -11990,7 +11992,7 @@ export declare namespace Excel { */ getEntireRow(): Excel.Range; /** - * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. + * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] @@ -12000,7 +12002,7 @@ export declare namespace Excel { */ getExtendedRange(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range; /** - * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. + * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] @@ -12095,7 +12097,7 @@ export declare namespace Excel { */ getPrecedents(): Excel.WorkbookRangeAreas; /** - * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. + * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] @@ -12105,7 +12107,7 @@ export declare namespace Excel { */ getRangeEdge(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range; /** - * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. + * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_19/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_19/excel.d.ts index 61560ea69b..39ed95bbff 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_19/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_19/excel.d.ts @@ -6061,7 +6061,7 @@ export declare namespace Excel { provider?: CellValueProviderAttributes; } /** - * Represents the value of a cell containing a #N/A! error. + * Represents the value of a cell containing a #N/A error. * * @remarks * [Api set: ExcelApi 1.16] @@ -6082,7 +6082,7 @@ export declare namespace Excel { * @remarks * [Api set: ExcelApi 1.16] */ - basicValue?: "#N/A!" | string; + basicValue?: "#N/A" | string; /** * Represents the value that would be returned by `Range.valueTypes` for a cell with this value. * @@ -7294,6 +7294,7 @@ export declare namespace Excel { /** * * Creates and opens a new workbook. Optionally, the workbook can be pre-populated with a Base64-encoded .xlsx file. + * The `extensionHardening` Windows registry key affects the `base64File` param. The file extension defined by the param must match the real file type of the file. If `extensionHardening` is set to deny mismatches and the file extension does not match the real file type, this API throws the following error: "This operation is not allowed due to the extension hardening policy." * Note: Macros can be a security risk. If this API is used to create a workbook that includes a macro, the add-in user will be prompted with a "Trust this add-in?" dialog in the Excel UI. The user must select the "Trust add-in" button to proceed. * * [Api set: ExcelApi 1.8] @@ -10561,11 +10562,12 @@ export declare namespace Excel { getSelectedRanges(): Excel.RangeAreas; /** * Inserts the specified worksheets from a source workbook into the current workbook. - - **Note**: This API is currently only supported for Office on Windows, Mac, and the web. + * The `extensionHardening` Windows registry key affects this API. The file extension defined by the `base64File` param must match the real file type of the inserted file. If `extensionHardening` is set to deny mismatches and the file extension does not match the real file type, this API throws the following error: "This operation is not allowed due to the extension hardening policy." * * @remarks * [Api set: ExcelApi 1.13] + * + * This API is currently only supported for Office on Windows, Mac, and the web. * * @param base64File - Required. The Base64-encoded string representing the source workbook file. * @param options - Optional. The options that define which worksheets to insert and where in the workbook the new worksheets will be inserted. By default, all the worksheets from the source workbook are inserted at the end of the current workbook. @@ -12414,7 +12416,7 @@ export declare namespace Excel { */ getEntireRow(): Excel.Range; /** - * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. + * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] @@ -12424,7 +12426,7 @@ export declare namespace Excel { */ getExtendedRange(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range; /** - * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. + * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] @@ -12519,7 +12521,7 @@ export declare namespace Excel { */ getPrecedents(): Excel.WorkbookRangeAreas; /** - * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. + * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] @@ -12529,7 +12531,7 @@ export declare namespace Excel { */ getRangeEdge(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range; /** - * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. + * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_8/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_8/excel.d.ts index 4a357a8b34..68fd8681cd 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_8/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_8/excel.d.ts @@ -102,6 +102,7 @@ export declare namespace Excel { /** * * Creates and opens a new workbook. Optionally, the workbook can be pre-populated with a Base64-encoded .xlsx file. + * The `extensionHardening` Windows registry key affects the `base64File` param. The file extension defined by the param must match the real file type of the file. If `extensionHardening` is set to deny mismatches and the file extension does not match the real file type, this API throws the following error: "This operation is not allowed due to the extension hardening policy." * Note: Macros can be a security risk. If this API is used to create a workbook that includes a macro, the add-in user will be prompted with a "Trust this add-in?" dialog in the Excel UI. The user must select the "Trust add-in" button to proceed. * * [Api set: ExcelApi 1.8] diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_9/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_1_9/excel.d.ts index eccd70415e..f4b82d910d 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_9/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_9/excel.d.ts @@ -581,6 +581,7 @@ export declare namespace Excel { /** * * Creates and opens a new workbook. Optionally, the workbook can be pre-populated with a Base64-encoded .xlsx file. + * The `extensionHardening` Windows registry key affects the `base64File` param. The file extension defined by the param must match the real file type of the file. If `extensionHardening` is set to deny mismatches and the file extension does not match the real file type, this API throws the following error: "This operation is not allowed due to the extension hardening policy." * Note: Macros can be a security risk. If this API is used to create a workbook that includes a macro, the add-in user will be prompted with a "Trust this add-in?" dialog in the Excel UI. The user must select the "Trust add-in" button to proceed. * * [Api set: ExcelApi 1.8] diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_online/excel.d.ts b/generate-docs/api-extractor-inputs-excel-release/Excel_online/excel.d.ts index 55cb28de52..216103776f 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_online/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_online/excel.d.ts @@ -6061,7 +6061,7 @@ export declare namespace Excel { provider?: CellValueProviderAttributes; } /** - * Represents the value of a cell containing a #N/A! error. + * Represents the value of a cell containing a #N/A error. * * @remarks * [Api set: ExcelApi 1.16] @@ -6082,7 +6082,7 @@ export declare namespace Excel { * @remarks * [Api set: ExcelApi 1.16] */ - basicValue?: "#N/A!" | string; + basicValue?: "#N/A" | string; /** * Represents the value that would be returned by `Range.valueTypes` for a cell with this value. * @@ -7294,6 +7294,7 @@ export declare namespace Excel { /** * * Creates and opens a new workbook. Optionally, the workbook can be pre-populated with a Base64-encoded .xlsx file. + * The `extensionHardening` Windows registry key affects the `base64File` param. The file extension defined by the param must match the real file type of the file. If `extensionHardening` is set to deny mismatches and the file extension does not match the real file type, this API throws the following error: "This operation is not allowed due to the extension hardening policy." * Note: Macros can be a security risk. If this API is used to create a workbook that includes a macro, the add-in user will be prompted with a "Trust this add-in?" dialog in the Excel UI. The user must select the "Trust add-in" button to proceed. * * [Api set: ExcelApi 1.8] @@ -10958,11 +10959,12 @@ export declare namespace Excel { getSelectedRanges(): Excel.RangeAreas; /** * Inserts the specified worksheets from a source workbook into the current workbook. - - **Note**: This API is currently only supported for Office on Windows, Mac, and the web. + * The `extensionHardening` Windows registry key affects this API. The file extension defined by the `base64File` param must match the real file type of the inserted file. If `extensionHardening` is set to deny mismatches and the file extension does not match the real file type, this API throws the following error: "This operation is not allowed due to the extension hardening policy." * * @remarks * [Api set: ExcelApi 1.13] + * + * This API is currently only supported for Office on Windows, Mac, and the web. * * @param base64File - Required. The Base64-encoded string representing the source workbook file. * @param options - Optional. The options that define which worksheets to insert and where in the workbook the new worksheets will be inserted. By default, all the worksheets from the source workbook are inserted at the end of the current workbook. @@ -12900,7 +12902,7 @@ export declare namespace Excel { */ getEntireRow(): Excel.Range; /** - * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. + * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] @@ -12910,7 +12912,7 @@ export declare namespace Excel { */ getExtendedRange(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range; /** - * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. + * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] @@ -13005,7 +13007,7 @@ export declare namespace Excel { */ getPrecedents(): Excel.WorkbookRangeAreas; /** - * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. + * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] @@ -13015,7 +13017,7 @@ export declare namespace Excel { */ getRangeEdge(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range; /** - * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. + * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] diff --git a/generate-docs/api-extractor-inputs-excel/excel.d.ts b/generate-docs/api-extractor-inputs-excel/excel.d.ts index 7d73000ee8..f751a4db02 100644 --- a/generate-docs/api-extractor-inputs-excel/excel.d.ts +++ b/generate-docs/api-extractor-inputs-excel/excel.d.ts @@ -6773,7 +6773,7 @@ export declare namespace Excel { cachedUid: string; } /** - * Represents types of #N/A! errors. + * Represents types of #N/A errors. * * @remarks * [Api set: ExcelApi BETA (PREVIEW ONLY)] @@ -6781,7 +6781,7 @@ export declare namespace Excel { */ enum NotAvailableErrorCellValueSubType { /** - * An unknown type of error. Displays as error type #N/A! in Excel. + * An unknown type of error. Displays as error type #N/A in Excel. * * @remarks * [Api set: ExcelApi BETA (PREVIEW ONLY)] @@ -6789,7 +6789,7 @@ export declare namespace Excel { */ unknown = "Unknown", /** - * An error caused by `VLOOKUP` not finding its `lookup_value` in the search range. Displays as error type #N/A! in Excel. + * An error caused by `VLOOKUP` not finding its `lookup_value` in the search range. Displays as error type #N/A in Excel. * * @remarks * [Api set: ExcelApi BETA (PREVIEW ONLY)] @@ -6797,7 +6797,7 @@ export declare namespace Excel { */ vlookupValueNotFound = "VlookupValueNotFound", /** - * An error caused by `HLOOKUP` not finding its `lookup_value` in the search range. Displays as error type #N/A! in Excel. + * An error caused by `HLOOKUP` not finding its `lookup_value` in the search range. Displays as error type #N/A in Excel. * * @remarks * [Api set: ExcelApi BETA (PREVIEW ONLY)] @@ -6805,7 +6805,7 @@ export declare namespace Excel { */ hlookupValueNotFound = "HlookupValueNotFound", /** - * An error caused by an invalid property argument to `STOCKHISTORY`. Displays as error type #N/A! in Excel. + * An error caused by an invalid property argument to `STOCKHISTORY`. Displays as error type #N/A in Excel. * * @remarks * [Api set: ExcelApi BETA (PREVIEW ONLY)] @@ -6813,7 +6813,7 @@ export declare namespace Excel { */ stockHistoryInvalidProperty = "StockHistoryInvalidProperty", /** - * An error caused by no data being available for a `STOCKHISTORY` function. Displays as error type #N/A! in Excel. + * An error caused by no data being available for a `STOCKHISTORY` function. Displays as error type #N/A in Excel. * * @remarks * [Api set: ExcelApi BETA (PREVIEW ONLY)] @@ -6821,7 +6821,7 @@ export declare namespace Excel { */ stockHistoryNoData = "StockHistoryNoData", /** - * An error caused by an external code service returning an unknown object. Displays as error type #N/A! in Excel. + * An error caused by an external code service returning an unknown object. Displays as error type #N/A in Excel. * * @remarks * [Api set: ExcelApi BETA (PREVIEW ONLY)] @@ -6829,7 +6829,7 @@ export declare namespace Excel { */ pythonObjectUnknown = "PythonObjectUnknown", /** - * No match was found for the pattern in the text provided. Displays as error type #N/A! in Excel. + * No match was found for the pattern in the text provided. Displays as error type #N/A in Excel. * * @remarks * [Api set: ExcelApi BETA (PREVIEW ONLY)] @@ -6837,7 +6837,7 @@ export declare namespace Excel { */ eRegexMatchNoResult = "ERegexMatchNoResult", /** - * Occurrence is greater than the total number of matches. Displays as error type #N/A! in Excel. + * Occurrence is greater than the total number of matches. Displays as error type #N/A in Excel. * * @remarks * [Api set: ExcelApi BETA (PREVIEW ONLY)] @@ -6845,7 +6845,7 @@ export declare namespace Excel { */ eRegexReplaceOccurrenceNoResult = "ERegexReplaceOccurrenceNoResult", /** - * No capture groups were matched. Displays as error type #N/A! in Excel. + * No capture groups were matched. Displays as error type #N/A in Excel. * * @remarks * [Api set: ExcelApi BETA (PREVIEW ONLY)] @@ -6854,7 +6854,7 @@ export declare namespace Excel { eRegexMatchNoCapture = "ERegexMatchNoCapture" } /** - * Represents the value of a cell containing a #N/A! error. + * Represents the value of a cell containing a #N/A error. * * @remarks * [Api set: ExcelApi 1.16] @@ -6875,7 +6875,7 @@ export declare namespace Excel { * @remarks * [Api set: ExcelApi 1.16] */ - basicValue?: "#N/A!" | string; + basicValue?: "#N/A" | string; /** * Represents the value that would be returned by `Range.valueTypes` for a cell with this value. * @@ -8956,6 +8956,7 @@ export declare namespace Excel { /** * * Creates and opens a new workbook. Optionally, the workbook can be pre-populated with a Base64-encoded .xlsx file. + * The `extensionHardening` Windows registry key affects the `base64File` param. The file extension defined by the param must match the real file type of the file. If `extensionHardening` is set to deny mismatches and the file extension does not match the real file type, this API throws the following error: "This operation is not allowed due to the extension hardening policy." * Note: Macros can be a security risk. If this API is used to create a workbook that includes a macro, the add-in user will be prompted with a "Trust this add-in?" dialog in the Excel UI. The user must select the "Trust add-in" button to proceed. * * [Api set: ExcelApi 1.8] @@ -14561,11 +14562,12 @@ export declare namespace Excel { getSelectedRanges(): Excel.RangeAreas; /** * Inserts the specified worksheets from a source workbook into the current workbook. - - **Note**: This API is currently only supported for Office on Windows, Mac, and the web. + * The `extensionHardening` Windows registry key affects this API. The file extension defined by the `base64File` param must match the real file type of the inserted file. If `extensionHardening` is set to deny mismatches and the file extension does not match the real file type, this API throws the following error: "This operation is not allowed due to the extension hardening policy." * * @remarks * [Api set: ExcelApi 1.13] + * + * This API is currently only supported for Office on Windows, Mac, and the web. * * @param base64File - Required. The Base64-encoded string representing the source workbook file. * @param options - Optional. The options that define which worksheets to insert and where in the workbook the new worksheets will be inserted. By default, all the worksheets from the source workbook are inserted at the end of the current workbook. @@ -16563,7 +16565,7 @@ export declare namespace Excel { */ getEntireRow(): Excel.Range; /** - * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. + * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] @@ -16573,7 +16575,7 @@ export declare namespace Excel { */ getExtendedRange(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range; /** - * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. + * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] @@ -16668,7 +16670,7 @@ export declare namespace Excel { */ getPrecedents(): Excel.WorkbookRangeAreas; /** - * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. + * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] @@ -16678,7 +16680,7 @@ export declare namespace Excel { */ getRangeEdge(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range; /** - * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. + * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] diff --git a/generate-docs/script-inputs/office.d.ts b/generate-docs/script-inputs/office.d.ts index b52e16cc79..8c2781ecaa 100644 --- a/generate-docs/script-inputs/office.d.ts +++ b/generate-docs/script-inputs/office.d.ts @@ -30805,7 +30805,7 @@ declare namespace Excel { provider?: CellValueProviderAttributes; } /** - * Represents the value of a cell containing a #N/A! error. + * Represents the value of a cell containing a #N/A error. * * @remarks * [Api set: ExcelApi 1.16] @@ -30826,7 +30826,7 @@ declare namespace Excel { * @remarks * [Api set: ExcelApi 1.16] */ - basicValue?: "#N/A!" | string; + basicValue?: "#N/A" | string; /** * Represents the value that would be returned by `Range.valueTypes` for a cell with this value. * @@ -32038,6 +32038,7 @@ declare namespace Excel { /** * * Creates and opens a new workbook. Optionally, the workbook can be pre-populated with a Base64-encoded .xlsx file. + * The `extensionHardening` Windows registry key affects the `base64File` param. The file extension defined by the param must match the real file type of the file. If `extensionHardening` is set to deny mismatches and the file extension does not match the real file type, this API throws the following error: "This operation is not allowed due to the extension hardening policy." * Note: Macros can be a security risk. If this API is used to create a workbook that includes a macro, the add-in user will be prompted with a "Trust this add-in?" dialog in the Excel UI. The user must select the "Trust add-in" button to proceed. * * [Api set: ExcelApi 1.8] @@ -35680,11 +35681,12 @@ declare namespace Excel { getSelectedRanges(): Excel.RangeAreas; /** * Inserts the specified worksheets from a source workbook into the current workbook. - - **Note**: This API is currently only supported for Office on Windows, Mac, and the web. + * The `extensionHardening` Windows registry key affects this API. The file extension defined by the `base64File` param must match the real file type of the inserted file. If `extensionHardening` is set to deny mismatches and the file extension does not match the real file type, this API throws the following error: "This operation is not allowed due to the extension hardening policy." * * @remarks * [Api set: ExcelApi 1.13] + * + * This API is currently only supported for Office on Windows, Mac, and the web. * * @param base64File Required. The Base64-encoded string representing the source workbook file. * @param options Optional. The options that define which worksheets to insert and where in the workbook the new worksheets will be inserted. By default, all the worksheets from the source workbook are inserted at the end of the current workbook. @@ -37622,7 +37624,7 @@ declare namespace Excel { */ getEntireRow(): Excel.Range; /** - * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. + * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] @@ -37632,7 +37634,7 @@ declare namespace Excel { */ getExtendedRange(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range; /** - * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. + * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] @@ -37727,7 +37729,7 @@ declare namespace Excel { */ getPrecedents(): Excel.WorkbookRangeAreas; /** - * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. + * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] @@ -37737,7 +37739,7 @@ declare namespace Excel { */ getRangeEdge(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range; /** - * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. + * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] diff --git a/generate-docs/script-inputs/office_preview.d.ts b/generate-docs/script-inputs/office_preview.d.ts index ad4a63670d..5babeff856 100644 --- a/generate-docs/script-inputs/office_preview.d.ts +++ b/generate-docs/script-inputs/office_preview.d.ts @@ -31880,7 +31880,7 @@ declare namespace Excel { cachedUid: string; } /** - * Represents types of #N/A! errors. + * Represents types of #N/A errors. * * @remarks * [Api set: ExcelApi BETA (PREVIEW ONLY)] @@ -31888,7 +31888,7 @@ declare namespace Excel { */ enum NotAvailableErrorCellValueSubType { /** - * An unknown type of error. Displays as error type #N/A! in Excel. + * An unknown type of error. Displays as error type #N/A in Excel. * * @remarks * [Api set: ExcelApi BETA (PREVIEW ONLY)] @@ -31896,7 +31896,7 @@ declare namespace Excel { */ unknown = "Unknown", /** - * An error caused by `VLOOKUP` not finding its `lookup_value` in the search range. Displays as error type #N/A! in Excel. + * An error caused by `VLOOKUP` not finding its `lookup_value` in the search range. Displays as error type #N/A in Excel. * * @remarks * [Api set: ExcelApi BETA (PREVIEW ONLY)] @@ -31904,7 +31904,7 @@ declare namespace Excel { */ vlookupValueNotFound = "VlookupValueNotFound", /** - * An error caused by `HLOOKUP` not finding its `lookup_value` in the search range. Displays as error type #N/A! in Excel. + * An error caused by `HLOOKUP` not finding its `lookup_value` in the search range. Displays as error type #N/A in Excel. * * @remarks * [Api set: ExcelApi BETA (PREVIEW ONLY)] @@ -31912,7 +31912,7 @@ declare namespace Excel { */ hlookupValueNotFound = "HlookupValueNotFound", /** - * An error caused by an invalid property argument to `STOCKHISTORY`. Displays as error type #N/A! in Excel. + * An error caused by an invalid property argument to `STOCKHISTORY`. Displays as error type #N/A in Excel. * * @remarks * [Api set: ExcelApi BETA (PREVIEW ONLY)] @@ -31920,7 +31920,7 @@ declare namespace Excel { */ stockHistoryInvalidProperty = "StockHistoryInvalidProperty", /** - * An error caused by no data being available for a `STOCKHISTORY` function. Displays as error type #N/A! in Excel. + * An error caused by no data being available for a `STOCKHISTORY` function. Displays as error type #N/A in Excel. * * @remarks * [Api set: ExcelApi BETA (PREVIEW ONLY)] @@ -31928,7 +31928,7 @@ declare namespace Excel { */ stockHistoryNoData = "StockHistoryNoData", /** - * An error caused by an external code service returning an unknown object. Displays as error type #N/A! in Excel. + * An error caused by an external code service returning an unknown object. Displays as error type #N/A in Excel. * * @remarks * [Api set: ExcelApi BETA (PREVIEW ONLY)] @@ -31936,7 +31936,7 @@ declare namespace Excel { */ pythonObjectUnknown = "PythonObjectUnknown", /** - * No match was found for the pattern in the text provided. Displays as error type #N/A! in Excel. + * No match was found for the pattern in the text provided. Displays as error type #N/A in Excel. * * @remarks * [Api set: ExcelApi BETA (PREVIEW ONLY)] @@ -31944,7 +31944,7 @@ declare namespace Excel { */ eRegexMatchNoResult = "ERegexMatchNoResult", /** - * Occurrence is greater than the total number of matches. Displays as error type #N/A! in Excel. + * Occurrence is greater than the total number of matches. Displays as error type #N/A in Excel. * * @remarks * [Api set: ExcelApi BETA (PREVIEW ONLY)] @@ -31952,7 +31952,7 @@ declare namespace Excel { */ eRegexReplaceOccurrenceNoResult = "ERegexReplaceOccurrenceNoResult", /** - * No capture groups were matched. Displays as error type #N/A! in Excel. + * No capture groups were matched. Displays as error type #N/A in Excel. * * @remarks * [Api set: ExcelApi BETA (PREVIEW ONLY)] @@ -31961,7 +31961,7 @@ declare namespace Excel { eRegexMatchNoCapture = "ERegexMatchNoCapture" } /** - * Represents the value of a cell containing a #N/A! error. + * Represents the value of a cell containing a #N/A error. * * @remarks * [Api set: ExcelApi 1.16] @@ -31982,7 +31982,7 @@ declare namespace Excel { * @remarks * [Api set: ExcelApi 1.16] */ - basicValue?: "#N/A!" | string; + basicValue?: "#N/A" | string; /** * Represents the value that would be returned by `Range.valueTypes` for a cell with this value. * @@ -34063,6 +34063,7 @@ declare namespace Excel { /** * * Creates and opens a new workbook. Optionally, the workbook can be pre-populated with a Base64-encoded .xlsx file. + * The `extensionHardening` Windows registry key affects the `base64File` param. The file extension defined by the param must match the real file type of the file. If `extensionHardening` is set to deny mismatches and the file extension does not match the real file type, this API throws the following error: "This operation is not allowed due to the extension hardening policy." * Note: Macros can be a security risk. If this API is used to create a workbook that includes a macro, the add-in user will be prompted with a "Trust this add-in?" dialog in the Excel UI. The user must select the "Trust add-in" button to proceed. * * [Api set: ExcelApi 1.8] @@ -39646,11 +39647,12 @@ declare namespace Excel { getSelectedRanges(): Excel.RangeAreas; /** * Inserts the specified worksheets from a source workbook into the current workbook. - - **Note**: This API is currently only supported for Office on Windows, Mac, and the web. + * The `extensionHardening` Windows registry key affects this API. The file extension defined by the `base64File` param must match the real file type of the inserted file. If `extensionHardening` is set to deny mismatches and the file extension does not match the real file type, this API throws the following error: "This operation is not allowed due to the extension hardening policy." * * @remarks * [Api set: ExcelApi 1.13] + * + * This API is currently only supported for Office on Windows, Mac, and the web. * * @param base64File Required. The Base64-encoded string representing the source workbook file. * @param options Optional. The options that define which worksheets to insert and where in the workbook the new worksheets will be inserted. By default, all the worksheets from the source workbook are inserted at the end of the current workbook. @@ -41648,7 +41650,7 @@ declare namespace Excel { */ getEntireRow(): Excel.Range; /** - * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. + * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] @@ -41658,7 +41660,7 @@ declare namespace Excel { */ getExtendedRange(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range; /** - * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. + * 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 Ctrl+Shift+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] @@ -41753,7 +41755,7 @@ declare namespace Excel { */ getPrecedents(): Excel.WorkbookRangeAreas; /** - * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. + * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13] @@ -41763,7 +41765,7 @@ declare namespace Excel { */ getRangeEdge(direction: Excel.KeyboardDirection, activeCell?: Range | string): Excel.Range; /** - * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. + * Returns a range object that is the edge cell of the data region that corresponds to the provided direction. This matches the Ctrl+Arrow key behavior in the Excel on Windows UI. * * @remarks * [Api set: ExcelApi 1.13]