Merge pull request #2339 from OfficeDev/main

[Admin] Publish

Author: alison-mk

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

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

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

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

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

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

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

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

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

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