From bc2f4ed01de1aa747ed11956115e37b15a65fa74 Mon Sep 17 00:00:00 2001 From: Alex Jerabek <38896772+AlexJerabek@users.noreply.github.com> Date: Fri, 12 Sep 2025 16:31:23 -0700 Subject: [PATCH] Refactor postprocessor for easier maintenance --- docs/docs-ref-autogen/common/toc.yml | 1 + docs/docs-ref-autogen/common_preview/toc.yml | 1 + .../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/excel/excel.referencedvalue.yml | 15 +- docs/docs-ref-autogen/excel/toc.yml | 1 + docs/docs-ref-autogen/excel_1_1/toc.yml | 1 + docs/docs-ref-autogen/excel_1_10/toc.yml | 1 + docs/docs-ref-autogen/excel_1_11/toc.yml | 1 + docs/docs-ref-autogen/excel_1_12/toc.yml | 1 + docs/docs-ref-autogen/excel_1_13/toc.yml | 1 + docs/docs-ref-autogen/excel_1_14/toc.yml | 1 + docs/docs-ref-autogen/excel_1_15/toc.yml | 1 + .../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/excel.referencedvalue.yml | 15 +- docs/docs-ref-autogen/excel_1_16/toc.yml | 1 + .../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/excel.referencedvalue.yml | 15 +- docs/docs-ref-autogen/excel_1_17/toc.yml | 1 + .../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/excel.referencedvalue.yml | 15 +- docs/docs-ref-autogen/excel_1_18/toc.yml | 1 + .../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/excel.referencedvalue.yml | 15 +- docs/docs-ref-autogen/excel_1_19/toc.yml | 1 + docs/docs-ref-autogen/excel_1_2/toc.yml | 1 + .../excel_1_20/excel/excel.cardlayout.yml | 10 +- .../excel/excel.cardlayoutsection.yml | 12 +- .../excel_1_20/excel/excel.cellcontrol.yml | 42 +- .../excel_1_20/excel/excel.cellvalue.yml | 23 +- .../excel.cellvalueandpropertymetadata.yml | 11 +- .../excel_1_20/excel/excel.compactlayout.yml | 10 +- .../excel/excel.entitypropertytype.yml | 11 +- .../excel_1_20/excel/excel.errorcellvalue.yml | 57 +- .../excel/excel.functioncellvalue.yml | 10 +- .../excel/excel.referencedvalue.yml | 15 +- docs/docs-ref-autogen/excel_1_20/toc.yml | 1 + docs/docs-ref-autogen/excel_1_3/toc.yml | 1 + docs/docs-ref-autogen/excel_1_4/toc.yml | 1 + docs/docs-ref-autogen/excel_1_5/toc.yml | 1 + docs/docs-ref-autogen/excel_1_6/toc.yml | 1 + docs/docs-ref-autogen/excel_1_7/toc.yml | 1 + docs/docs-ref-autogen/excel_1_8/toc.yml | 1 + docs/docs-ref-autogen/excel_1_9/toc.yml | 1 + .../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/excel.referencedvalue.yml | 15 +- docs/docs-ref-autogen/excel_online/toc.yml | 1 + docs/docs-ref-autogen/onenote/toc.yml | 1 + docs/docs-ref-autogen/outlook/toc.yml | 1 + docs/docs-ref-autogen/outlook_1_1/toc.yml | 1 + docs/docs-ref-autogen/outlook_1_10/toc.yml | 1 + docs/docs-ref-autogen/outlook_1_11/toc.yml | 1 + docs/docs-ref-autogen/outlook_1_12/toc.yml | 1 + docs/docs-ref-autogen/outlook_1_13/toc.yml | 1 + docs/docs-ref-autogen/outlook_1_14/toc.yml | 1 + docs/docs-ref-autogen/outlook_1_15/toc.yml | 1 + docs/docs-ref-autogen/outlook_1_2/toc.yml | 1 + docs/docs-ref-autogen/outlook_1_3/toc.yml | 1 + docs/docs-ref-autogen/outlook_1_4/toc.yml | 1 + docs/docs-ref-autogen/outlook_1_5/toc.yml | 1 + docs/docs-ref-autogen/outlook_1_6/toc.yml | 1 + docs/docs-ref-autogen/outlook_1_7/toc.yml | 1 + docs/docs-ref-autogen/outlook_1_8/toc.yml | 1 + docs/docs-ref-autogen/outlook_1_9/toc.yml | 1 + docs/docs-ref-autogen/powerpoint/toc.yml | 1 + docs/docs-ref-autogen/powerpoint_1_1/toc.yml | 1 + docs/docs-ref-autogen/powerpoint_1_2/toc.yml | 1 + docs/docs-ref-autogen/powerpoint_1_3/toc.yml | 1 + docs/docs-ref-autogen/powerpoint_1_4/toc.yml | 1 + docs/docs-ref-autogen/powerpoint_1_5/toc.yml | 1 + docs/docs-ref-autogen/powerpoint_1_6/toc.yml | 1 + docs/docs-ref-autogen/powerpoint_1_7/toc.yml | 1 + docs/docs-ref-autogen/powerpoint_1_8/toc.yml | 1 + docs/docs-ref-autogen/powerpoint_1_9/toc.yml | 1 + docs/docs-ref-autogen/word/toc.yml | 1 + docs/docs-ref-autogen/word_1_1/toc.yml | 1 + docs/docs-ref-autogen/word_1_2/toc.yml | 1 + docs/docs-ref-autogen/word_1_3/toc.yml | 1 + .../word_1_3_hidden_document/toc.yml | 1 + docs/docs-ref-autogen/word_1_4/toc.yml | 1 + .../word_1_4_hidden_document/toc.yml | 1 + docs/docs-ref-autogen/word_1_5/toc.yml | 1 + .../word_1_5_hidden_document/toc.yml | 1 + docs/docs-ref-autogen/word_1_6/toc.yml | 1 + docs/docs-ref-autogen/word_1_7/toc.yml | 1 + docs/docs-ref-autogen/word_1_8/toc.yml | 1 + docs/docs-ref-autogen/word_1_9/toc.yml | 1 + .../docs-ref-autogen/word_desktop_1_1/toc.yml | 1 + .../docs-ref-autogen/word_desktop_1_2/toc.yml | 1 + docs/docs-ref-autogen/word_online/toc.yml | 1 + generate-docs/scripts/postprocessor.ts | 507 +++++++++++------- 133 files changed, 1613 insertions(+), 250 deletions(-) diff --git a/docs/docs-ref-autogen/common/toc.yml b/docs/docs-ref-autogen/common/toc.yml index da30e3acd1..9df30971f4 100644 --- a/docs/docs-ref-autogen/common/toc.yml +++ b/docs/docs-ref-autogen/common/toc.yml @@ -211,6 +211,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/common_preview/toc.yml b/docs/docs-ref-autogen/common_preview/toc.yml index da30e3acd1..9df30971f4 100644 --- a/docs/docs-ref-autogen/common_preview/toc.yml +++ b/docs/docs-ref-autogen/common_preview/toc.yml @@ -211,6 +211,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class 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.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/toc.yml b/docs/docs-ref-autogen/excel/toc.yml index cf353de498..3c5fada373 100644 --- a/docs/docs-ref-autogen/excel/toc.yml +++ b/docs/docs-ref-autogen/excel/toc.yml @@ -1411,6 +1411,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/excel_1_1/toc.yml b/docs/docs-ref-autogen/excel_1_1/toc.yml index 476f1cb55d..d94b3019d4 100644 --- a/docs/docs-ref-autogen/excel_1_1/toc.yml +++ b/docs/docs-ref-autogen/excel_1_1/toc.yml @@ -353,6 +353,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/excel_1_10/toc.yml b/docs/docs-ref-autogen/excel_1_10/toc.yml index 41de40d21f..7110aefbaa 100644 --- a/docs/docs-ref-autogen/excel_1_10/toc.yml +++ b/docs/docs-ref-autogen/excel_1_10/toc.yml @@ -1037,6 +1037,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/excel_1_11/toc.yml b/docs/docs-ref-autogen/excel_1_11/toc.yml index 9caf6b8117..64ed2d5af7 100644 --- a/docs/docs-ref-autogen/excel_1_11/toc.yml +++ b/docs/docs-ref-autogen/excel_1_11/toc.yml @@ -1049,6 +1049,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/excel_1_12/toc.yml b/docs/docs-ref-autogen/excel_1_12/toc.yml index d4c6476a4c..058a0ebb7a 100644 --- a/docs/docs-ref-autogen/excel_1_12/toc.yml +++ b/docs/docs-ref-autogen/excel_1_12/toc.yml @@ -1095,6 +1095,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/excel_1_13/toc.yml b/docs/docs-ref-autogen/excel_1_13/toc.yml index 5721747c83..5fa8524a99 100644 --- a/docs/docs-ref-autogen/excel_1_13/toc.yml +++ b/docs/docs-ref-autogen/excel_1_13/toc.yml @@ -1105,6 +1105,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/excel_1_14/toc.yml b/docs/docs-ref-autogen/excel_1_14/toc.yml index 53a585fdd4..83a7c26357 100644 --- a/docs/docs-ref-autogen/excel_1_14/toc.yml +++ b/docs/docs-ref-autogen/excel_1_14/toc.yml @@ -1123,6 +1123,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/excel_1_15/toc.yml b/docs/docs-ref-autogen/excel_1_15/toc.yml index 18b023f13a..e6e48e2ce0 100644 --- a/docs/docs-ref-autogen/excel_1_15/toc.yml +++ b/docs/docs-ref-autogen/excel_1_15/toc.yml @@ -1127,6 +1127,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class 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.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/toc.yml b/docs/docs-ref-autogen/excel_1_16/toc.yml index 8d9be7691f..a1998e49f3 100644 --- a/docs/docs-ref-autogen/excel_1_16/toc.yml +++ b/docs/docs-ref-autogen/excel_1_16/toc.yml @@ -1255,6 +1255,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class 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.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/toc.yml b/docs/docs-ref-autogen/excel_1_17/toc.yml index f80ce32eae..3a38c9d450 100644 --- a/docs/docs-ref-autogen/excel_1_17/toc.yml +++ b/docs/docs-ref-autogen/excel_1_17/toc.yml @@ -1261,6 +1261,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class 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.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/toc.yml b/docs/docs-ref-autogen/excel_1_18/toc.yml index 08b4c10a7e..af8a8ff430 100644 --- a/docs/docs-ref-autogen/excel_1_18/toc.yml +++ b/docs/docs-ref-autogen/excel_1_18/toc.yml @@ -1279,6 +1279,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class 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.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/toc.yml b/docs/docs-ref-autogen/excel_1_19/toc.yml index 8a801877aa..6b7685fa50 100644 --- a/docs/docs-ref-autogen/excel_1_19/toc.yml +++ b/docs/docs-ref-autogen/excel_1_19/toc.yml @@ -1325,6 +1325,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/excel_1_2/toc.yml b/docs/docs-ref-autogen/excel_1_2/toc.yml index 9476f987ec..d455ccf315 100644 --- a/docs/docs-ref-autogen/excel_1_2/toc.yml +++ b/docs/docs-ref-autogen/excel_1_2/toc.yml @@ -450,6 +450,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.cardlayout.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cardlayout.yml index 4de2b1d604..07ebbc46e3 100644 --- a/docs/docs-ref-autogen/excel_1_20/excel/excel.cardlayout.yml +++ b/docs/docs-ref-autogen/excel_1_20/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_20/excel/excel.cardlayoutsection.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cardlayoutsection.yml index 5491f6727f..cca1b0c56e 100644 --- a/docs/docs-ref-autogen/excel_1_20/excel/excel.cardlayoutsection.yml +++ b/docs/docs-ref-autogen/excel_1_20/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_20/excel/excel.cellcontrol.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellcontrol.yml index ecd03dccf2..5e5954d3df 100644 --- a/docs/docs-ref-autogen/excel_1_20/excel/excel.cellcontrol.yml +++ b/docs/docs-ref-autogen/excel_1_20/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_20/excel/excel.cellvalue.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvalue.yml index ef4aaccfd2..4722937ebb 100644 --- a/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_20/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_20/excel/excel.cellvalueandpropertymetadata.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvalueandpropertymetadata.yml index 566432a914..5f661bb32f 100644 --- a/docs/docs-ref-autogen/excel_1_20/excel/excel.cellvalueandpropertymetadata.yml +++ b/docs/docs-ref-autogen/excel_1_20/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_20/excel/excel.compactlayout.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.compactlayout.yml index 3f25496779..5bb689c662 100644 --- a/docs/docs-ref-autogen/excel_1_20/excel/excel.compactlayout.yml +++ b/docs/docs-ref-autogen/excel_1_20/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_20/excel/excel.entitypropertytype.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.entitypropertytype.yml index 41a8cc7fcf..bc54a6eff6 100644 --- a/docs/docs-ref-autogen/excel_1_20/excel/excel.entitypropertytype.yml +++ b/docs/docs-ref-autogen/excel_1_20/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_20/excel/excel.errorcellvalue.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.errorcellvalue.yml index e5addcc22f..b88b1959c2 100644 --- a/docs/docs-ref-autogen/excel_1_20/excel/excel.errorcellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_20/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_20/excel/excel.functioncellvalue.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.functioncellvalue.yml index 50b7239609..b1f83d2ff4 100644 --- a/docs/docs-ref-autogen/excel_1_20/excel/excel.functioncellvalue.yml +++ b/docs/docs-ref-autogen/excel_1_20/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_20/excel/excel.referencedvalue.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.referencedvalue.yml index 57044e8ebe..168b4928ba 100644 --- a/docs/docs-ref-autogen/excel_1_20/excel/excel.referencedvalue.yml +++ b/docs/docs-ref-autogen/excel_1_20/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_20/toc.yml b/docs/docs-ref-autogen/excel_1_20/toc.yml index 8be6f87b7d..11e4b24507 100644 --- a/docs/docs-ref-autogen/excel_1_20/toc.yml +++ b/docs/docs-ref-autogen/excel_1_20/toc.yml @@ -1329,6 +1329,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/excel_1_3/toc.yml b/docs/docs-ref-autogen/excel_1_3/toc.yml index eb4b39e82a..2308f16910 100644 --- a/docs/docs-ref-autogen/excel_1_3/toc.yml +++ b/docs/docs-ref-autogen/excel_1_3/toc.yml @@ -458,6 +458,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/excel_1_4/toc.yml b/docs/docs-ref-autogen/excel_1_4/toc.yml index 5ada83f0e9..15ae12a105 100644 --- a/docs/docs-ref-autogen/excel_1_4/toc.yml +++ b/docs/docs-ref-autogen/excel_1_4/toc.yml @@ -466,6 +466,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/excel_1_5/toc.yml b/docs/docs-ref-autogen/excel_1_5/toc.yml index 3ceeeb07df..79e2f16bfb 100644 --- a/docs/docs-ref-autogen/excel_1_5/toc.yml +++ b/docs/docs-ref-autogen/excel_1_5/toc.yml @@ -474,6 +474,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/excel_1_6/toc.yml b/docs/docs-ref-autogen/excel_1_6/toc.yml index 5fe6872d80..4bd960e797 100644 --- a/docs/docs-ref-autogen/excel_1_6/toc.yml +++ b/docs/docs-ref-autogen/excel_1_6/toc.yml @@ -556,6 +556,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/excel_1_7/toc.yml b/docs/docs-ref-autogen/excel_1_7/toc.yml index fc2c8f2af2..3391f570ce 100644 --- a/docs/docs-ref-autogen/excel_1_7/toc.yml +++ b/docs/docs-ref-autogen/excel_1_7/toc.yml @@ -658,6 +658,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/excel_1_8/toc.yml b/docs/docs-ref-autogen/excel_1_8/toc.yml index 594737bd14..93e4e5a755 100644 --- a/docs/docs-ref-autogen/excel_1_8/toc.yml +++ b/docs/docs-ref-autogen/excel_1_8/toc.yml @@ -752,6 +752,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/excel_1_9/toc.yml b/docs/docs-ref-autogen/excel_1_9/toc.yml index cebcd1a129..ebdcf63076 100644 --- a/docs/docs-ref-autogen/excel_1_9/toc.yml +++ b/docs/docs-ref-autogen/excel_1_9/toc.yml @@ -993,6 +993,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class 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.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/toc.yml b/docs/docs-ref-autogen/excel_online/toc.yml index b3111a0fe4..0feb8ffdc8 100644 --- a/docs/docs-ref-autogen/excel_online/toc.yml +++ b/docs/docs-ref-autogen/excel_online/toc.yml @@ -1345,6 +1345,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/onenote/toc.yml b/docs/docs-ref-autogen/onenote/toc.yml index 48f13dbcf5..2009f68054 100644 --- a/docs/docs-ref-autogen/onenote/toc.yml +++ b/docs/docs-ref-autogen/onenote/toc.yml @@ -315,6 +315,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/outlook/toc.yml b/docs/docs-ref-autogen/outlook/toc.yml index e9365e97b3..e1e6f54ab6 100644 --- a/docs/docs-ref-autogen/outlook/toc.yml +++ b/docs/docs-ref-autogen/outlook/toc.yml @@ -431,6 +431,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/outlook_1_1/toc.yml b/docs/docs-ref-autogen/outlook_1_1/toc.yml index 0904ede9d2..994bc902c9 100644 --- a/docs/docs-ref-autogen/outlook_1_1/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_1/toc.yml @@ -287,6 +287,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/outlook_1_10/toc.yml b/docs/docs-ref-autogen/outlook_1_10/toc.yml index 3f9cfdab1e..59155ae64a 100644 --- a/docs/docs-ref-autogen/outlook_1_10/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_10/toc.yml @@ -387,6 +387,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/outlook_1_11/toc.yml b/docs/docs-ref-autogen/outlook_1_11/toc.yml index 3a9668dc0f..05f10817df 100644 --- a/docs/docs-ref-autogen/outlook_1_11/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_11/toc.yml @@ -389,6 +389,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/outlook_1_12/toc.yml b/docs/docs-ref-autogen/outlook_1_12/toc.yml index df5ca0beff..755a56970a 100644 --- a/docs/docs-ref-autogen/outlook_1_12/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_12/toc.yml @@ -391,6 +391,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/outlook_1_13/toc.yml b/docs/docs-ref-autogen/outlook_1_13/toc.yml index 8912df693e..f1e7a35690 100644 --- a/docs/docs-ref-autogen/outlook_1_13/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_13/toc.yml @@ -403,6 +403,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/outlook_1_14/toc.yml b/docs/docs-ref-autogen/outlook_1_14/toc.yml index b2e315c8f7..586c5099d4 100644 --- a/docs/docs-ref-autogen/outlook_1_14/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_14/toc.yml @@ -417,6 +417,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/outlook_1_15/toc.yml b/docs/docs-ref-autogen/outlook_1_15/toc.yml index 8bb0fbc135..59eca5c53c 100644 --- a/docs/docs-ref-autogen/outlook_1_15/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_15/toc.yml @@ -423,6 +423,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/outlook_1_2/toc.yml b/docs/docs-ref-autogen/outlook_1_2/toc.yml index 3c567cd78f..7ab668f1ea 100644 --- a/docs/docs-ref-autogen/outlook_1_2/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_2/toc.yml @@ -289,6 +289,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/outlook_1_3/toc.yml b/docs/docs-ref-autogen/outlook_1_3/toc.yml index 666d04bc01..9a143d5a52 100644 --- a/docs/docs-ref-autogen/outlook_1_3/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_3/toc.yml @@ -297,6 +297,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/outlook_1_4/toc.yml b/docs/docs-ref-autogen/outlook_1_4/toc.yml index 666d04bc01..9a143d5a52 100644 --- a/docs/docs-ref-autogen/outlook_1_4/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_4/toc.yml @@ -297,6 +297,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/outlook_1_5/toc.yml b/docs/docs-ref-autogen/outlook_1_5/toc.yml index 1fdd91f572..e19a818fff 100644 --- a/docs/docs-ref-autogen/outlook_1_5/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_5/toc.yml @@ -307,6 +307,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/outlook_1_6/toc.yml b/docs/docs-ref-autogen/outlook_1_6/toc.yml index 1fdd91f572..e19a818fff 100644 --- a/docs/docs-ref-autogen/outlook_1_6/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_6/toc.yml @@ -307,6 +307,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/outlook_1_7/toc.yml b/docs/docs-ref-autogen/outlook_1_7/toc.yml index e0ae3ca8f0..df12289d7e 100644 --- a/docs/docs-ref-autogen/outlook_1_7/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_7/toc.yml @@ -337,6 +337,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/outlook_1_8/toc.yml b/docs/docs-ref-autogen/outlook_1_8/toc.yml index 0e0a444aef..6ec450ae30 100644 --- a/docs/docs-ref-autogen/outlook_1_8/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_8/toc.yml @@ -371,6 +371,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/outlook_1_9/toc.yml b/docs/docs-ref-autogen/outlook_1_9/toc.yml index 0e0a444aef..6ec450ae30 100644 --- a/docs/docs-ref-autogen/outlook_1_9/toc.yml +++ b/docs/docs-ref-autogen/outlook_1_9/toc.yml @@ -371,6 +371,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/powerpoint/toc.yml b/docs/docs-ref-autogen/powerpoint/toc.yml index 7f2539607b..7aa49067b1 100644 --- a/docs/docs-ref-autogen/powerpoint/toc.yml +++ b/docs/docs-ref-autogen/powerpoint/toc.yml @@ -418,6 +418,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/powerpoint_1_1/toc.yml b/docs/docs-ref-autogen/powerpoint_1_1/toc.yml index dc5ed106cd..d6c714dbff 100644 --- a/docs/docs-ref-autogen/powerpoint_1_1/toc.yml +++ b/docs/docs-ref-autogen/powerpoint_1_1/toc.yml @@ -223,6 +223,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/powerpoint_1_2/toc.yml b/docs/docs-ref-autogen/powerpoint_1_2/toc.yml index 69c04f952d..adc6eebd68 100644 --- a/docs/docs-ref-autogen/powerpoint_1_2/toc.yml +++ b/docs/docs-ref-autogen/powerpoint_1_2/toc.yml @@ -231,6 +231,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/powerpoint_1_3/toc.yml b/docs/docs-ref-autogen/powerpoint_1_3/toc.yml index 26123de495..b5d4d05375 100644 --- a/docs/docs-ref-autogen/powerpoint_1_3/toc.yml +++ b/docs/docs-ref-autogen/powerpoint_1_3/toc.yml @@ -249,6 +249,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/powerpoint_1_4/toc.yml b/docs/docs-ref-autogen/powerpoint_1_4/toc.yml index 8e86e35c7e..cc739932f9 100644 --- a/docs/docs-ref-autogen/powerpoint_1_4/toc.yml +++ b/docs/docs-ref-autogen/powerpoint_1_4/toc.yml @@ -285,6 +285,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/powerpoint_1_5/toc.yml b/docs/docs-ref-autogen/powerpoint_1_5/toc.yml index 96926c24eb..be4636853f 100644 --- a/docs/docs-ref-autogen/powerpoint_1_5/toc.yml +++ b/docs/docs-ref-autogen/powerpoint_1_5/toc.yml @@ -289,6 +289,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/powerpoint_1_6/toc.yml b/docs/docs-ref-autogen/powerpoint_1_6/toc.yml index e0b586e322..8e77b0bb16 100644 --- a/docs/docs-ref-autogen/powerpoint_1_6/toc.yml +++ b/docs/docs-ref-autogen/powerpoint_1_6/toc.yml @@ -293,6 +293,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/powerpoint_1_7/toc.yml b/docs/docs-ref-autogen/powerpoint_1_7/toc.yml index a3af5bf0b2..e1e5c05251 100644 --- a/docs/docs-ref-autogen/powerpoint_1_7/toc.yml +++ b/docs/docs-ref-autogen/powerpoint_1_7/toc.yml @@ -307,6 +307,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/powerpoint_1_8/toc.yml b/docs/docs-ref-autogen/powerpoint_1_8/toc.yml index 826b42d7f7..0352a238ee 100644 --- a/docs/docs-ref-autogen/powerpoint_1_8/toc.yml +++ b/docs/docs-ref-autogen/powerpoint_1_8/toc.yml @@ -353,6 +353,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/powerpoint_1_9/toc.yml b/docs/docs-ref-autogen/powerpoint_1_9/toc.yml index a857bcc624..305d4919ed 100644 --- a/docs/docs-ref-autogen/powerpoint_1_9/toc.yml +++ b/docs/docs-ref-autogen/powerpoint_1_9/toc.yml @@ -371,6 +371,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/word/toc.yml b/docs/docs-ref-autogen/word/toc.yml index 5563e4799d..20b39e5cb3 100644 --- a/docs/docs-ref-autogen/word/toc.yml +++ b/docs/docs-ref-autogen/word/toc.yml @@ -919,6 +919,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/word_1_1/toc.yml b/docs/docs-ref-autogen/word_1_1/toc.yml index e2759820bb..8f414f9859 100644 --- a/docs/docs-ref-autogen/word_1_1/toc.yml +++ b/docs/docs-ref-autogen/word_1_1/toc.yml @@ -265,6 +265,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/word_1_2/toc.yml b/docs/docs-ref-autogen/word_1_2/toc.yml index e2759820bb..8f414f9859 100644 --- a/docs/docs-ref-autogen/word_1_2/toc.yml +++ b/docs/docs-ref-autogen/word_1_2/toc.yml @@ -265,6 +265,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/word_1_3/toc.yml b/docs/docs-ref-autogen/word_1_3/toc.yml index cc69b6707f..c34382d40b 100644 --- a/docs/docs-ref-autogen/word_1_3/toc.yml +++ b/docs/docs-ref-autogen/word_1_3/toc.yml @@ -321,6 +321,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/word_1_3_hidden_document/toc.yml b/docs/docs-ref-autogen/word_1_3_hidden_document/toc.yml index cc69b6707f..c34382d40b 100644 --- a/docs/docs-ref-autogen/word_1_3_hidden_document/toc.yml +++ b/docs/docs-ref-autogen/word_1_3_hidden_document/toc.yml @@ -321,6 +321,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/word_1_4/toc.yml b/docs/docs-ref-autogen/word_1_4/toc.yml index 1343219953..019baa7404 100644 --- a/docs/docs-ref-autogen/word_1_4/toc.yml +++ b/docs/docs-ref-autogen/word_1_4/toc.yml @@ -349,6 +349,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/word_1_4_hidden_document/toc.yml b/docs/docs-ref-autogen/word_1_4_hidden_document/toc.yml index 1343219953..019baa7404 100644 --- a/docs/docs-ref-autogen/word_1_4_hidden_document/toc.yml +++ b/docs/docs-ref-autogen/word_1_4_hidden_document/toc.yml @@ -349,6 +349,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/word_1_5/toc.yml b/docs/docs-ref-autogen/word_1_5/toc.yml index b85676d900..2def187291 100644 --- a/docs/docs-ref-autogen/word_1_5/toc.yml +++ b/docs/docs-ref-autogen/word_1_5/toc.yml @@ -391,6 +391,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/word_1_5_hidden_document/toc.yml b/docs/docs-ref-autogen/word_1_5_hidden_document/toc.yml index b85676d900..2def187291 100644 --- a/docs/docs-ref-autogen/word_1_5_hidden_document/toc.yml +++ b/docs/docs-ref-autogen/word_1_5_hidden_document/toc.yml @@ -391,6 +391,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/word_1_6/toc.yml b/docs/docs-ref-autogen/word_1_6/toc.yml index d828a29749..fab1e242a4 100644 --- a/docs/docs-ref-autogen/word_1_6/toc.yml +++ b/docs/docs-ref-autogen/word_1_6/toc.yml @@ -407,6 +407,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/word_1_7/toc.yml b/docs/docs-ref-autogen/word_1_7/toc.yml index b1f04274b8..62d2fa167c 100644 --- a/docs/docs-ref-autogen/word_1_7/toc.yml +++ b/docs/docs-ref-autogen/word_1_7/toc.yml @@ -433,6 +433,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/word_1_8/toc.yml b/docs/docs-ref-autogen/word_1_8/toc.yml index 1e75b6eb26..3db03dce02 100644 --- a/docs/docs-ref-autogen/word_1_8/toc.yml +++ b/docs/docs-ref-autogen/word_1_8/toc.yml @@ -437,6 +437,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/word_1_9/toc.yml b/docs/docs-ref-autogen/word_1_9/toc.yml index 15e8ed8aa0..4df7bbb41b 100644 --- a/docs/docs-ref-autogen/word_1_9/toc.yml +++ b/docs/docs-ref-autogen/word_1_9/toc.yml @@ -445,6 +445,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/word_desktop_1_1/toc.yml b/docs/docs-ref-autogen/word_desktop_1_1/toc.yml index 1132c1b1cb..968492b2fe 100644 --- a/docs/docs-ref-autogen/word_desktop_1_1/toc.yml +++ b/docs/docs-ref-autogen/word_desktop_1_1/toc.yml @@ -463,6 +463,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/word_desktop_1_2/toc.yml b/docs/docs-ref-autogen/word_desktop_1_2/toc.yml index 5ef460fbb0..280e88a343 100644 --- a/docs/docs-ref-autogen/word_desktop_1_2/toc.yml +++ b/docs/docs-ref-autogen/word_desktop_1_2/toc.yml @@ -517,6 +517,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/docs/docs-ref-autogen/word_online/toc.yml b/docs/docs-ref-autogen/word_online/toc.yml index 15e8ed8aa0..4df7bbb41b 100644 --- a/docs/docs-ref-autogen/word_online/toc.yml +++ b/docs/docs-ref-autogen/word_online/toc.yml @@ -445,6 +445,7 @@ items: - name: VisibilityModeChangedMessage uid: office!Office.VisibilityModeChangedMessage:interface - name: OfficeExtension + uid: '' items: - name: ClientObject uid: office!OfficeExtension.ClientObject:class diff --git a/generate-docs/scripts/postprocessor.ts b/generate-docs/scripts/postprocessor.ts index fe70f6bc93..a6d5fef57b 100644 --- a/generate-docs/scripts/postprocessor.ts +++ b/generate-docs/scripts/postprocessor.ts @@ -5,9 +5,58 @@ import * as fsx from 'fs-extra'; import * as jsyaml from "js-yaml"; import * as path from "path"; - +// Configuration constants const OLDEST_EXCEL_RELEASE_WITH_CUSTOM_FUNCTIONS = 9; +const HOST_VERSION_MAP = [ + { host: "excel", versions: 21 }, // not including online + { host: "onenote", versions: 1 }, + { host: "outlook", versions: 16 }, + { host: "powerpoint", versions: 10 }, + { host: "visio", versions: 1 }, + { host: "word", versions: 10 } // not including online or desktop +]; + +const EXCEL_ICON_SET_FILTER = [ + "FiveArrowsGraySet", "FiveArrowsSet", "FiveBoxesSet", "FiveQuartersSet", "FiveRatingSet", + "FourArrowsGraySet", "FourArrowsSet", "FourRatingSet", "FourRedToBlackSet", "FourTrafficLightsSet", + "IconCollections", "ThreeArrowsGraySet", "ThreeArrowsSet", "ThreeFlagsSet", "ThreeSignsSet", + "ThreeStarsSet", "ThreeSymbols2Set", "ThreeSymbolsSet", "ThreeTrafficLights1Set", + "ThreeTrafficLights2Set", "ThreeTrianglesSet" +]; + +const OUTLOOK_FILTER_ITEMS = ['Appointment', 'AppointmentForm', 'ItemCompose', 'ItemRead', 'Message']; + +const NAMESPACE_REPLACEMENTS = { + outlook: [ + { from: /CommonAPI/g, to: "Office" } + ], + office: [ + { from: /Outlook\.Mailbox/g, to: "Office.Mailbox" }, + { from: /Outlook\.RoamingSettings/g, to: "Office.RoamingSettings" }, + { from: /Outlook\.SensitivityLabelsCatalog/g, to: "Office.SensitivityLabelsCatalog" } + ], + customFunctions: [ + { from: /\/office\/dev\/add-ins\/reference\/javascript-api-for-office/g, to: "/javascript/api/requirement-sets/excel/custom-functions-requirement-sets" }, + { from: /\/office\/dev\/add-ins\/reference\/overview\/visio-javascript-reference-overview/g, to: "/javascript/api/requirement-sets/excel/custom-functions-requirement-sets" } + ] +}; + +const SPECIAL_WORD_VERSIONS = [ + { folder: "word_desktop_1_2", version: 9.5 }, + { folder: "word_desktop_1_1", version: 8.5 }, + { folder: "word_1_5_hidden_document", version: 5.5 }, + { folder: "word_1_4_hidden_document", version: 4.5 }, + { folder: "word_1_3_hidden_document", version: 3.5 } +]; + +// File cleanup patterns +const YML_CLEANUP_PATTERNS = [ + { pattern: /^\s*example: \[\]\s*$/gm, replacement: "" }, + { pattern: /description: \\\*[\r\n]/gm, replacement: "description: ''" }, + { pattern: /\\\*/gm, replacement: "*" } +]; + interface Toc { items: [{ name: string, @@ -124,138 +173,237 @@ const docsSource = path.resolve("../yaml"); const docsDestination = path.resolve("../../docs/docs-ref-autogen"); const tocTemplateLocation = path.resolve("../../docs"); -tryCatch(async () => { - console.log(`\nStarting postprocessor script...`); +// Utility functions +function processFilesInDirectory( + directory: string, + filter: (filename: string) => boolean, + processor: (filePath: string, content: string) => string +): void { + if (!fsx.existsSync(directory)) return; + + fsx.readdirSync(directory) + .filter(filter) + .forEach(filename => { + const filePath = path.join(directory, filename); + const content = fsx.readFileSync(filePath, "utf8"); + const processedContent = processor(filePath, content); + fsx.writeFileSync(filePath, processedContent); + }); +} +function applyNamespaceReplacements(content: string, replacements: Array<{ from: RegExp; to: string }>): string { + return replacements.reduce((acc, { from, to }) => acc.replace(from, to), content); +} + +function getHostNameFromFilename(filename: string): string { + return filename.substring(0, filename.indexOf("_") < 0 ? filename.length : filename.indexOf("_")); +} + +function capitalizeHostName(name: string): string { + if (name === 'onenote') return 'OneNote'; + if (name === 'powerpoint') return 'PowerPoint'; + return name.charAt(0).toUpperCase() + name.slice(1).replace(/\-/g, ' '); +} + +function createTocNode(name: string, uid?: string, items?: any[]): any { + return { name, uid: uid || "", items: items || [] }; +} + +// Main processing functions +function cleanupOldDocs(): void { console.log(`Deleting old docs at: ${docsDestination}`); - // delete everything except the 'overview' folder from the /docs folder fsx.readdirSync(docsDestination) .filter(filename => filename !== "overview" && filename !== "images") - .forEach(filename => fsx.removeSync(docsDestination + '/' + filename)); + .forEach(filename => fsx.removeSync(path.join(docsDestination, filename))); +} +function loadAndPrepareGlobalToc(): Toc { console.log(`Loading global TOC template`); - let globalTocString = fsx.readFileSync(`${tocTemplateLocation}/toc.yml`).toString(); - + let globalTocString = fsx.readFileSync(path.join(tocTemplateLocation, "toc.yml")).toString(); globalTocString = globalTocString.replace(/href:\s*(.*)\.md/g, "href: ../../$1.md"); - let globalToc = jsyaml.load(globalTocString) as Toc; + return jsyaml.load(globalTocString) as Toc; +} + +function copyDocsOutput(): void { console.log(`Copying docs output files to: ${docsDestination}`); - // copy docs output to /docs/docs-ref-autogen folder - fsx.readdirSync(docsSource) - .forEach(filename => { + fsx.readdirSync(docsSource).forEach(filename => { fsx.copySync( - docsSource + '/' + filename, - docsDestination + '/' + filename + path.join(docsSource, filename), + path.join(docsDestination, filename) ); }); +} + +function processHostVersions(globalToc: Toc, tocWithPreviewCommon: Toc, tocWithReleaseCommon: Toc): void { + HOST_VERSION_MAP.forEach(category => { + const baseToc = category.host === "visio" ? globalToc : tocWithPreviewCommon; + const versionToc = category.host === "visio" ? globalToc : tocWithReleaseCommon; - // fix all the individual TOC files - (globalToc.items[0].items[0] as ApplicationTocNode).href = "../overview/overview.md"; // Stay within a moniker - const tocWithPreviewCommon = scrubAndWriteToc(docsDestination + "/office", globalToc); - const tocWithReleaseCommon = scrubAndWriteToc(docsDestination + "/office_release", globalToc); - const hostVersionMap = [{host: "excel", versions: 21}, /*not including online*/ - {host: "onenote", versions: 1}, - {host: "outlook", versions: 16}, - {host: "powerpoint", versions: 10}, - {host: "visio", versions: 1}, - {host: "word", versions: 10}]; /* not including online or desktop*/ - - hostVersionMap.forEach(category => { if (category.versions > 1) { - scrubAndWriteToc(path.resolve(`${docsDestination}/${category.host}`), category.host === "visio" ? globalToc : tocWithPreviewCommon, category.host, category.versions); + scrubAndWriteToc(path.join(docsDestination, category.host), baseToc, category.host, category.versions); for (let i = 1; i < category.versions; i++) { - scrubAndWriteToc(path.resolve(`${docsDestination}/${category.host}_1_${i}`), category.host === "visio" ? globalToc : tocWithReleaseCommon, category.host, i); + scrubAndWriteToc(path.join(docsDestination, `${category.host}_1_${i}`), versionToc, category.host, i); } } else { - // This assumes the single version of the application's docs is not a preview version. - scrubAndWriteToc(path.resolve(`${docsDestination}/${category.host}`), category.host === "visio" ? globalToc : tocWithReleaseCommon, category.host, category.versions); + scrubAndWriteToc(path.join(docsDestination, category.host), versionToc, category.host, category.versions); } }); +} - // Special case for ExcelApi Online - scrubAndWriteToc(path.resolve(`${docsDestination}/excel_online`), tocWithReleaseCommon, "excel", 99); - - // Special case for WordApi Online - scrubAndWriteToc(path.resolve(`${docsDestination}/word_online`), tocWithReleaseCommon, "word", 99); +function processSpecialCases(tocWithReleaseCommon: Toc): void { + // Special cases for Excel and Word Online + scrubAndWriteToc(path.join(docsDestination, "excel_online"), tocWithReleaseCommon, "excel", 99); + scrubAndWriteToc(path.join(docsDestination, "word_online"), tocWithReleaseCommon, "word", 99); - // Special case for WordApi Desktop - scrubAndWriteToc(path.resolve(`${docsDestination}/word_desktop_1_2`), tocWithReleaseCommon, "word", 9.5); - scrubAndWriteToc(path.resolve(`${docsDestination}/word_desktop_1_1`), tocWithReleaseCommon, "word", 8.5); - scrubAndWriteToc(path.resolve(`${docsDestination}/word_1_5_hidden_document`), tocWithReleaseCommon, "word", 5.5); - scrubAndWriteToc(path.resolve(`${docsDestination}/word_1_4_hidden_document`), tocWithReleaseCommon, "word", 4.5); - scrubAndWriteToc(path.resolve(`${docsDestination}/word_1_3_hidden_document`), tocWithReleaseCommon, "word", 3.5); + // Special cases for Word Desktop versions + SPECIAL_WORD_VERSIONS.forEach(({ folder, version }) => { + scrubAndWriteToc(path.join(docsDestination, folder), tocWithReleaseCommon, "word", version); + }); +} +function processNamespaceReplacements(): void { console.log(`Namespace pass on Outlook docs`); - // replace Outlook/CommonAPI namespace references with Office fsx.readdirSync(docsDestination) - .filter(filename => filename.indexOf("outlook") >= 0 && filename.indexOf(".yml") < 0) + .filter(filename => filename.includes("outlook") && !filename.includes(".yml")) .forEach(filename => { - let subfolder = docsDestination + '/' + filename + "/outlook"; - fsx.readdirSync(subfolder) - .forEach(subfilename => { - fsx.writeFileSync(subfolder + '/' + subfilename, fsx.readFileSync(subfolder + '/' + subfilename).toString().replace(/CommonAPI/g, "Office")); - }); + const subfolder = path.join(docsDestination, filename, "outlook"); + if (fsx.existsSync(subfolder)) { + processFilesInDirectory( + subfolder, + () => true, + (_, content) => applyNamespaceReplacements(content, NAMESPACE_REPLACEMENTS.outlook) + ); + } }); + console.log(`Namespace pass on Office docs`); - const officeFolders: string[] = [docsDestination + "/office/office", docsDestination + "/office_release/office"]; - officeFolders.forEach((officeFolder) => { - console.log(officeFolder); - fsx.readdirSync(officeFolder) - .forEach(filename => { - fsx.writeFileSync(officeFolder + '/' + filename, fsx.readFileSync(officeFolder + '/' + filename).toString().replace(/Outlook\.Mailbox/g, "Office.Mailbox").replace(/Outlook\.RoamingSettings/g, "Office.RoamingSettings").replace(/Outlook\.SensitivityLabelsCatalog/g, "Office.SensitivityLabelsCatalog")); - }); + const officeFolders = [ + path.join(docsDestination, "office", "office"), + path.join(docsDestination, "office_release", "office") + ]; + + officeFolders.forEach(officeFolder => { + console.log(officeFolder); + if (fsx.existsSync(officeFolder)) { + processFilesInDirectory( + officeFolder, + () => true, + (_, content) => applyNamespaceReplacements(content, NAMESPACE_REPLACEMENTS.office) + ); + } }); +} +function processCustomFunctionsLinks(): void { console.log(`Custom Functions API requirement set link pass`); fsx.readdirSync(docsDestination) - .filter(filename => filename.indexOf("excel") >= 0 && filename.indexOf(".yml") < 0) + .filter(filename => filename.includes("excel") && !filename.includes(".yml")) .forEach(filename => { - let subfolder = docsDestination + '/' + filename + "/custom-functions-runtime"; + const subfolder = path.join(docsDestination, filename, "custom-functions-runtime"); if (fsx.existsSync(subfolder)) { - fsx.readdirSync(subfolder) - .forEach(subfilename => { - fsx.writeFileSync(subfolder + '/' + subfilename, - fsx.readFileSync(subfolder + '/' + subfilename).toString() - .replace(/\/office\/dev\/add-ins\/reference\/javascript-api-for-office/g, "/javascript/api/requirement-sets/excel/custom-functions-requirement-sets") - .replace(/\/office\/dev\/add-ins\/reference\/overview\/visio-javascript-reference-overview/g, "/javascript/api/requirement-sets/excel/custom-functions-requirement-sets")); - }); + processFilesInDirectory( + subfolder, + () => true, + (_, content) => applyNamespaceReplacements(content, NAMESPACE_REPLACEMENTS.customFunctions) + ); } }); +} +function processYamlFiles(): void { console.log(`Adjust YAML files - HREF and type alias expansion.`); fsx.readdirSync(docsDestination) - .filter(filename => filename.indexOf(".yml") < 0) + .filter(filename => !filename.includes(".yml")) .forEach(filename => { - let subfolder = docsDestination + '/' + filename; - fsx.readdirSync(subfolder).forEach(subfilename => { - let hostName = filename.substring(0, filename.indexOf("_") < 0 ? filename.length : filename.indexOf("_")); - if (subfilename.indexOf("toc") >= 0) { - // Update overview HREF. - fsx.writeFileSync(subfolder + '/' + subfilename, fsx.readFileSync(subfolder + '/' + subfilename).toString().replace("~/docs-ref-autogen/overview/office.md", "overview.md")); - } else if (subfilename.indexOf(".") < 0) { - let packageFolder = subfolder + '/' + subfilename; - fsx.readdirSync(packageFolder).filter(packageFileName => packageFileName.indexOf(".yml") > 0).forEach(packageFileName => { - const ymlFile = fsx.readFileSync(packageFolder + '/' + packageFileName, "utf8"); - fsx.writeFileSync(packageFolder + '/' + packageFileName, cleanUpYmlFile(ymlFile, hostName)); - }); - } else if (subfilename.indexOf(".yml") > 0) { - const ymlFile = fsx.readFileSync(subfolder + '/' + subfilename, "utf8"); - fsx.writeFileSync(subfolder + '/' + subfilename, cleanUpYmlFile(ymlFile, hostName)); - } - }); + const subfolder = path.join(docsDestination, filename); + const hostName = getHostNameFromFilename(filename); + + if (fsx.existsSync(subfolder)) { + fsx.readdirSync(subfolder).forEach(subfilename => { + const subfilePath = path.join(subfolder, subfilename); + + if (subfilename.includes("toc")) { + // Update overview HREF + const tocContent = fsx.readFileSync(subfilePath).toString() + .replace("~/docs-ref-autogen/overview/office.md", "overview.md"); + fsx.writeFileSync(subfilePath, tocContent); + } else if (!subfilename.includes(".") && fsx.lstatSync(subfilePath).isDirectory()) { + // Package folder + processFilesInDirectory( + subfilePath, + fileName => fileName.includes(".yml"), + (_, ymlContent) => cleanUpYmlFile(ymlContent, hostName) + ); + } else if (subfilename.includes(".yml")) { + const ymlContent = fsx.readFileSync(subfilePath, "utf8"); + fsx.writeFileSync(subfilePath, cleanUpYmlFile(ymlContent, hostName)); + } + }); + } }); +} +function moveCommonTocs(): void { console.log(`Moving common TOC to its own folder`); - fsx.copySync(docsDestination + "/office/toc.yml", docsDestination + "/common_preview/toc.yml"); - fsx.copySync(docsDestination + "/office_release/toc.yml", docsDestination + "/common/toc.yml"); + fsx.copySync( + path.join(docsDestination, "office", "toc.yml"), + path.join(docsDestination, "common_preview", "toc.yml") + ); + fsx.copySync( + path.join(docsDestination, "office_release", "toc.yml"), + path.join(docsDestination, "common", "toc.yml") + ); +} - // remove to prevent build errors - fsx.removeSync(docsDestination + "/office/overview.md"); - fsx.removeSync(docsDestination + "/office/toc.yml"); - fsx.removeSync(docsDestination + "/office_release/toc.yml"); - fsx.removeSync(docsDestination + "/office-runtime/toc.yml"); +function cleanupTemporaryFiles(): void { + // Remove files to prevent build errors + const filesToRemove = [ + path.join(docsDestination, "office", "overview.md"), + path.join(docsDestination, "office", "toc.yml"), + path.join(docsDestination, "office_release", "toc.yml"), + path.join(docsDestination, "office-runtime", "toc.yml") + ]; + + filesToRemove.forEach(file => fsx.removeSync(file)); +} - console.log(`\nPostprocessor script complete\n`); +tryCatch(async () => { + console.log(`\nStarting postprocessor script...`); + + // Step 1: Clean up old documentation + cleanupOldDocs(); + + // Step 2: Load and prepare global TOC + const globalToc = loadAndPrepareGlobalToc(); + // Step 3: Copy documentation output + copyDocsOutput(); + + // Step 4: Fix all the individual TOC files + (globalToc.items[0].items[0] as ApplicationTocNode).href = "../overview/overview.md"; // Stay within a moniker + const tocWithPreviewCommon = scrubAndWriteToc(path.join(docsDestination, "office"), globalToc); + const tocWithReleaseCommon = scrubAndWriteToc(path.join(docsDestination, "office_release"), globalToc); + + // Step 5: Process host versions + processHostVersions(globalToc, tocWithPreviewCommon, tocWithReleaseCommon); + + // Step 6: Process special cases + processSpecialCases(tocWithReleaseCommon); + + // Step 7: Process namespace replacements + processNamespaceReplacements(); + + // Step 8: Process custom functions links + processCustomFunctionsLinks(); + + // Step 9: Process YAML files + processYamlFiles(); + + // Step 10: Move common TOCs and cleanup + moveCommonTocs(); + cleanupTemporaryFiles(); + + console.log(`\nPostprocessor script complete\n`); process.exit(0); }); @@ -269,7 +417,7 @@ async function tryCatch(call: () => Promise) { } function scrubAndWriteToc(versionFolder: string, globalToc: Toc, hostName?: string, versionNumber?: number): Toc { - const tocPath = versionFolder + "/toc.yml"; + const tocPath = path.join(versionFolder, "toc.yml"); let latestToc; if (!hostName) { latestToc = fixCommonToc(tocPath, globalToc); @@ -284,66 +432,55 @@ function scrubAndWriteToc(versionFolder: string, globalToc: Toc, hostName?: stri function fixToc(tocPath: string, globalToc: Toc, hostName: string, versionNumber: number): Toc { console.log(`Updating the structure of the TOC file: ${tocPath}`); - let origToc = (jsyaml.load(fsx.readFileSync(tocPath).toString()) as Toc); + const origToc = jsyaml.load(fsx.readFileSync(tocPath).toString()) as Toc; let newTocNode = {}; let membersToMove = {}; let generalFilter: string[] = ["Interfaces"]; - // create custom folders - let excelIconSetFilter : string [] = ["FiveArrowsGraySet", "FiveArrowsSet", "FiveBoxesSet", "FiveQuartersSet", "FiveRatingSet", "FourArrowsGraySet", "FourArrowsSet", "FourRatingSet", "FourRedToBlackSet", "FourTrafficLightsSet", "IconCollections", "ThreeArrowsGraySet", "ThreeArrowsSet", "ThreeFlagsSet", "ThreeSignsSet", "ThreeStarsSet", "ThreeSymbols2Set", "ThreeSymbolsSet", "ThreeTrafficLights1Set", "ThreeTrafficLights2Set", "ThreeTrianglesSet"]; - let customFunctionsRoot = {"name": "Custom Functions", "uid": "", "items": [] as any}; + // Create custom folders and filters + const customFunctionsRoot = createTocNode("Custom Functions", "", []); - // create filter lists for types we shouldn't expose + // Create filter lists for types we shouldn't expose if (hostName === "excel") { - generalFilter = generalFilter.concat(excelIconSetFilter); + generalFilter = generalFilter.concat(EXCEL_ICON_SET_FILTER); } else if (hostName === "outlook") { - generalFilter = generalFilter.concat(['Appointment', 'AppointmentForm', 'ItemCompose', 'ItemRead', 'Message']); + generalFilter = generalFilter.concat(OUTLOOK_FILTER_ITEMS); } origToc.items.forEach((rootItem) => { rootItem.items.forEach((packageItem: ApplicationTocNode) => { - // fix host capitalization - let packageName; - if (packageItem.name === 'onenote') { - packageName = 'OneNote'; - } else if (packageItem.name === 'powerpoint') { - packageName = 'PowerPoint'; - } else { - packageName = (packageItem.name.substr(0, 1).toUpperCase() + packageItem.name.substr(1)).replace(/\-/g, ' '); - } + // Fix host capitalization + const packageName = capitalizeHostName(packageItem.name); - // get items in the namespace for the new TOC + // Get items in the namespace for the new TOC membersToMove.items = packageItem.items; - if (packageName.toLocaleLowerCase().includes('custom functions runtime')) { - customFunctionsRoot.items.push({ - "name": packageName, - "uid": packageItem.uid, - "items": membersToMove.items as any - }); + if (packageName.toLowerCase().includes('custom functions runtime')) { + customFunctionsRoot.items.push(createTocNode(packageName, packageItem.uid, membersToMove.items as any)); } else { let primaryList = [] as any; if (membersToMove.items) { - let enumList = membersToMove.items.filter(item => { - return item.uid.indexOf("enum") >= 0; - }); + const enumList = membersToMove.items.filter(item => item.uid.includes("enum")); + primaryList = membersToMove.items.filter(item => { - // Remove previous chosen items and anything with the "Interfaces" namespace (those are Rich API duplicates for load/set). - return generalFilter.indexOf(item.name) < 0 && item.uid.indexOf(".Interfaces.") < 0 && item.uid.indexOf("enum") < 0; + return generalFilter.indexOf(item.name) < 0 && + !item.uid.includes(".Interfaces.") && + !item.uid.includes("enum"); }); - if (enumList) { - const enumRootName = packageName.toLocaleLowerCase().includes("outlook") ? "MailboxEnums" : "Enums"; - let enumRoot = {"name": enumRootName, "uid": "", "items": enumList}; - if (packageName.toLocaleLowerCase().includes("excel")) { - // Excel has also has subfolders for icon sets and custom functions. They need to be correctly ordered. - let iconSetList = membersToMove.items.filter(item => { - return excelIconSetFilter.indexOf(item.name) >= 0; - }); + if (enumList.length > 0) { + const enumRootName = packageName.toLowerCase().includes("outlook") ? "MailboxEnums" : "Enums"; + const enumRoot = createTocNode(enumRootName, "", enumList); + + if (packageName.toLowerCase().includes("excel")) { + // Excel has subfolders for icon sets and custom functions + const iconSetList = membersToMove.items.filter(item => + EXCEL_ICON_SET_FILTER.includes(item.name) + ); if (iconSetList.length > 0) { - let excelIconSetRoot = {"name": "Icon Sets", "uid": "", "items": iconSetList}; + const excelIconSetRoot = createTocNode("Icon Sets", "", iconSetList); primaryList.unshift(excelIconSetRoot); } primaryList.unshift(enumRoot); @@ -355,13 +492,11 @@ function fixToc(tocPath: string, globalToc: Toc, hostName: string, versionNumber } } - + // Address any nested namespaces primaryList.forEach((namespaceItem) => { - // Address any nested namespaces - // Scan UID for namespace to add to name. if (namespaceItem.uid) { - let regex = /\w+\.(\w+\.\w+)/g; - let matchResults = regex.exec(namespaceItem.uid); + const regex = /\w+\.(\w+\.\w+)/g; + const matchResults = regex.exec(namespaceItem.uid); if (matchResults) { namespaceItem.name = matchResults[1]; } @@ -396,65 +531,62 @@ function fixToc(tocPath: string, globalToc: Toc, hostName: string, versionNumber function fixCommonToc(tocPath: string, globalToc: Toc): Toc { console.log(`\nUpdating the structure of the Common TOC file: ${tocPath}`); - let origToc = (jsyaml.load(fsx.readFileSync(tocPath).toString()) as Toc); - let runtimeToc = (jsyaml.load(fsx.readFileSync(path.resolve("../../docs/docs-ref-autogen/office-runtime/toc.yml")).toString()) as Toc); + const origToc = jsyaml.load(fsx.readFileSync(tocPath).toString()) as Toc; + const runtimeTocPath = path.resolve("../../docs/docs-ref-autogen/office-runtime/toc.yml"); + const runtimeToc = jsyaml.load(fsx.readFileSync(runtimeTocPath).toString()) as Toc; + origToc.items[0].items = origToc.items[0].items.concat(runtimeToc.items[0].items); let membersToMove = {}; - // Create roots for items we want to reorder. - let newTocNode = { + // Create roots for items we want to reorder + const newTocNode = { name: 'Common APIs', uid: "office!", items: [] as any }; - // create folders for common (shared) API subcategories - let sharedEnumFilter = generateEnumList(fsx.readFileSync("../api-extractor-inputs-office/office.d.ts").toString()); - sharedEnumFilter.concat(generateEnumList(fsx.readFileSync("../api-extractor-inputs-office-runtime/office-runtime.d.ts").toString())); + // Create folders for common (shared) API subcategories + const officeTypesPath = path.resolve("../api-extractor-inputs-office/office.d.ts"); + const runtimeTypesPath = path.resolve("../api-extractor-inputs-office-runtime/office-runtime.d.ts"); + + let sharedEnumFilter = generateEnumList(fsx.readFileSync(officeTypesPath).toString()); + sharedEnumFilter = sharedEnumFilter.concat(generateEnumList(fsx.readFileSync(runtimeTypesPath).toString())); - // process 'office' (Common "Shared" API) package - origToc.items.forEach((rootItem, rootIndex) => { - rootItem.items.forEach((packageItem: ApplicationTocNode, packageIndex) => { + // Process 'office' (Common "Shared" API) package + origToc.items.forEach((rootItem) => { + rootItem.items.forEach((packageItem: ApplicationTocNode) => { membersToMove.items = packageItem.items; - if (packageItem.name.toLocaleLowerCase() === 'office') { - membersToMove.items.forEach((namespaceItem, namespaceIndex) => { - // Scan UID for namespace to add to name. - if (namespaceItem.uid) { - let regex = /\w+\.(\w+\.\w+)/g; - let matchResults = regex.exec(namespaceItem.uid); + + if (packageItem.name.toLowerCase() === 'office') { + membersToMove.items.forEach((namespaceItem) => { + // Scan UID for namespace to add to name + if (namespaceItem.uid) { + const regex = /\w+\.(\w+\.\w+)/g; + const matchResults = regex.exec(namespaceItem.uid); if (matchResults) { namespaceItem.name = matchResults[1]; } } }); - let enumList = membersToMove.items.filter(item => { - return sharedEnumFilter.indexOf(item.name) >= 0; - }); - let officeExtensionList = membersToMove.items.filter(item => { - return item.uid.indexOf("office!OfficeExtension.") >= 0; - }); - let primaryList = membersToMove.items.filter(item => { - return sharedEnumFilter.indexOf(item.name) < 0 && item.uid.indexOf("office!OfficeExtension.") < 0; - }); - - let sharedEnumRoot = {"name": "Enums", "uid": "", "items": enumList}; + const enumList = membersToMove.items.filter(item => + sharedEnumFilter.includes(item.name) + ); + const officeExtensionList = membersToMove.items.filter(item => + item.uid.includes("office!OfficeExtension.") + ); + const primaryList = membersToMove.items.filter(item => + !sharedEnumFilter.includes(item.name) && !item.uid.includes("office!OfficeExtension.") + ); + + const sharedEnumRoot = createTocNode("Enums", "", enumList); primaryList.unshift(sharedEnumRoot); - newTocNode.items.push({ - "name": 'Office', - "uid": packageItem.uid, - "items": primaryList - }); - newTocNode.items.push({ - "name": 'OfficeExtension', - "items": officeExtensionList - }); + + newTocNode.items.push(createTocNode('Office', packageItem.uid, primaryList)); + newTocNode.items.push(createTocNode('OfficeExtension', "", officeExtensionList)); + } else if (packageItem.name === 'office-runtime') { - newTocNode.items.push({ - "name": 'OfficeRuntime', - "uid": packageItem.uid, - "items": packageItem.items - }); + newTocNode.items.push(createTocNode('OfficeRuntime', packageItem.uid, packageItem.items)); } }); }); @@ -479,16 +611,20 @@ function cleanUpYmlFile(ymlFile: string, hostName: string): string { const apiYaml: ApiYaml = jsyaml.load(ymlFile) as ApiYaml; // Add links for type aliases. - if (apiYaml.uid.endsWith(":type") && (apiYaml.uid.indexOf("Office") < 0)) { - let remarks = `\n\nLearn more about the types in this type alias through the following links. \n\n` - apiYaml.syntax.substring(apiYaml.syntax.indexOf('=')).match(/[\w]+/g).forEach((match, matchIndex, matches) => { - remarks += `[${capitalizeFirstLetter(hostName)}.${match}](/javascript/api/${hostName}/${hostName}.${match.toLowerCase()})`; - if (matchIndex < matches.length - 1) { - remarks += ", "; - } - }); + if (apiYaml.uid.endsWith(":type") && !apiYaml.uid.includes("Office")) { + let remarks = `\n\nLearn more about the types in this type alias through the following links. \n\n`; + const matches = apiYaml.syntax.substring(apiYaml.syntax.indexOf('=')).match(/[\w]+/g); + + if (matches) { + matches.forEach((match, matchIndex) => { + remarks += `[${capitalizeFirstLetter(hostName)}.${match}](/javascript/api/${hostName}/${hostName}.${match.toLowerCase()})`; + if (matchIndex < matches.length - 1) { + remarks += ", "; + } + }); + } - let exampleIndex = apiYaml.remarks.indexOf("#### Examples"); + const exampleIndex = apiYaml.remarks.indexOf("#### Examples"); if (exampleIndex > 0) { apiYaml.remarks = `${apiYaml.remarks.substring(0, exampleIndex)}${remarks}\n\n${apiYaml.remarks.substring(exampleIndex)}`; } else { @@ -497,9 +633,10 @@ function cleanUpYmlFile(ymlFile: string, hostName: string): string { } let cleanYml = schemaComment + jsyaml.dump(apiYaml); - return cleanYml.replace(/^\s*example: \[\]\s*$/gm, "") // Remove example field from yml as the OPS schema does not support it. - .replace(/description: \\\*[\r\n]/gm, "description: ''") // Remove descriptions that are just "\*". - .replace(/\\\*/gm, "*"); // Fix asterisk protection. + + // Apply cleanup patterns + return YML_CLEANUP_PATTERNS.reduce((content, { pattern, replacement }) => + content.replace(pattern, replacement), cleanYml); } function capitalizeFirstLetter(str: string): string {