diff --git a/docs/docs-ref-autogen/excel/excel/excel.cardlayoutsection.yml b/docs/docs-ref-autogen/excel/excel/excel.cardlayoutsection.yml index cca1b0c56e..c8bd52c201 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.cardlayoutsection.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.cardlayoutsection.yml @@ -9,6 +9,8 @@ remarks: >- 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + Learn more about the types in this type alias through the following links. @@ -16,6 +18,71 @@ remarks: >- [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection), [Excel.CardLayoutTwoColumnSection](/javascript/api/excel/excel.cardlayouttwocolumnsection) + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-entity-attribution.yaml + + + function makeProductEntity(productID: number, productName: string, product?: + any) { + const entity: Excel.EntityCellValue = { + type: Excel.CellValueType.entity, + text: productName, + properties: { /* Excel.EntityPropertyType */ + "Product ID": { + type: Excel.CellValueType.string, + basicValue: productID.toString() || "" + }, + "Product Name": { + type: Excel.CellValueType.string, + basicValue: productName || "" + }, + "Quantity Per Unit": { + type: Excel.CellValueType.string, + basicValue: product.quantityPerUnit || "" + }, + // Add Unit Price as a formatted number. + "Unit Price": { + type: Excel.CellValueType.formattedNumber, + basicValue: product.unitPrice, + numberFormat: "$* #,##0.00" + } + }, + layouts: { /* Excel.EntityViewLayouts */ + card: { /* Excel.EntityCardLayout */ + title: { property: "Product Name" }, + sections: [ /* Excel.CardLayoutSection */ + { + layout: "List", + properties: ["Product ID"] + }, + { + layout: "List", + title: "Quantity and price", + collapsible: true, + collapsed: false, + properties: ["Quantity Per Unit", "Unit Price"] + } + ] + } + }, + provider: { + description: product.providerName, // Name of the data provider. Displays as a tooltip when hovering over the logo. Also displays as a fallback if the source address for the image is broken. + logoSourceAddress: product.sourceAddress, // Source URL of the logo to display. + logoTargetAddress: product.targetAddress // Destination URL that the logo navigates to when clicked. + } + }; + + return entity; + } + + ``` + isPreview: false isDeprecated: false syntax: >- diff --git a/docs/docs-ref-autogen/excel/excel/excel.cellborder.yml b/docs/docs-ref-autogen/excel/excel/excel.cellborder.yml index bc2f00c585..d0ccbdc739 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.cellborder.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.cellborder.yml @@ -13,6 +13,90 @@ remarks: >- \[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/cell-properties.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Creating the SettableCellProperties objects to use for the range. + // In your add-in, these should be created once, outside the function. + const topHeaderProps: Excel.SettableCellProperties = { + // The style property takes a string matching the name of an Excel style. + // Built-in style names are listed in the `BuiltInStyle` enum. + // Note that a style will overwrite any formatting, + // so do not use the format property with the style property. + style: "Heading1" + }; + + const headerProps: Excel.SettableCellProperties = { + // Any subproperties of format that are not set will not be changed when these cell properties are set. + format: { + fill: { + color: "Blue" + }, + font: { + color: "White", + bold: true + } + } + }; + + const nonApplicableProps: Excel.SettableCellProperties = { + format: { + fill: { + pattern: Excel.FillPattern.gray25 + }, + font: { + color: "Gray", + italic: true + } + } + }; + + const matchupScoreProps: Excel.SettableCellProperties = { + format: { + borders: { + bottom: { + style: Excel.BorderLineStyle.continuous + }, + left: { + style: Excel.BorderLineStyle.continuous + }, + right: { + style: Excel.BorderLineStyle.continuous + }, + top: { + style: Excel.BorderLineStyle.continuous + } + } + } + }; + + const range = sheet.getRange("A1:E5"); + + // You can use empty JSON objects to avoid changing a cell's properties. + range.setCellProperties([ + [topHeaderProps, {}, {}, {}, {}], + [{}, {}, headerProps, headerProps, headerProps], + [{}, headerProps, nonApplicableProps, matchupScoreProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, nonApplicableProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, matchupScoreProps, nonApplicableProps] + ]); + + sheet.getUsedRange().format.autofitColumns(); + await context.sync(); + }); + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/excel/excel/excel.datavalidationerroralert.yml b/docs/docs-ref-autogen/excel/excel/excel.datavalidationerroralert.yml index f5dfde1895..5bd9a15eb5 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.datavalidationerroralert.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.datavalidationerroralert.yml @@ -8,6 +8,50 @@ remarks: >- \[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/22-data-validation/data-validation.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Decision"); + const rankingRange = sheet.tables.getItem("NameOptionsTable").columns.getItem("Ranking").getDataBodyRange(); + + // When you are developing, it is a good practice to + // clear the dataValidation object with each run of your code. + rankingRange.dataValidation.clear(); + + let greaterThanZeroRule = { + wholeNumber: { + formula1: 0, + operator: Excel.DataValidationOperator.greaterThan + } + }; + rankingRange.dataValidation.rule = greaterThanZeroRule; + + rankingRange.dataValidation.prompt = { + message: "Please enter a positive number.", + showPrompt: true, + title: "Positive numbers only." + }; + + rankingRange.dataValidation.errorAlert = { + message: "Sorry, only positive numbers are allowed", + showAlert: true, + style: "Stop", + title: "Negative Number Entered" + }; + + await context.sync(); + }); + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/excel/excel/excel.entitycardlayout.yml b/docs/docs-ref-autogen/excel/excel/excel.entitycardlayout.yml index 98e8648014..c0a00840cc 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.entitycardlayout.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.entitycardlayout.yml @@ -8,6 +8,71 @@ remarks: >- \[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-entity-attribution.yaml + + + function makeProductEntity(productID: number, productName: string, product?: + any) { + const entity: Excel.EntityCellValue = { + type: Excel.CellValueType.entity, + text: productName, + properties: { /* Excel.EntityPropertyType */ + "Product ID": { + type: Excel.CellValueType.string, + basicValue: productID.toString() || "" + }, + "Product Name": { + type: Excel.CellValueType.string, + basicValue: productName || "" + }, + "Quantity Per Unit": { + type: Excel.CellValueType.string, + basicValue: product.quantityPerUnit || "" + }, + // Add Unit Price as a formatted number. + "Unit Price": { + type: Excel.CellValueType.formattedNumber, + basicValue: product.unitPrice, + numberFormat: "$* #,##0.00" + } + }, + layouts: { /* Excel.EntityViewLayouts */ + card: { /* Excel.EntityCardLayout */ + title: { property: "Product Name" }, + sections: [ /* Excel.CardLayoutSection */ + { + layout: "List", + properties: ["Product ID"] + }, + { + layout: "List", + title: "Quantity and price", + collapsible: true, + collapsed: false, + properties: ["Quantity Per Unit", "Unit Price"] + } + ] + } + }, + provider: { + description: product.providerName, // Name of the data provider. Displays as a tooltip when hovering over the logo. Also displays as a fallback if the source address for the image is broken. + logoSourceAddress: product.sourceAddress, // Source URL of the logo to display. + logoTargetAddress: product.targetAddress // Destination URL that the logo navigates to when clicked. + } + }; + + return entity; + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/excel/excel/excel.entitypropertytype.yml b/docs/docs-ref-autogen/excel/excel/excel.entitypropertytype.yml index bc54a6eff6..b9afefd0e4 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.entitypropertytype.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.entitypropertytype.yml @@ -9,12 +9,79 @@ remarks: >- 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) + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-entity-attribution.yaml + + + function makeProductEntity(productID: number, productName: string, product?: + any) { + const entity: Excel.EntityCellValue = { + type: Excel.CellValueType.entity, + text: productName, + properties: { /* Excel.EntityPropertyType */ + "Product ID": { + type: Excel.CellValueType.string, + basicValue: productID.toString() || "" + }, + "Product Name": { + type: Excel.CellValueType.string, + basicValue: productName || "" + }, + "Quantity Per Unit": { + type: Excel.CellValueType.string, + basicValue: product.quantityPerUnit || "" + }, + // Add Unit Price as a formatted number. + "Unit Price": { + type: Excel.CellValueType.formattedNumber, + basicValue: product.unitPrice, + numberFormat: "$* #,##0.00" + } + }, + layouts: { /* Excel.EntityViewLayouts */ + card: { /* Excel.EntityCardLayout */ + title: { property: "Product Name" }, + sections: [ /* Excel.CardLayoutSection */ + { + layout: "List", + properties: ["Product ID"] + }, + { + layout: "List", + title: "Quantity and price", + collapsible: true, + collapsed: false, + properties: ["Quantity Per Unit", "Unit Price"] + } + ] + } + }, + provider: { + description: product.providerName, // Name of the data provider. Displays as a tooltip when hovering over the logo. Also displays as a fallback if the source address for the image is broken. + logoSourceAddress: product.sourceAddress, // Source URL of the logo to display. + logoTargetAddress: product.targetAddress // Destination URL that the logo navigates to when clicked. + } + }; + + return entity; + } + + ``` + isPreview: false isDeprecated: false syntax: export type EntityPropertyType = CellValueAndPropertyMetadata | CellValue; diff --git a/docs/docs-ref-autogen/excel/excel/excel.entityviewlayouts.yml b/docs/docs-ref-autogen/excel/excel/excel.entityviewlayouts.yml index 22c4101139..ed623b76d9 100644 --- a/docs/docs-ref-autogen/excel/excel/excel.entityviewlayouts.yml +++ b/docs/docs-ref-autogen/excel/excel/excel.entityviewlayouts.yml @@ -8,6 +8,71 @@ remarks: >- \[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-entity-attribution.yaml + + + function makeProductEntity(productID: number, productName: string, product?: + any) { + const entity: Excel.EntityCellValue = { + type: Excel.CellValueType.entity, + text: productName, + properties: { /* Excel.EntityPropertyType */ + "Product ID": { + type: Excel.CellValueType.string, + basicValue: productID.toString() || "" + }, + "Product Name": { + type: Excel.CellValueType.string, + basicValue: productName || "" + }, + "Quantity Per Unit": { + type: Excel.CellValueType.string, + basicValue: product.quantityPerUnit || "" + }, + // Add Unit Price as a formatted number. + "Unit Price": { + type: Excel.CellValueType.formattedNumber, + basicValue: product.unitPrice, + numberFormat: "$* #,##0.00" + } + }, + layouts: { /* Excel.EntityViewLayouts */ + card: { /* Excel.EntityCardLayout */ + title: { property: "Product Name" }, + sections: [ /* Excel.CardLayoutSection */ + { + layout: "List", + properties: ["Product ID"] + }, + { + layout: "List", + title: "Quantity and price", + collapsible: true, + collapsed: false, + properties: ["Quantity Per Unit", "Unit Price"] + } + ] + } + }, + provider: { + description: product.providerName, // Name of the data provider. Displays as a tooltip when hovering over the logo. Also displays as a fallback if the source address for the image is broken. + logoSourceAddress: product.sourceAddress, // Source URL of the logo to display. + logoTargetAddress: product.targetAddress // Destination URL that the logo navigates to when clicked. + } + }; + + return entity; + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/excel_1_10/excel/excel.cellborder.yml b/docs/docs-ref-autogen/excel_1_10/excel/excel.cellborder.yml index bc2f00c585..d0ccbdc739 100644 --- a/docs/docs-ref-autogen/excel_1_10/excel/excel.cellborder.yml +++ b/docs/docs-ref-autogen/excel_1_10/excel/excel.cellborder.yml @@ -13,6 +13,90 @@ remarks: >- \[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/cell-properties.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Creating the SettableCellProperties objects to use for the range. + // In your add-in, these should be created once, outside the function. + const topHeaderProps: Excel.SettableCellProperties = { + // The style property takes a string matching the name of an Excel style. + // Built-in style names are listed in the `BuiltInStyle` enum. + // Note that a style will overwrite any formatting, + // so do not use the format property with the style property. + style: "Heading1" + }; + + const headerProps: Excel.SettableCellProperties = { + // Any subproperties of format that are not set will not be changed when these cell properties are set. + format: { + fill: { + color: "Blue" + }, + font: { + color: "White", + bold: true + } + } + }; + + const nonApplicableProps: Excel.SettableCellProperties = { + format: { + fill: { + pattern: Excel.FillPattern.gray25 + }, + font: { + color: "Gray", + italic: true + } + } + }; + + const matchupScoreProps: Excel.SettableCellProperties = { + format: { + borders: { + bottom: { + style: Excel.BorderLineStyle.continuous + }, + left: { + style: Excel.BorderLineStyle.continuous + }, + right: { + style: Excel.BorderLineStyle.continuous + }, + top: { + style: Excel.BorderLineStyle.continuous + } + } + } + }; + + const range = sheet.getRange("A1:E5"); + + // You can use empty JSON objects to avoid changing a cell's properties. + range.setCellProperties([ + [topHeaderProps, {}, {}, {}, {}], + [{}, {}, headerProps, headerProps, headerProps], + [{}, headerProps, nonApplicableProps, matchupScoreProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, nonApplicableProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, matchupScoreProps, nonApplicableProps] + ]); + + sheet.getUsedRange().format.autofitColumns(); + await context.sync(); + }); + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/excel_1_10/excel/excel.datavalidationerroralert.yml b/docs/docs-ref-autogen/excel_1_10/excel/excel.datavalidationerroralert.yml index f5dfde1895..5bd9a15eb5 100644 --- a/docs/docs-ref-autogen/excel_1_10/excel/excel.datavalidationerroralert.yml +++ b/docs/docs-ref-autogen/excel_1_10/excel/excel.datavalidationerroralert.yml @@ -8,6 +8,50 @@ remarks: >- \[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/22-data-validation/data-validation.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Decision"); + const rankingRange = sheet.tables.getItem("NameOptionsTable").columns.getItem("Ranking").getDataBodyRange(); + + // When you are developing, it is a good practice to + // clear the dataValidation object with each run of your code. + rankingRange.dataValidation.clear(); + + let greaterThanZeroRule = { + wholeNumber: { + formula1: 0, + operator: Excel.DataValidationOperator.greaterThan + } + }; + rankingRange.dataValidation.rule = greaterThanZeroRule; + + rankingRange.dataValidation.prompt = { + message: "Please enter a positive number.", + showPrompt: true, + title: "Positive numbers only." + }; + + rankingRange.dataValidation.errorAlert = { + message: "Sorry, only positive numbers are allowed", + showAlert: true, + style: "Stop", + title: "Negative Number Entered" + }; + + await context.sync(); + }); + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/excel_1_11/excel/excel.cellborder.yml b/docs/docs-ref-autogen/excel_1_11/excel/excel.cellborder.yml index bc2f00c585..d0ccbdc739 100644 --- a/docs/docs-ref-autogen/excel_1_11/excel/excel.cellborder.yml +++ b/docs/docs-ref-autogen/excel_1_11/excel/excel.cellborder.yml @@ -13,6 +13,90 @@ remarks: >- \[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/cell-properties.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Creating the SettableCellProperties objects to use for the range. + // In your add-in, these should be created once, outside the function. + const topHeaderProps: Excel.SettableCellProperties = { + // The style property takes a string matching the name of an Excel style. + // Built-in style names are listed in the `BuiltInStyle` enum. + // Note that a style will overwrite any formatting, + // so do not use the format property with the style property. + style: "Heading1" + }; + + const headerProps: Excel.SettableCellProperties = { + // Any subproperties of format that are not set will not be changed when these cell properties are set. + format: { + fill: { + color: "Blue" + }, + font: { + color: "White", + bold: true + } + } + }; + + const nonApplicableProps: Excel.SettableCellProperties = { + format: { + fill: { + pattern: Excel.FillPattern.gray25 + }, + font: { + color: "Gray", + italic: true + } + } + }; + + const matchupScoreProps: Excel.SettableCellProperties = { + format: { + borders: { + bottom: { + style: Excel.BorderLineStyle.continuous + }, + left: { + style: Excel.BorderLineStyle.continuous + }, + right: { + style: Excel.BorderLineStyle.continuous + }, + top: { + style: Excel.BorderLineStyle.continuous + } + } + } + }; + + const range = sheet.getRange("A1:E5"); + + // You can use empty JSON objects to avoid changing a cell's properties. + range.setCellProperties([ + [topHeaderProps, {}, {}, {}, {}], + [{}, {}, headerProps, headerProps, headerProps], + [{}, headerProps, nonApplicableProps, matchupScoreProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, nonApplicableProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, matchupScoreProps, nonApplicableProps] + ]); + + sheet.getUsedRange().format.autofitColumns(); + await context.sync(); + }); + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/excel_1_11/excel/excel.datavalidationerroralert.yml b/docs/docs-ref-autogen/excel_1_11/excel/excel.datavalidationerroralert.yml index f5dfde1895..5bd9a15eb5 100644 --- a/docs/docs-ref-autogen/excel_1_11/excel/excel.datavalidationerroralert.yml +++ b/docs/docs-ref-autogen/excel_1_11/excel/excel.datavalidationerroralert.yml @@ -8,6 +8,50 @@ remarks: >- \[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/22-data-validation/data-validation.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Decision"); + const rankingRange = sheet.tables.getItem("NameOptionsTable").columns.getItem("Ranking").getDataBodyRange(); + + // When you are developing, it is a good practice to + // clear the dataValidation object with each run of your code. + rankingRange.dataValidation.clear(); + + let greaterThanZeroRule = { + wholeNumber: { + formula1: 0, + operator: Excel.DataValidationOperator.greaterThan + } + }; + rankingRange.dataValidation.rule = greaterThanZeroRule; + + rankingRange.dataValidation.prompt = { + message: "Please enter a positive number.", + showPrompt: true, + title: "Positive numbers only." + }; + + rankingRange.dataValidation.errorAlert = { + message: "Sorry, only positive numbers are allowed", + showAlert: true, + style: "Stop", + title: "Negative Number Entered" + }; + + await context.sync(); + }); + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/excel_1_12/excel/excel.cellborder.yml b/docs/docs-ref-autogen/excel_1_12/excel/excel.cellborder.yml index bc2f00c585..d0ccbdc739 100644 --- a/docs/docs-ref-autogen/excel_1_12/excel/excel.cellborder.yml +++ b/docs/docs-ref-autogen/excel_1_12/excel/excel.cellborder.yml @@ -13,6 +13,90 @@ remarks: >- \[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/cell-properties.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Creating the SettableCellProperties objects to use for the range. + // In your add-in, these should be created once, outside the function. + const topHeaderProps: Excel.SettableCellProperties = { + // The style property takes a string matching the name of an Excel style. + // Built-in style names are listed in the `BuiltInStyle` enum. + // Note that a style will overwrite any formatting, + // so do not use the format property with the style property. + style: "Heading1" + }; + + const headerProps: Excel.SettableCellProperties = { + // Any subproperties of format that are not set will not be changed when these cell properties are set. + format: { + fill: { + color: "Blue" + }, + font: { + color: "White", + bold: true + } + } + }; + + const nonApplicableProps: Excel.SettableCellProperties = { + format: { + fill: { + pattern: Excel.FillPattern.gray25 + }, + font: { + color: "Gray", + italic: true + } + } + }; + + const matchupScoreProps: Excel.SettableCellProperties = { + format: { + borders: { + bottom: { + style: Excel.BorderLineStyle.continuous + }, + left: { + style: Excel.BorderLineStyle.continuous + }, + right: { + style: Excel.BorderLineStyle.continuous + }, + top: { + style: Excel.BorderLineStyle.continuous + } + } + } + }; + + const range = sheet.getRange("A1:E5"); + + // You can use empty JSON objects to avoid changing a cell's properties. + range.setCellProperties([ + [topHeaderProps, {}, {}, {}, {}], + [{}, {}, headerProps, headerProps, headerProps], + [{}, headerProps, nonApplicableProps, matchupScoreProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, nonApplicableProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, matchupScoreProps, nonApplicableProps] + ]); + + sheet.getUsedRange().format.autofitColumns(); + await context.sync(); + }); + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/excel_1_12/excel/excel.datavalidationerroralert.yml b/docs/docs-ref-autogen/excel_1_12/excel/excel.datavalidationerroralert.yml index f5dfde1895..5bd9a15eb5 100644 --- a/docs/docs-ref-autogen/excel_1_12/excel/excel.datavalidationerroralert.yml +++ b/docs/docs-ref-autogen/excel_1_12/excel/excel.datavalidationerroralert.yml @@ -8,6 +8,50 @@ remarks: >- \[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/22-data-validation/data-validation.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Decision"); + const rankingRange = sheet.tables.getItem("NameOptionsTable").columns.getItem("Ranking").getDataBodyRange(); + + // When you are developing, it is a good practice to + // clear the dataValidation object with each run of your code. + rankingRange.dataValidation.clear(); + + let greaterThanZeroRule = { + wholeNumber: { + formula1: 0, + operator: Excel.DataValidationOperator.greaterThan + } + }; + rankingRange.dataValidation.rule = greaterThanZeroRule; + + rankingRange.dataValidation.prompt = { + message: "Please enter a positive number.", + showPrompt: true, + title: "Positive numbers only." + }; + + rankingRange.dataValidation.errorAlert = { + message: "Sorry, only positive numbers are allowed", + showAlert: true, + style: "Stop", + title: "Negative Number Entered" + }; + + await context.sync(); + }); + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/excel_1_13/excel/excel.cellborder.yml b/docs/docs-ref-autogen/excel_1_13/excel/excel.cellborder.yml index bc2f00c585..d0ccbdc739 100644 --- a/docs/docs-ref-autogen/excel_1_13/excel/excel.cellborder.yml +++ b/docs/docs-ref-autogen/excel_1_13/excel/excel.cellborder.yml @@ -13,6 +13,90 @@ remarks: >- \[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/cell-properties.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Creating the SettableCellProperties objects to use for the range. + // In your add-in, these should be created once, outside the function. + const topHeaderProps: Excel.SettableCellProperties = { + // The style property takes a string matching the name of an Excel style. + // Built-in style names are listed in the `BuiltInStyle` enum. + // Note that a style will overwrite any formatting, + // so do not use the format property with the style property. + style: "Heading1" + }; + + const headerProps: Excel.SettableCellProperties = { + // Any subproperties of format that are not set will not be changed when these cell properties are set. + format: { + fill: { + color: "Blue" + }, + font: { + color: "White", + bold: true + } + } + }; + + const nonApplicableProps: Excel.SettableCellProperties = { + format: { + fill: { + pattern: Excel.FillPattern.gray25 + }, + font: { + color: "Gray", + italic: true + } + } + }; + + const matchupScoreProps: Excel.SettableCellProperties = { + format: { + borders: { + bottom: { + style: Excel.BorderLineStyle.continuous + }, + left: { + style: Excel.BorderLineStyle.continuous + }, + right: { + style: Excel.BorderLineStyle.continuous + }, + top: { + style: Excel.BorderLineStyle.continuous + } + } + } + }; + + const range = sheet.getRange("A1:E5"); + + // You can use empty JSON objects to avoid changing a cell's properties. + range.setCellProperties([ + [topHeaderProps, {}, {}, {}, {}], + [{}, {}, headerProps, headerProps, headerProps], + [{}, headerProps, nonApplicableProps, matchupScoreProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, nonApplicableProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, matchupScoreProps, nonApplicableProps] + ]); + + sheet.getUsedRange().format.autofitColumns(); + await context.sync(); + }); + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/excel_1_13/excel/excel.datavalidationerroralert.yml b/docs/docs-ref-autogen/excel_1_13/excel/excel.datavalidationerroralert.yml index f5dfde1895..5bd9a15eb5 100644 --- a/docs/docs-ref-autogen/excel_1_13/excel/excel.datavalidationerroralert.yml +++ b/docs/docs-ref-autogen/excel_1_13/excel/excel.datavalidationerroralert.yml @@ -8,6 +8,50 @@ remarks: >- \[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/22-data-validation/data-validation.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Decision"); + const rankingRange = sheet.tables.getItem("NameOptionsTable").columns.getItem("Ranking").getDataBodyRange(); + + // When you are developing, it is a good practice to + // clear the dataValidation object with each run of your code. + rankingRange.dataValidation.clear(); + + let greaterThanZeroRule = { + wholeNumber: { + formula1: 0, + operator: Excel.DataValidationOperator.greaterThan + } + }; + rankingRange.dataValidation.rule = greaterThanZeroRule; + + rankingRange.dataValidation.prompt = { + message: "Please enter a positive number.", + showPrompt: true, + title: "Positive numbers only." + }; + + rankingRange.dataValidation.errorAlert = { + message: "Sorry, only positive numbers are allowed", + showAlert: true, + style: "Stop", + title: "Negative Number Entered" + }; + + await context.sync(); + }); + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/excel_1_14/excel/excel.cellborder.yml b/docs/docs-ref-autogen/excel_1_14/excel/excel.cellborder.yml index bc2f00c585..d0ccbdc739 100644 --- a/docs/docs-ref-autogen/excel_1_14/excel/excel.cellborder.yml +++ b/docs/docs-ref-autogen/excel_1_14/excel/excel.cellborder.yml @@ -13,6 +13,90 @@ remarks: >- \[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/cell-properties.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Creating the SettableCellProperties objects to use for the range. + // In your add-in, these should be created once, outside the function. + const topHeaderProps: Excel.SettableCellProperties = { + // The style property takes a string matching the name of an Excel style. + // Built-in style names are listed in the `BuiltInStyle` enum. + // Note that a style will overwrite any formatting, + // so do not use the format property with the style property. + style: "Heading1" + }; + + const headerProps: Excel.SettableCellProperties = { + // Any subproperties of format that are not set will not be changed when these cell properties are set. + format: { + fill: { + color: "Blue" + }, + font: { + color: "White", + bold: true + } + } + }; + + const nonApplicableProps: Excel.SettableCellProperties = { + format: { + fill: { + pattern: Excel.FillPattern.gray25 + }, + font: { + color: "Gray", + italic: true + } + } + }; + + const matchupScoreProps: Excel.SettableCellProperties = { + format: { + borders: { + bottom: { + style: Excel.BorderLineStyle.continuous + }, + left: { + style: Excel.BorderLineStyle.continuous + }, + right: { + style: Excel.BorderLineStyle.continuous + }, + top: { + style: Excel.BorderLineStyle.continuous + } + } + } + }; + + const range = sheet.getRange("A1:E5"); + + // You can use empty JSON objects to avoid changing a cell's properties. + range.setCellProperties([ + [topHeaderProps, {}, {}, {}, {}], + [{}, {}, headerProps, headerProps, headerProps], + [{}, headerProps, nonApplicableProps, matchupScoreProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, nonApplicableProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, matchupScoreProps, nonApplicableProps] + ]); + + sheet.getUsedRange().format.autofitColumns(); + await context.sync(); + }); + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/excel_1_14/excel/excel.datavalidationerroralert.yml b/docs/docs-ref-autogen/excel_1_14/excel/excel.datavalidationerroralert.yml index f5dfde1895..5bd9a15eb5 100644 --- a/docs/docs-ref-autogen/excel_1_14/excel/excel.datavalidationerroralert.yml +++ b/docs/docs-ref-autogen/excel_1_14/excel/excel.datavalidationerroralert.yml @@ -8,6 +8,50 @@ remarks: >- \[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/22-data-validation/data-validation.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Decision"); + const rankingRange = sheet.tables.getItem("NameOptionsTable").columns.getItem("Ranking").getDataBodyRange(); + + // When you are developing, it is a good practice to + // clear the dataValidation object with each run of your code. + rankingRange.dataValidation.clear(); + + let greaterThanZeroRule = { + wholeNumber: { + formula1: 0, + operator: Excel.DataValidationOperator.greaterThan + } + }; + rankingRange.dataValidation.rule = greaterThanZeroRule; + + rankingRange.dataValidation.prompt = { + message: "Please enter a positive number.", + showPrompt: true, + title: "Positive numbers only." + }; + + rankingRange.dataValidation.errorAlert = { + message: "Sorry, only positive numbers are allowed", + showAlert: true, + style: "Stop", + title: "Negative Number Entered" + }; + + await context.sync(); + }); + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/excel_1_15/excel/excel.cellborder.yml b/docs/docs-ref-autogen/excel_1_15/excel/excel.cellborder.yml index bc2f00c585..d0ccbdc739 100644 --- a/docs/docs-ref-autogen/excel_1_15/excel/excel.cellborder.yml +++ b/docs/docs-ref-autogen/excel_1_15/excel/excel.cellborder.yml @@ -13,6 +13,90 @@ remarks: >- \[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/cell-properties.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Creating the SettableCellProperties objects to use for the range. + // In your add-in, these should be created once, outside the function. + const topHeaderProps: Excel.SettableCellProperties = { + // The style property takes a string matching the name of an Excel style. + // Built-in style names are listed in the `BuiltInStyle` enum. + // Note that a style will overwrite any formatting, + // so do not use the format property with the style property. + style: "Heading1" + }; + + const headerProps: Excel.SettableCellProperties = { + // Any subproperties of format that are not set will not be changed when these cell properties are set. + format: { + fill: { + color: "Blue" + }, + font: { + color: "White", + bold: true + } + } + }; + + const nonApplicableProps: Excel.SettableCellProperties = { + format: { + fill: { + pattern: Excel.FillPattern.gray25 + }, + font: { + color: "Gray", + italic: true + } + } + }; + + const matchupScoreProps: Excel.SettableCellProperties = { + format: { + borders: { + bottom: { + style: Excel.BorderLineStyle.continuous + }, + left: { + style: Excel.BorderLineStyle.continuous + }, + right: { + style: Excel.BorderLineStyle.continuous + }, + top: { + style: Excel.BorderLineStyle.continuous + } + } + } + }; + + const range = sheet.getRange("A1:E5"); + + // You can use empty JSON objects to avoid changing a cell's properties. + range.setCellProperties([ + [topHeaderProps, {}, {}, {}, {}], + [{}, {}, headerProps, headerProps, headerProps], + [{}, headerProps, nonApplicableProps, matchupScoreProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, nonApplicableProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, matchupScoreProps, nonApplicableProps] + ]); + + sheet.getUsedRange().format.autofitColumns(); + await context.sync(); + }); + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/excel_1_15/excel/excel.datavalidationerroralert.yml b/docs/docs-ref-autogen/excel_1_15/excel/excel.datavalidationerroralert.yml index f5dfde1895..5bd9a15eb5 100644 --- a/docs/docs-ref-autogen/excel_1_15/excel/excel.datavalidationerroralert.yml +++ b/docs/docs-ref-autogen/excel_1_15/excel/excel.datavalidationerroralert.yml @@ -8,6 +8,50 @@ remarks: >- \[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/22-data-validation/data-validation.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Decision"); + const rankingRange = sheet.tables.getItem("NameOptionsTable").columns.getItem("Ranking").getDataBodyRange(); + + // When you are developing, it is a good practice to + // clear the dataValidation object with each run of your code. + rankingRange.dataValidation.clear(); + + let greaterThanZeroRule = { + wholeNumber: { + formula1: 0, + operator: Excel.DataValidationOperator.greaterThan + } + }; + rankingRange.dataValidation.rule = greaterThanZeroRule; + + rankingRange.dataValidation.prompt = { + message: "Please enter a positive number.", + showPrompt: true, + title: "Positive numbers only." + }; + + rankingRange.dataValidation.errorAlert = { + message: "Sorry, only positive numbers are allowed", + showAlert: true, + style: "Stop", + title: "Negative Number Entered" + }; + + await context.sync(); + }); + + ``` + isPreview: false isDeprecated: false type: interface 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 97e90f572d..9639b1363c 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 @@ -9,12 +9,79 @@ remarks: >- 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) + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-entity-attribution.yaml + + + function makeProductEntity(productID: number, productName: string, product?: + any) { + const entity: Excel.EntityCellValue = { + type: Excel.CellValueType.entity, + text: productName, + properties: { /* Excel.EntityPropertyType */ + "Product ID": { + type: Excel.CellValueType.string, + basicValue: productID.toString() || "" + }, + "Product Name": { + type: Excel.CellValueType.string, + basicValue: productName || "" + }, + "Quantity Per Unit": { + type: Excel.CellValueType.string, + basicValue: product.quantityPerUnit || "" + }, + // Add Unit Price as a formatted number. + "Unit Price": { + type: Excel.CellValueType.formattedNumber, + basicValue: product.unitPrice, + numberFormat: "$* #,##0.00" + } + }, + layouts: { /* Excel.EntityViewLayouts */ + card: { /* Excel.EntityCardLayout */ + title: { property: "Product Name" }, + sections: [ /* Excel.CardLayoutSection */ + { + layout: "List", + properties: ["Product ID"] + }, + { + layout: "List", + title: "Quantity and price", + collapsible: true, + collapsed: false, + properties: ["Quantity Per Unit", "Unit Price"] + } + ] + } + }, + provider: { + description: product.providerName, // Name of the data provider. Displays as a tooltip when hovering over the logo. Also displays as a fallback if the source address for the image is broken. + logoSourceAddress: product.sourceAddress, // Source URL of the logo to display. + logoTargetAddress: product.targetAddress // Destination URL that the logo navigates to when clicked. + } + }; + + return entity; + } + + ``` + isPreview: false isDeprecated: false syntax: >- diff --git a/docs/docs-ref-autogen/excel_1_16/excel/excel.cellborder.yml b/docs/docs-ref-autogen/excel_1_16/excel/excel.cellborder.yml index bc2f00c585..d0ccbdc739 100644 --- a/docs/docs-ref-autogen/excel_1_16/excel/excel.cellborder.yml +++ b/docs/docs-ref-autogen/excel_1_16/excel/excel.cellborder.yml @@ -13,6 +13,90 @@ remarks: >- \[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/cell-properties.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Creating the SettableCellProperties objects to use for the range. + // In your add-in, these should be created once, outside the function. + const topHeaderProps: Excel.SettableCellProperties = { + // The style property takes a string matching the name of an Excel style. + // Built-in style names are listed in the `BuiltInStyle` enum. + // Note that a style will overwrite any formatting, + // so do not use the format property with the style property. + style: "Heading1" + }; + + const headerProps: Excel.SettableCellProperties = { + // Any subproperties of format that are not set will not be changed when these cell properties are set. + format: { + fill: { + color: "Blue" + }, + font: { + color: "White", + bold: true + } + } + }; + + const nonApplicableProps: Excel.SettableCellProperties = { + format: { + fill: { + pattern: Excel.FillPattern.gray25 + }, + font: { + color: "Gray", + italic: true + } + } + }; + + const matchupScoreProps: Excel.SettableCellProperties = { + format: { + borders: { + bottom: { + style: Excel.BorderLineStyle.continuous + }, + left: { + style: Excel.BorderLineStyle.continuous + }, + right: { + style: Excel.BorderLineStyle.continuous + }, + top: { + style: Excel.BorderLineStyle.continuous + } + } + } + }; + + const range = sheet.getRange("A1:E5"); + + // You can use empty JSON objects to avoid changing a cell's properties. + range.setCellProperties([ + [topHeaderProps, {}, {}, {}, {}], + [{}, {}, headerProps, headerProps, headerProps], + [{}, headerProps, nonApplicableProps, matchupScoreProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, nonApplicableProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, matchupScoreProps, nonApplicableProps] + ]); + + sheet.getUsedRange().format.autofitColumns(); + await context.sync(); + }); + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/excel_1_16/excel/excel.datavalidationerroralert.yml b/docs/docs-ref-autogen/excel_1_16/excel/excel.datavalidationerroralert.yml index f5dfde1895..5bd9a15eb5 100644 --- a/docs/docs-ref-autogen/excel_1_16/excel/excel.datavalidationerroralert.yml +++ b/docs/docs-ref-autogen/excel_1_16/excel/excel.datavalidationerroralert.yml @@ -8,6 +8,50 @@ remarks: >- \[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/22-data-validation/data-validation.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Decision"); + const rankingRange = sheet.tables.getItem("NameOptionsTable").columns.getItem("Ranking").getDataBodyRange(); + + // When you are developing, it is a good practice to + // clear the dataValidation object with each run of your code. + rankingRange.dataValidation.clear(); + + let greaterThanZeroRule = { + wholeNumber: { + formula1: 0, + operator: Excel.DataValidationOperator.greaterThan + } + }; + rankingRange.dataValidation.rule = greaterThanZeroRule; + + rankingRange.dataValidation.prompt = { + message: "Please enter a positive number.", + showPrompt: true, + title: "Positive numbers only." + }; + + rankingRange.dataValidation.errorAlert = { + message: "Sorry, only positive numbers are allowed", + showAlert: true, + style: "Stop", + title: "Negative Number Entered" + }; + + await context.sync(); + }); + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/excel_1_16/excel/excel.entitycardlayout.yml b/docs/docs-ref-autogen/excel_1_16/excel/excel.entitycardlayout.yml index 79647849b2..0980a175de 100644 --- a/docs/docs-ref-autogen/excel_1_16/excel/excel.entitycardlayout.yml +++ b/docs/docs-ref-autogen/excel_1_16/excel/excel.entitycardlayout.yml @@ -8,6 +8,71 @@ remarks: >- \[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-entity-attribution.yaml + + + function makeProductEntity(productID: number, productName: string, product?: + any) { + const entity: Excel.EntityCellValue = { + type: Excel.CellValueType.entity, + text: productName, + properties: { /* Excel.EntityPropertyType */ + "Product ID": { + type: Excel.CellValueType.string, + basicValue: productID.toString() || "" + }, + "Product Name": { + type: Excel.CellValueType.string, + basicValue: productName || "" + }, + "Quantity Per Unit": { + type: Excel.CellValueType.string, + basicValue: product.quantityPerUnit || "" + }, + // Add Unit Price as a formatted number. + "Unit Price": { + type: Excel.CellValueType.formattedNumber, + basicValue: product.unitPrice, + numberFormat: "$* #,##0.00" + } + }, + layouts: { /* Excel.EntityViewLayouts */ + card: { /* Excel.EntityCardLayout */ + title: { property: "Product Name" }, + sections: [ /* Excel.CardLayoutSection */ + { + layout: "List", + properties: ["Product ID"] + }, + { + layout: "List", + title: "Quantity and price", + collapsible: true, + collapsed: false, + properties: ["Quantity Per Unit", "Unit Price"] + } + ] + } + }, + provider: { + description: product.providerName, // Name of the data provider. Displays as a tooltip when hovering over the logo. Also displays as a fallback if the source address for the image is broken. + logoSourceAddress: product.sourceAddress, // Source URL of the logo to display. + logoTargetAddress: product.targetAddress // Destination URL that the logo navigates to when clicked. + } + }; + + return entity; + } + + ``` + isPreview: false isDeprecated: false type: interface 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 bc54a6eff6..b9afefd0e4 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 @@ -9,12 +9,79 @@ remarks: >- 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) + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-entity-attribution.yaml + + + function makeProductEntity(productID: number, productName: string, product?: + any) { + const entity: Excel.EntityCellValue = { + type: Excel.CellValueType.entity, + text: productName, + properties: { /* Excel.EntityPropertyType */ + "Product ID": { + type: Excel.CellValueType.string, + basicValue: productID.toString() || "" + }, + "Product Name": { + type: Excel.CellValueType.string, + basicValue: productName || "" + }, + "Quantity Per Unit": { + type: Excel.CellValueType.string, + basicValue: product.quantityPerUnit || "" + }, + // Add Unit Price as a formatted number. + "Unit Price": { + type: Excel.CellValueType.formattedNumber, + basicValue: product.unitPrice, + numberFormat: "$* #,##0.00" + } + }, + layouts: { /* Excel.EntityViewLayouts */ + card: { /* Excel.EntityCardLayout */ + title: { property: "Product Name" }, + sections: [ /* Excel.CardLayoutSection */ + { + layout: "List", + properties: ["Product ID"] + }, + { + layout: "List", + title: "Quantity and price", + collapsible: true, + collapsed: false, + properties: ["Quantity Per Unit", "Unit Price"] + } + ] + } + }, + provider: { + description: product.providerName, // Name of the data provider. Displays as a tooltip when hovering over the logo. Also displays as a fallback if the source address for the image is broken. + logoSourceAddress: product.sourceAddress, // Source URL of the logo to display. + logoTargetAddress: product.targetAddress // Destination URL that the logo navigates to when clicked. + } + }; + + return entity; + } + + ``` + isPreview: false isDeprecated: false syntax: export type EntityPropertyType = CellValueAndPropertyMetadata | CellValue; diff --git a/docs/docs-ref-autogen/excel_1_16/excel/excel.entityviewlayouts.yml b/docs/docs-ref-autogen/excel_1_16/excel/excel.entityviewlayouts.yml index 22c4101139..ed623b76d9 100644 --- a/docs/docs-ref-autogen/excel_1_16/excel/excel.entityviewlayouts.yml +++ b/docs/docs-ref-autogen/excel_1_16/excel/excel.entityviewlayouts.yml @@ -8,6 +8,71 @@ remarks: >- \[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-entity-attribution.yaml + + + function makeProductEntity(productID: number, productName: string, product?: + any) { + const entity: Excel.EntityCellValue = { + type: Excel.CellValueType.entity, + text: productName, + properties: { /* Excel.EntityPropertyType */ + "Product ID": { + type: Excel.CellValueType.string, + basicValue: productID.toString() || "" + }, + "Product Name": { + type: Excel.CellValueType.string, + basicValue: productName || "" + }, + "Quantity Per Unit": { + type: Excel.CellValueType.string, + basicValue: product.quantityPerUnit || "" + }, + // Add Unit Price as a formatted number. + "Unit Price": { + type: Excel.CellValueType.formattedNumber, + basicValue: product.unitPrice, + numberFormat: "$* #,##0.00" + } + }, + layouts: { /* Excel.EntityViewLayouts */ + card: { /* Excel.EntityCardLayout */ + title: { property: "Product Name" }, + sections: [ /* Excel.CardLayoutSection */ + { + layout: "List", + properties: ["Product ID"] + }, + { + layout: "List", + title: "Quantity and price", + collapsible: true, + collapsed: false, + properties: ["Quantity Per Unit", "Unit Price"] + } + ] + } + }, + provider: { + description: product.providerName, // Name of the data provider. Displays as a tooltip when hovering over the logo. Also displays as a fallback if the source address for the image is broken. + logoSourceAddress: product.sourceAddress, // Source URL of the logo to display. + logoTargetAddress: product.targetAddress // Destination URL that the logo navigates to when clicked. + } + }; + + return entity; + } + + ``` + isPreview: false isDeprecated: false type: interface 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 97e90f572d..9639b1363c 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 @@ -9,12 +9,79 @@ remarks: >- 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) + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-entity-attribution.yaml + + + function makeProductEntity(productID: number, productName: string, product?: + any) { + const entity: Excel.EntityCellValue = { + type: Excel.CellValueType.entity, + text: productName, + properties: { /* Excel.EntityPropertyType */ + "Product ID": { + type: Excel.CellValueType.string, + basicValue: productID.toString() || "" + }, + "Product Name": { + type: Excel.CellValueType.string, + basicValue: productName || "" + }, + "Quantity Per Unit": { + type: Excel.CellValueType.string, + basicValue: product.quantityPerUnit || "" + }, + // Add Unit Price as a formatted number. + "Unit Price": { + type: Excel.CellValueType.formattedNumber, + basicValue: product.unitPrice, + numberFormat: "$* #,##0.00" + } + }, + layouts: { /* Excel.EntityViewLayouts */ + card: { /* Excel.EntityCardLayout */ + title: { property: "Product Name" }, + sections: [ /* Excel.CardLayoutSection */ + { + layout: "List", + properties: ["Product ID"] + }, + { + layout: "List", + title: "Quantity and price", + collapsible: true, + collapsed: false, + properties: ["Quantity Per Unit", "Unit Price"] + } + ] + } + }, + provider: { + description: product.providerName, // Name of the data provider. Displays as a tooltip when hovering over the logo. Also displays as a fallback if the source address for the image is broken. + logoSourceAddress: product.sourceAddress, // Source URL of the logo to display. + logoTargetAddress: product.targetAddress // Destination URL that the logo navigates to when clicked. + } + }; + + return entity; + } + + ``` + isPreview: false isDeprecated: false syntax: >- diff --git a/docs/docs-ref-autogen/excel_1_17/excel/excel.cellborder.yml b/docs/docs-ref-autogen/excel_1_17/excel/excel.cellborder.yml index bc2f00c585..d0ccbdc739 100644 --- a/docs/docs-ref-autogen/excel_1_17/excel/excel.cellborder.yml +++ b/docs/docs-ref-autogen/excel_1_17/excel/excel.cellborder.yml @@ -13,6 +13,90 @@ remarks: >- \[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/cell-properties.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Creating the SettableCellProperties objects to use for the range. + // In your add-in, these should be created once, outside the function. + const topHeaderProps: Excel.SettableCellProperties = { + // The style property takes a string matching the name of an Excel style. + // Built-in style names are listed in the `BuiltInStyle` enum. + // Note that a style will overwrite any formatting, + // so do not use the format property with the style property. + style: "Heading1" + }; + + const headerProps: Excel.SettableCellProperties = { + // Any subproperties of format that are not set will not be changed when these cell properties are set. + format: { + fill: { + color: "Blue" + }, + font: { + color: "White", + bold: true + } + } + }; + + const nonApplicableProps: Excel.SettableCellProperties = { + format: { + fill: { + pattern: Excel.FillPattern.gray25 + }, + font: { + color: "Gray", + italic: true + } + } + }; + + const matchupScoreProps: Excel.SettableCellProperties = { + format: { + borders: { + bottom: { + style: Excel.BorderLineStyle.continuous + }, + left: { + style: Excel.BorderLineStyle.continuous + }, + right: { + style: Excel.BorderLineStyle.continuous + }, + top: { + style: Excel.BorderLineStyle.continuous + } + } + } + }; + + const range = sheet.getRange("A1:E5"); + + // You can use empty JSON objects to avoid changing a cell's properties. + range.setCellProperties([ + [topHeaderProps, {}, {}, {}, {}], + [{}, {}, headerProps, headerProps, headerProps], + [{}, headerProps, nonApplicableProps, matchupScoreProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, nonApplicableProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, matchupScoreProps, nonApplicableProps] + ]); + + sheet.getUsedRange().format.autofitColumns(); + await context.sync(); + }); + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/excel_1_17/excel/excel.datavalidationerroralert.yml b/docs/docs-ref-autogen/excel_1_17/excel/excel.datavalidationerroralert.yml index f5dfde1895..5bd9a15eb5 100644 --- a/docs/docs-ref-autogen/excel_1_17/excel/excel.datavalidationerroralert.yml +++ b/docs/docs-ref-autogen/excel_1_17/excel/excel.datavalidationerroralert.yml @@ -8,6 +8,50 @@ remarks: >- \[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/22-data-validation/data-validation.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Decision"); + const rankingRange = sheet.tables.getItem("NameOptionsTable").columns.getItem("Ranking").getDataBodyRange(); + + // When you are developing, it is a good practice to + // clear the dataValidation object with each run of your code. + rankingRange.dataValidation.clear(); + + let greaterThanZeroRule = { + wholeNumber: { + formula1: 0, + operator: Excel.DataValidationOperator.greaterThan + } + }; + rankingRange.dataValidation.rule = greaterThanZeroRule; + + rankingRange.dataValidation.prompt = { + message: "Please enter a positive number.", + showPrompt: true, + title: "Positive numbers only." + }; + + rankingRange.dataValidation.errorAlert = { + message: "Sorry, only positive numbers are allowed", + showAlert: true, + style: "Stop", + title: "Negative Number Entered" + }; + + await context.sync(); + }); + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/excel_1_17/excel/excel.entitycardlayout.yml b/docs/docs-ref-autogen/excel_1_17/excel/excel.entitycardlayout.yml index 79647849b2..0980a175de 100644 --- a/docs/docs-ref-autogen/excel_1_17/excel/excel.entitycardlayout.yml +++ b/docs/docs-ref-autogen/excel_1_17/excel/excel.entitycardlayout.yml @@ -8,6 +8,71 @@ remarks: >- \[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-entity-attribution.yaml + + + function makeProductEntity(productID: number, productName: string, product?: + any) { + const entity: Excel.EntityCellValue = { + type: Excel.CellValueType.entity, + text: productName, + properties: { /* Excel.EntityPropertyType */ + "Product ID": { + type: Excel.CellValueType.string, + basicValue: productID.toString() || "" + }, + "Product Name": { + type: Excel.CellValueType.string, + basicValue: productName || "" + }, + "Quantity Per Unit": { + type: Excel.CellValueType.string, + basicValue: product.quantityPerUnit || "" + }, + // Add Unit Price as a formatted number. + "Unit Price": { + type: Excel.CellValueType.formattedNumber, + basicValue: product.unitPrice, + numberFormat: "$* #,##0.00" + } + }, + layouts: { /* Excel.EntityViewLayouts */ + card: { /* Excel.EntityCardLayout */ + title: { property: "Product Name" }, + sections: [ /* Excel.CardLayoutSection */ + { + layout: "List", + properties: ["Product ID"] + }, + { + layout: "List", + title: "Quantity and price", + collapsible: true, + collapsed: false, + properties: ["Quantity Per Unit", "Unit Price"] + } + ] + } + }, + provider: { + description: product.providerName, // Name of the data provider. Displays as a tooltip when hovering over the logo. Also displays as a fallback if the source address for the image is broken. + logoSourceAddress: product.sourceAddress, // Source URL of the logo to display. + logoTargetAddress: product.targetAddress // Destination URL that the logo navigates to when clicked. + } + }; + + return entity; + } + + ``` + isPreview: false isDeprecated: false type: interface 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 bc54a6eff6..b9afefd0e4 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 @@ -9,12 +9,79 @@ remarks: >- 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) + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-entity-attribution.yaml + + + function makeProductEntity(productID: number, productName: string, product?: + any) { + const entity: Excel.EntityCellValue = { + type: Excel.CellValueType.entity, + text: productName, + properties: { /* Excel.EntityPropertyType */ + "Product ID": { + type: Excel.CellValueType.string, + basicValue: productID.toString() || "" + }, + "Product Name": { + type: Excel.CellValueType.string, + basicValue: productName || "" + }, + "Quantity Per Unit": { + type: Excel.CellValueType.string, + basicValue: product.quantityPerUnit || "" + }, + // Add Unit Price as a formatted number. + "Unit Price": { + type: Excel.CellValueType.formattedNumber, + basicValue: product.unitPrice, + numberFormat: "$* #,##0.00" + } + }, + layouts: { /* Excel.EntityViewLayouts */ + card: { /* Excel.EntityCardLayout */ + title: { property: "Product Name" }, + sections: [ /* Excel.CardLayoutSection */ + { + layout: "List", + properties: ["Product ID"] + }, + { + layout: "List", + title: "Quantity and price", + collapsible: true, + collapsed: false, + properties: ["Quantity Per Unit", "Unit Price"] + } + ] + } + }, + provider: { + description: product.providerName, // Name of the data provider. Displays as a tooltip when hovering over the logo. Also displays as a fallback if the source address for the image is broken. + logoSourceAddress: product.sourceAddress, // Source URL of the logo to display. + logoTargetAddress: product.targetAddress // Destination URL that the logo navigates to when clicked. + } + }; + + return entity; + } + + ``` + isPreview: false isDeprecated: false syntax: export type EntityPropertyType = CellValueAndPropertyMetadata | CellValue; diff --git a/docs/docs-ref-autogen/excel_1_17/excel/excel.entityviewlayouts.yml b/docs/docs-ref-autogen/excel_1_17/excel/excel.entityviewlayouts.yml index 22c4101139..ed623b76d9 100644 --- a/docs/docs-ref-autogen/excel_1_17/excel/excel.entityviewlayouts.yml +++ b/docs/docs-ref-autogen/excel_1_17/excel/excel.entityviewlayouts.yml @@ -8,6 +8,71 @@ remarks: >- \[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-entity-attribution.yaml + + + function makeProductEntity(productID: number, productName: string, product?: + any) { + const entity: Excel.EntityCellValue = { + type: Excel.CellValueType.entity, + text: productName, + properties: { /* Excel.EntityPropertyType */ + "Product ID": { + type: Excel.CellValueType.string, + basicValue: productID.toString() || "" + }, + "Product Name": { + type: Excel.CellValueType.string, + basicValue: productName || "" + }, + "Quantity Per Unit": { + type: Excel.CellValueType.string, + basicValue: product.quantityPerUnit || "" + }, + // Add Unit Price as a formatted number. + "Unit Price": { + type: Excel.CellValueType.formattedNumber, + basicValue: product.unitPrice, + numberFormat: "$* #,##0.00" + } + }, + layouts: { /* Excel.EntityViewLayouts */ + card: { /* Excel.EntityCardLayout */ + title: { property: "Product Name" }, + sections: [ /* Excel.CardLayoutSection */ + { + layout: "List", + properties: ["Product ID"] + }, + { + layout: "List", + title: "Quantity and price", + collapsible: true, + collapsed: false, + properties: ["Quantity Per Unit", "Unit Price"] + } + ] + } + }, + provider: { + description: product.providerName, // Name of the data provider. Displays as a tooltip when hovering over the logo. Also displays as a fallback if the source address for the image is broken. + logoSourceAddress: product.sourceAddress, // Source URL of the logo to display. + logoTargetAddress: product.targetAddress // Destination URL that the logo navigates to when clicked. + } + }; + + return entity; + } + + ``` + isPreview: false isDeprecated: false type: interface 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 97e90f572d..9639b1363c 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 @@ -9,12 +9,79 @@ remarks: >- 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) + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-entity-attribution.yaml + + + function makeProductEntity(productID: number, productName: string, product?: + any) { + const entity: Excel.EntityCellValue = { + type: Excel.CellValueType.entity, + text: productName, + properties: { /* Excel.EntityPropertyType */ + "Product ID": { + type: Excel.CellValueType.string, + basicValue: productID.toString() || "" + }, + "Product Name": { + type: Excel.CellValueType.string, + basicValue: productName || "" + }, + "Quantity Per Unit": { + type: Excel.CellValueType.string, + basicValue: product.quantityPerUnit || "" + }, + // Add Unit Price as a formatted number. + "Unit Price": { + type: Excel.CellValueType.formattedNumber, + basicValue: product.unitPrice, + numberFormat: "$* #,##0.00" + } + }, + layouts: { /* Excel.EntityViewLayouts */ + card: { /* Excel.EntityCardLayout */ + title: { property: "Product Name" }, + sections: [ /* Excel.CardLayoutSection */ + { + layout: "List", + properties: ["Product ID"] + }, + { + layout: "List", + title: "Quantity and price", + collapsible: true, + collapsed: false, + properties: ["Quantity Per Unit", "Unit Price"] + } + ] + } + }, + provider: { + description: product.providerName, // Name of the data provider. Displays as a tooltip when hovering over the logo. Also displays as a fallback if the source address for the image is broken. + logoSourceAddress: product.sourceAddress, // Source URL of the logo to display. + logoTargetAddress: product.targetAddress // Destination URL that the logo navigates to when clicked. + } + }; + + return entity; + } + + ``` + isPreview: false isDeprecated: false syntax: >- diff --git a/docs/docs-ref-autogen/excel_1_18/excel/excel.cellborder.yml b/docs/docs-ref-autogen/excel_1_18/excel/excel.cellborder.yml index bc2f00c585..d0ccbdc739 100644 --- a/docs/docs-ref-autogen/excel_1_18/excel/excel.cellborder.yml +++ b/docs/docs-ref-autogen/excel_1_18/excel/excel.cellborder.yml @@ -13,6 +13,90 @@ remarks: >- \[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/cell-properties.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Creating the SettableCellProperties objects to use for the range. + // In your add-in, these should be created once, outside the function. + const topHeaderProps: Excel.SettableCellProperties = { + // The style property takes a string matching the name of an Excel style. + // Built-in style names are listed in the `BuiltInStyle` enum. + // Note that a style will overwrite any formatting, + // so do not use the format property with the style property. + style: "Heading1" + }; + + const headerProps: Excel.SettableCellProperties = { + // Any subproperties of format that are not set will not be changed when these cell properties are set. + format: { + fill: { + color: "Blue" + }, + font: { + color: "White", + bold: true + } + } + }; + + const nonApplicableProps: Excel.SettableCellProperties = { + format: { + fill: { + pattern: Excel.FillPattern.gray25 + }, + font: { + color: "Gray", + italic: true + } + } + }; + + const matchupScoreProps: Excel.SettableCellProperties = { + format: { + borders: { + bottom: { + style: Excel.BorderLineStyle.continuous + }, + left: { + style: Excel.BorderLineStyle.continuous + }, + right: { + style: Excel.BorderLineStyle.continuous + }, + top: { + style: Excel.BorderLineStyle.continuous + } + } + } + }; + + const range = sheet.getRange("A1:E5"); + + // You can use empty JSON objects to avoid changing a cell's properties. + range.setCellProperties([ + [topHeaderProps, {}, {}, {}, {}], + [{}, {}, headerProps, headerProps, headerProps], + [{}, headerProps, nonApplicableProps, matchupScoreProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, nonApplicableProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, matchupScoreProps, nonApplicableProps] + ]); + + sheet.getUsedRange().format.autofitColumns(); + await context.sync(); + }); + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/excel_1_18/excel/excel.datavalidationerroralert.yml b/docs/docs-ref-autogen/excel_1_18/excel/excel.datavalidationerroralert.yml index f5dfde1895..5bd9a15eb5 100644 --- a/docs/docs-ref-autogen/excel_1_18/excel/excel.datavalidationerroralert.yml +++ b/docs/docs-ref-autogen/excel_1_18/excel/excel.datavalidationerroralert.yml @@ -8,6 +8,50 @@ remarks: >- \[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/22-data-validation/data-validation.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Decision"); + const rankingRange = sheet.tables.getItem("NameOptionsTable").columns.getItem("Ranking").getDataBodyRange(); + + // When you are developing, it is a good practice to + // clear the dataValidation object with each run of your code. + rankingRange.dataValidation.clear(); + + let greaterThanZeroRule = { + wholeNumber: { + formula1: 0, + operator: Excel.DataValidationOperator.greaterThan + } + }; + rankingRange.dataValidation.rule = greaterThanZeroRule; + + rankingRange.dataValidation.prompt = { + message: "Please enter a positive number.", + showPrompt: true, + title: "Positive numbers only." + }; + + rankingRange.dataValidation.errorAlert = { + message: "Sorry, only positive numbers are allowed", + showAlert: true, + style: "Stop", + title: "Negative Number Entered" + }; + + await context.sync(); + }); + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/excel_1_18/excel/excel.entitycardlayout.yml b/docs/docs-ref-autogen/excel_1_18/excel/excel.entitycardlayout.yml index 79647849b2..0980a175de 100644 --- a/docs/docs-ref-autogen/excel_1_18/excel/excel.entitycardlayout.yml +++ b/docs/docs-ref-autogen/excel_1_18/excel/excel.entitycardlayout.yml @@ -8,6 +8,71 @@ remarks: >- \[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-entity-attribution.yaml + + + function makeProductEntity(productID: number, productName: string, product?: + any) { + const entity: Excel.EntityCellValue = { + type: Excel.CellValueType.entity, + text: productName, + properties: { /* Excel.EntityPropertyType */ + "Product ID": { + type: Excel.CellValueType.string, + basicValue: productID.toString() || "" + }, + "Product Name": { + type: Excel.CellValueType.string, + basicValue: productName || "" + }, + "Quantity Per Unit": { + type: Excel.CellValueType.string, + basicValue: product.quantityPerUnit || "" + }, + // Add Unit Price as a formatted number. + "Unit Price": { + type: Excel.CellValueType.formattedNumber, + basicValue: product.unitPrice, + numberFormat: "$* #,##0.00" + } + }, + layouts: { /* Excel.EntityViewLayouts */ + card: { /* Excel.EntityCardLayout */ + title: { property: "Product Name" }, + sections: [ /* Excel.CardLayoutSection */ + { + layout: "List", + properties: ["Product ID"] + }, + { + layout: "List", + title: "Quantity and price", + collapsible: true, + collapsed: false, + properties: ["Quantity Per Unit", "Unit Price"] + } + ] + } + }, + provider: { + description: product.providerName, // Name of the data provider. Displays as a tooltip when hovering over the logo. Also displays as a fallback if the source address for the image is broken. + logoSourceAddress: product.sourceAddress, // Source URL of the logo to display. + logoTargetAddress: product.targetAddress // Destination URL that the logo navigates to when clicked. + } + }; + + return entity; + } + + ``` + isPreview: false isDeprecated: false type: interface 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 bc54a6eff6..b9afefd0e4 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 @@ -9,12 +9,79 @@ remarks: >- 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) + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-entity-attribution.yaml + + + function makeProductEntity(productID: number, productName: string, product?: + any) { + const entity: Excel.EntityCellValue = { + type: Excel.CellValueType.entity, + text: productName, + properties: { /* Excel.EntityPropertyType */ + "Product ID": { + type: Excel.CellValueType.string, + basicValue: productID.toString() || "" + }, + "Product Name": { + type: Excel.CellValueType.string, + basicValue: productName || "" + }, + "Quantity Per Unit": { + type: Excel.CellValueType.string, + basicValue: product.quantityPerUnit || "" + }, + // Add Unit Price as a formatted number. + "Unit Price": { + type: Excel.CellValueType.formattedNumber, + basicValue: product.unitPrice, + numberFormat: "$* #,##0.00" + } + }, + layouts: { /* Excel.EntityViewLayouts */ + card: { /* Excel.EntityCardLayout */ + title: { property: "Product Name" }, + sections: [ /* Excel.CardLayoutSection */ + { + layout: "List", + properties: ["Product ID"] + }, + { + layout: "List", + title: "Quantity and price", + collapsible: true, + collapsed: false, + properties: ["Quantity Per Unit", "Unit Price"] + } + ] + } + }, + provider: { + description: product.providerName, // Name of the data provider. Displays as a tooltip when hovering over the logo. Also displays as a fallback if the source address for the image is broken. + logoSourceAddress: product.sourceAddress, // Source URL of the logo to display. + logoTargetAddress: product.targetAddress // Destination URL that the logo navigates to when clicked. + } + }; + + return entity; + } + + ``` + isPreview: false isDeprecated: false syntax: export type EntityPropertyType = CellValueAndPropertyMetadata | CellValue; diff --git a/docs/docs-ref-autogen/excel_1_18/excel/excel.entityviewlayouts.yml b/docs/docs-ref-autogen/excel_1_18/excel/excel.entityviewlayouts.yml index 22c4101139..ed623b76d9 100644 --- a/docs/docs-ref-autogen/excel_1_18/excel/excel.entityviewlayouts.yml +++ b/docs/docs-ref-autogen/excel_1_18/excel/excel.entityviewlayouts.yml @@ -8,6 +8,71 @@ remarks: >- \[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-entity-attribution.yaml + + + function makeProductEntity(productID: number, productName: string, product?: + any) { + const entity: Excel.EntityCellValue = { + type: Excel.CellValueType.entity, + text: productName, + properties: { /* Excel.EntityPropertyType */ + "Product ID": { + type: Excel.CellValueType.string, + basicValue: productID.toString() || "" + }, + "Product Name": { + type: Excel.CellValueType.string, + basicValue: productName || "" + }, + "Quantity Per Unit": { + type: Excel.CellValueType.string, + basicValue: product.quantityPerUnit || "" + }, + // Add Unit Price as a formatted number. + "Unit Price": { + type: Excel.CellValueType.formattedNumber, + basicValue: product.unitPrice, + numberFormat: "$* #,##0.00" + } + }, + layouts: { /* Excel.EntityViewLayouts */ + card: { /* Excel.EntityCardLayout */ + title: { property: "Product Name" }, + sections: [ /* Excel.CardLayoutSection */ + { + layout: "List", + properties: ["Product ID"] + }, + { + layout: "List", + title: "Quantity and price", + collapsible: true, + collapsed: false, + properties: ["Quantity Per Unit", "Unit Price"] + } + ] + } + }, + provider: { + description: product.providerName, // Name of the data provider. Displays as a tooltip when hovering over the logo. Also displays as a fallback if the source address for the image is broken. + logoSourceAddress: product.sourceAddress, // Source URL of the logo to display. + logoTargetAddress: product.targetAddress // Destination URL that the logo navigates to when clicked. + } + }; + + return entity; + } + + ``` + isPreview: false isDeprecated: false type: interface 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 cca1b0c56e..c8bd52c201 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 @@ -9,6 +9,8 @@ remarks: >- 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + Learn more about the types in this type alias through the following links. @@ -16,6 +18,71 @@ remarks: >- [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection), [Excel.CardLayoutTwoColumnSection](/javascript/api/excel/excel.cardlayouttwocolumnsection) + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-entity-attribution.yaml + + + function makeProductEntity(productID: number, productName: string, product?: + any) { + const entity: Excel.EntityCellValue = { + type: Excel.CellValueType.entity, + text: productName, + properties: { /* Excel.EntityPropertyType */ + "Product ID": { + type: Excel.CellValueType.string, + basicValue: productID.toString() || "" + }, + "Product Name": { + type: Excel.CellValueType.string, + basicValue: productName || "" + }, + "Quantity Per Unit": { + type: Excel.CellValueType.string, + basicValue: product.quantityPerUnit || "" + }, + // Add Unit Price as a formatted number. + "Unit Price": { + type: Excel.CellValueType.formattedNumber, + basicValue: product.unitPrice, + numberFormat: "$* #,##0.00" + } + }, + layouts: { /* Excel.EntityViewLayouts */ + card: { /* Excel.EntityCardLayout */ + title: { property: "Product Name" }, + sections: [ /* Excel.CardLayoutSection */ + { + layout: "List", + properties: ["Product ID"] + }, + { + layout: "List", + title: "Quantity and price", + collapsible: true, + collapsed: false, + properties: ["Quantity Per Unit", "Unit Price"] + } + ] + } + }, + provider: { + description: product.providerName, // Name of the data provider. Displays as a tooltip when hovering over the logo. Also displays as a fallback if the source address for the image is broken. + logoSourceAddress: product.sourceAddress, // Source URL of the logo to display. + logoTargetAddress: product.targetAddress // Destination URL that the logo navigates to when clicked. + } + }; + + return entity; + } + + ``` + isPreview: false isDeprecated: false syntax: >- diff --git a/docs/docs-ref-autogen/excel_1_19/excel/excel.cellborder.yml b/docs/docs-ref-autogen/excel_1_19/excel/excel.cellborder.yml index bc2f00c585..d0ccbdc739 100644 --- a/docs/docs-ref-autogen/excel_1_19/excel/excel.cellborder.yml +++ b/docs/docs-ref-autogen/excel_1_19/excel/excel.cellborder.yml @@ -13,6 +13,90 @@ remarks: >- \[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/cell-properties.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Creating the SettableCellProperties objects to use for the range. + // In your add-in, these should be created once, outside the function. + const topHeaderProps: Excel.SettableCellProperties = { + // The style property takes a string matching the name of an Excel style. + // Built-in style names are listed in the `BuiltInStyle` enum. + // Note that a style will overwrite any formatting, + // so do not use the format property with the style property. + style: "Heading1" + }; + + const headerProps: Excel.SettableCellProperties = { + // Any subproperties of format that are not set will not be changed when these cell properties are set. + format: { + fill: { + color: "Blue" + }, + font: { + color: "White", + bold: true + } + } + }; + + const nonApplicableProps: Excel.SettableCellProperties = { + format: { + fill: { + pattern: Excel.FillPattern.gray25 + }, + font: { + color: "Gray", + italic: true + } + } + }; + + const matchupScoreProps: Excel.SettableCellProperties = { + format: { + borders: { + bottom: { + style: Excel.BorderLineStyle.continuous + }, + left: { + style: Excel.BorderLineStyle.continuous + }, + right: { + style: Excel.BorderLineStyle.continuous + }, + top: { + style: Excel.BorderLineStyle.continuous + } + } + } + }; + + const range = sheet.getRange("A1:E5"); + + // You can use empty JSON objects to avoid changing a cell's properties. + range.setCellProperties([ + [topHeaderProps, {}, {}, {}, {}], + [{}, {}, headerProps, headerProps, headerProps], + [{}, headerProps, nonApplicableProps, matchupScoreProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, nonApplicableProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, matchupScoreProps, nonApplicableProps] + ]); + + sheet.getUsedRange().format.autofitColumns(); + await context.sync(); + }); + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/excel_1_19/excel/excel.datavalidationerroralert.yml b/docs/docs-ref-autogen/excel_1_19/excel/excel.datavalidationerroralert.yml index f5dfde1895..5bd9a15eb5 100644 --- a/docs/docs-ref-autogen/excel_1_19/excel/excel.datavalidationerroralert.yml +++ b/docs/docs-ref-autogen/excel_1_19/excel/excel.datavalidationerroralert.yml @@ -8,6 +8,50 @@ remarks: >- \[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/22-data-validation/data-validation.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Decision"); + const rankingRange = sheet.tables.getItem("NameOptionsTable").columns.getItem("Ranking").getDataBodyRange(); + + // When you are developing, it is a good practice to + // clear the dataValidation object with each run of your code. + rankingRange.dataValidation.clear(); + + let greaterThanZeroRule = { + wholeNumber: { + formula1: 0, + operator: Excel.DataValidationOperator.greaterThan + } + }; + rankingRange.dataValidation.rule = greaterThanZeroRule; + + rankingRange.dataValidation.prompt = { + message: "Please enter a positive number.", + showPrompt: true, + title: "Positive numbers only." + }; + + rankingRange.dataValidation.errorAlert = { + message: "Sorry, only positive numbers are allowed", + showAlert: true, + style: "Stop", + title: "Negative Number Entered" + }; + + await context.sync(); + }); + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/excel_1_19/excel/excel.entitycardlayout.yml b/docs/docs-ref-autogen/excel_1_19/excel/excel.entitycardlayout.yml index 79647849b2..0980a175de 100644 --- a/docs/docs-ref-autogen/excel_1_19/excel/excel.entitycardlayout.yml +++ b/docs/docs-ref-autogen/excel_1_19/excel/excel.entitycardlayout.yml @@ -8,6 +8,71 @@ remarks: >- \[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-entity-attribution.yaml + + + function makeProductEntity(productID: number, productName: string, product?: + any) { + const entity: Excel.EntityCellValue = { + type: Excel.CellValueType.entity, + text: productName, + properties: { /* Excel.EntityPropertyType */ + "Product ID": { + type: Excel.CellValueType.string, + basicValue: productID.toString() || "" + }, + "Product Name": { + type: Excel.CellValueType.string, + basicValue: productName || "" + }, + "Quantity Per Unit": { + type: Excel.CellValueType.string, + basicValue: product.quantityPerUnit || "" + }, + // Add Unit Price as a formatted number. + "Unit Price": { + type: Excel.CellValueType.formattedNumber, + basicValue: product.unitPrice, + numberFormat: "$* #,##0.00" + } + }, + layouts: { /* Excel.EntityViewLayouts */ + card: { /* Excel.EntityCardLayout */ + title: { property: "Product Name" }, + sections: [ /* Excel.CardLayoutSection */ + { + layout: "List", + properties: ["Product ID"] + }, + { + layout: "List", + title: "Quantity and price", + collapsible: true, + collapsed: false, + properties: ["Quantity Per Unit", "Unit Price"] + } + ] + } + }, + provider: { + description: product.providerName, // Name of the data provider. Displays as a tooltip when hovering over the logo. Also displays as a fallback if the source address for the image is broken. + logoSourceAddress: product.sourceAddress, // Source URL of the logo to display. + logoTargetAddress: product.targetAddress // Destination URL that the logo navigates to when clicked. + } + }; + + return entity; + } + + ``` + isPreview: false isDeprecated: false type: interface 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 bc54a6eff6..b9afefd0e4 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 @@ -9,12 +9,79 @@ remarks: >- 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) + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-entity-attribution.yaml + + + function makeProductEntity(productID: number, productName: string, product?: + any) { + const entity: Excel.EntityCellValue = { + type: Excel.CellValueType.entity, + text: productName, + properties: { /* Excel.EntityPropertyType */ + "Product ID": { + type: Excel.CellValueType.string, + basicValue: productID.toString() || "" + }, + "Product Name": { + type: Excel.CellValueType.string, + basicValue: productName || "" + }, + "Quantity Per Unit": { + type: Excel.CellValueType.string, + basicValue: product.quantityPerUnit || "" + }, + // Add Unit Price as a formatted number. + "Unit Price": { + type: Excel.CellValueType.formattedNumber, + basicValue: product.unitPrice, + numberFormat: "$* #,##0.00" + } + }, + layouts: { /* Excel.EntityViewLayouts */ + card: { /* Excel.EntityCardLayout */ + title: { property: "Product Name" }, + sections: [ /* Excel.CardLayoutSection */ + { + layout: "List", + properties: ["Product ID"] + }, + { + layout: "List", + title: "Quantity and price", + collapsible: true, + collapsed: false, + properties: ["Quantity Per Unit", "Unit Price"] + } + ] + } + }, + provider: { + description: product.providerName, // Name of the data provider. Displays as a tooltip when hovering over the logo. Also displays as a fallback if the source address for the image is broken. + logoSourceAddress: product.sourceAddress, // Source URL of the logo to display. + logoTargetAddress: product.targetAddress // Destination URL that the logo navigates to when clicked. + } + }; + + return entity; + } + + ``` + isPreview: false isDeprecated: false syntax: export type EntityPropertyType = CellValueAndPropertyMetadata | CellValue; diff --git a/docs/docs-ref-autogen/excel_1_19/excel/excel.entityviewlayouts.yml b/docs/docs-ref-autogen/excel_1_19/excel/excel.entityviewlayouts.yml index 22c4101139..ed623b76d9 100644 --- a/docs/docs-ref-autogen/excel_1_19/excel/excel.entityviewlayouts.yml +++ b/docs/docs-ref-autogen/excel_1_19/excel/excel.entityviewlayouts.yml @@ -8,6 +8,71 @@ remarks: >- \[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-entity-attribution.yaml + + + function makeProductEntity(productID: number, productName: string, product?: + any) { + const entity: Excel.EntityCellValue = { + type: Excel.CellValueType.entity, + text: productName, + properties: { /* Excel.EntityPropertyType */ + "Product ID": { + type: Excel.CellValueType.string, + basicValue: productID.toString() || "" + }, + "Product Name": { + type: Excel.CellValueType.string, + basicValue: productName || "" + }, + "Quantity Per Unit": { + type: Excel.CellValueType.string, + basicValue: product.quantityPerUnit || "" + }, + // Add Unit Price as a formatted number. + "Unit Price": { + type: Excel.CellValueType.formattedNumber, + basicValue: product.unitPrice, + numberFormat: "$* #,##0.00" + } + }, + layouts: { /* Excel.EntityViewLayouts */ + card: { /* Excel.EntityCardLayout */ + title: { property: "Product Name" }, + sections: [ /* Excel.CardLayoutSection */ + { + layout: "List", + properties: ["Product ID"] + }, + { + layout: "List", + title: "Quantity and price", + collapsible: true, + collapsed: false, + properties: ["Quantity Per Unit", "Unit Price"] + } + ] + } + }, + provider: { + description: product.providerName, // Name of the data provider. Displays as a tooltip when hovering over the logo. Also displays as a fallback if the source address for the image is broken. + logoSourceAddress: product.sourceAddress, // Source URL of the logo to display. + logoTargetAddress: product.targetAddress // Destination URL that the logo navigates to when clicked. + } + }; + + return entity; + } + + ``` + isPreview: false isDeprecated: false type: interface 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 cca1b0c56e..c8bd52c201 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 @@ -9,6 +9,8 @@ remarks: >- 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + Learn more about the types in this type alias through the following links. @@ -16,6 +18,71 @@ remarks: >- [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection), [Excel.CardLayoutTwoColumnSection](/javascript/api/excel/excel.cardlayouttwocolumnsection) + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-entity-attribution.yaml + + + function makeProductEntity(productID: number, productName: string, product?: + any) { + const entity: Excel.EntityCellValue = { + type: Excel.CellValueType.entity, + text: productName, + properties: { /* Excel.EntityPropertyType */ + "Product ID": { + type: Excel.CellValueType.string, + basicValue: productID.toString() || "" + }, + "Product Name": { + type: Excel.CellValueType.string, + basicValue: productName || "" + }, + "Quantity Per Unit": { + type: Excel.CellValueType.string, + basicValue: product.quantityPerUnit || "" + }, + // Add Unit Price as a formatted number. + "Unit Price": { + type: Excel.CellValueType.formattedNumber, + basicValue: product.unitPrice, + numberFormat: "$* #,##0.00" + } + }, + layouts: { /* Excel.EntityViewLayouts */ + card: { /* Excel.EntityCardLayout */ + title: { property: "Product Name" }, + sections: [ /* Excel.CardLayoutSection */ + { + layout: "List", + properties: ["Product ID"] + }, + { + layout: "List", + title: "Quantity and price", + collapsible: true, + collapsed: false, + properties: ["Quantity Per Unit", "Unit Price"] + } + ] + } + }, + provider: { + description: product.providerName, // Name of the data provider. Displays as a tooltip when hovering over the logo. Also displays as a fallback if the source address for the image is broken. + logoSourceAddress: product.sourceAddress, // Source URL of the logo to display. + logoTargetAddress: product.targetAddress // Destination URL that the logo navigates to when clicked. + } + }; + + return entity; + } + + ``` + isPreview: false isDeprecated: false syntax: >- diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.cellborder.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellborder.yml index bc2f00c585..d0ccbdc739 100644 --- a/docs/docs-ref-autogen/excel_1_20/excel/excel.cellborder.yml +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.cellborder.yml @@ -13,6 +13,90 @@ remarks: >- \[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/cell-properties.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Creating the SettableCellProperties objects to use for the range. + // In your add-in, these should be created once, outside the function. + const topHeaderProps: Excel.SettableCellProperties = { + // The style property takes a string matching the name of an Excel style. + // Built-in style names are listed in the `BuiltInStyle` enum. + // Note that a style will overwrite any formatting, + // so do not use the format property with the style property. + style: "Heading1" + }; + + const headerProps: Excel.SettableCellProperties = { + // Any subproperties of format that are not set will not be changed when these cell properties are set. + format: { + fill: { + color: "Blue" + }, + font: { + color: "White", + bold: true + } + } + }; + + const nonApplicableProps: Excel.SettableCellProperties = { + format: { + fill: { + pattern: Excel.FillPattern.gray25 + }, + font: { + color: "Gray", + italic: true + } + } + }; + + const matchupScoreProps: Excel.SettableCellProperties = { + format: { + borders: { + bottom: { + style: Excel.BorderLineStyle.continuous + }, + left: { + style: Excel.BorderLineStyle.continuous + }, + right: { + style: Excel.BorderLineStyle.continuous + }, + top: { + style: Excel.BorderLineStyle.continuous + } + } + } + }; + + const range = sheet.getRange("A1:E5"); + + // You can use empty JSON objects to avoid changing a cell's properties. + range.setCellProperties([ + [topHeaderProps, {}, {}, {}, {}], + [{}, {}, headerProps, headerProps, headerProps], + [{}, headerProps, nonApplicableProps, matchupScoreProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, nonApplicableProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, matchupScoreProps, nonApplicableProps] + ]); + + sheet.getUsedRange().format.autofitColumns(); + await context.sync(); + }); + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.datavalidationerroralert.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.datavalidationerroralert.yml index f5dfde1895..5bd9a15eb5 100644 --- a/docs/docs-ref-autogen/excel_1_20/excel/excel.datavalidationerroralert.yml +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.datavalidationerroralert.yml @@ -8,6 +8,50 @@ remarks: >- \[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/22-data-validation/data-validation.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Decision"); + const rankingRange = sheet.tables.getItem("NameOptionsTable").columns.getItem("Ranking").getDataBodyRange(); + + // When you are developing, it is a good practice to + // clear the dataValidation object with each run of your code. + rankingRange.dataValidation.clear(); + + let greaterThanZeroRule = { + wholeNumber: { + formula1: 0, + operator: Excel.DataValidationOperator.greaterThan + } + }; + rankingRange.dataValidation.rule = greaterThanZeroRule; + + rankingRange.dataValidation.prompt = { + message: "Please enter a positive number.", + showPrompt: true, + title: "Positive numbers only." + }; + + rankingRange.dataValidation.errorAlert = { + message: "Sorry, only positive numbers are allowed", + showAlert: true, + style: "Stop", + title: "Negative Number Entered" + }; + + await context.sync(); + }); + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.entitycardlayout.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.entitycardlayout.yml index 79647849b2..0980a175de 100644 --- a/docs/docs-ref-autogen/excel_1_20/excel/excel.entitycardlayout.yml +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.entitycardlayout.yml @@ -8,6 +8,71 @@ remarks: >- \[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-entity-attribution.yaml + + + function makeProductEntity(productID: number, productName: string, product?: + any) { + const entity: Excel.EntityCellValue = { + type: Excel.CellValueType.entity, + text: productName, + properties: { /* Excel.EntityPropertyType */ + "Product ID": { + type: Excel.CellValueType.string, + basicValue: productID.toString() || "" + }, + "Product Name": { + type: Excel.CellValueType.string, + basicValue: productName || "" + }, + "Quantity Per Unit": { + type: Excel.CellValueType.string, + basicValue: product.quantityPerUnit || "" + }, + // Add Unit Price as a formatted number. + "Unit Price": { + type: Excel.CellValueType.formattedNumber, + basicValue: product.unitPrice, + numberFormat: "$* #,##0.00" + } + }, + layouts: { /* Excel.EntityViewLayouts */ + card: { /* Excel.EntityCardLayout */ + title: { property: "Product Name" }, + sections: [ /* Excel.CardLayoutSection */ + { + layout: "List", + properties: ["Product ID"] + }, + { + layout: "List", + title: "Quantity and price", + collapsible: true, + collapsed: false, + properties: ["Quantity Per Unit", "Unit Price"] + } + ] + } + }, + provider: { + description: product.providerName, // Name of the data provider. Displays as a tooltip when hovering over the logo. Also displays as a fallback if the source address for the image is broken. + logoSourceAddress: product.sourceAddress, // Source URL of the logo to display. + logoTargetAddress: product.targetAddress // Destination URL that the logo navigates to when clicked. + } + }; + + return entity; + } + + ``` + isPreview: false isDeprecated: false type: interface 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 bc54a6eff6..b9afefd0e4 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 @@ -9,12 +9,79 @@ remarks: >- 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) + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-entity-attribution.yaml + + + function makeProductEntity(productID: number, productName: string, product?: + any) { + const entity: Excel.EntityCellValue = { + type: Excel.CellValueType.entity, + text: productName, + properties: { /* Excel.EntityPropertyType */ + "Product ID": { + type: Excel.CellValueType.string, + basicValue: productID.toString() || "" + }, + "Product Name": { + type: Excel.CellValueType.string, + basicValue: productName || "" + }, + "Quantity Per Unit": { + type: Excel.CellValueType.string, + basicValue: product.quantityPerUnit || "" + }, + // Add Unit Price as a formatted number. + "Unit Price": { + type: Excel.CellValueType.formattedNumber, + basicValue: product.unitPrice, + numberFormat: "$* #,##0.00" + } + }, + layouts: { /* Excel.EntityViewLayouts */ + card: { /* Excel.EntityCardLayout */ + title: { property: "Product Name" }, + sections: [ /* Excel.CardLayoutSection */ + { + layout: "List", + properties: ["Product ID"] + }, + { + layout: "List", + title: "Quantity and price", + collapsible: true, + collapsed: false, + properties: ["Quantity Per Unit", "Unit Price"] + } + ] + } + }, + provider: { + description: product.providerName, // Name of the data provider. Displays as a tooltip when hovering over the logo. Also displays as a fallback if the source address for the image is broken. + logoSourceAddress: product.sourceAddress, // Source URL of the logo to display. + logoTargetAddress: product.targetAddress // Destination URL that the logo navigates to when clicked. + } + }; + + return entity; + } + + ``` + isPreview: false isDeprecated: false syntax: export type EntityPropertyType = CellValueAndPropertyMetadata | CellValue; diff --git a/docs/docs-ref-autogen/excel_1_20/excel/excel.entityviewlayouts.yml b/docs/docs-ref-autogen/excel_1_20/excel/excel.entityviewlayouts.yml index 22c4101139..ed623b76d9 100644 --- a/docs/docs-ref-autogen/excel_1_20/excel/excel.entityviewlayouts.yml +++ b/docs/docs-ref-autogen/excel_1_20/excel/excel.entityviewlayouts.yml @@ -8,6 +8,71 @@ remarks: >- \[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-entity-attribution.yaml + + + function makeProductEntity(productID: number, productName: string, product?: + any) { + const entity: Excel.EntityCellValue = { + type: Excel.CellValueType.entity, + text: productName, + properties: { /* Excel.EntityPropertyType */ + "Product ID": { + type: Excel.CellValueType.string, + basicValue: productID.toString() || "" + }, + "Product Name": { + type: Excel.CellValueType.string, + basicValue: productName || "" + }, + "Quantity Per Unit": { + type: Excel.CellValueType.string, + basicValue: product.quantityPerUnit || "" + }, + // Add Unit Price as a formatted number. + "Unit Price": { + type: Excel.CellValueType.formattedNumber, + basicValue: product.unitPrice, + numberFormat: "$* #,##0.00" + } + }, + layouts: { /* Excel.EntityViewLayouts */ + card: { /* Excel.EntityCardLayout */ + title: { property: "Product Name" }, + sections: [ /* Excel.CardLayoutSection */ + { + layout: "List", + properties: ["Product ID"] + }, + { + layout: "List", + title: "Quantity and price", + collapsible: true, + collapsed: false, + properties: ["Quantity Per Unit", "Unit Price"] + } + ] + } + }, + provider: { + description: product.providerName, // Name of the data provider. Displays as a tooltip when hovering over the logo. Also displays as a fallback if the source address for the image is broken. + logoSourceAddress: product.sourceAddress, // Source URL of the logo to display. + logoTargetAddress: product.targetAddress // Destination URL that the logo navigates to when clicked. + } + }; + + return entity; + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/excel_1_8/excel/excel.datavalidationerroralert.yml b/docs/docs-ref-autogen/excel_1_8/excel/excel.datavalidationerroralert.yml index f5dfde1895..5bd9a15eb5 100644 --- a/docs/docs-ref-autogen/excel_1_8/excel/excel.datavalidationerroralert.yml +++ b/docs/docs-ref-autogen/excel_1_8/excel/excel.datavalidationerroralert.yml @@ -8,6 +8,50 @@ remarks: >- \[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/22-data-validation/data-validation.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Decision"); + const rankingRange = sheet.tables.getItem("NameOptionsTable").columns.getItem("Ranking").getDataBodyRange(); + + // When you are developing, it is a good practice to + // clear the dataValidation object with each run of your code. + rankingRange.dataValidation.clear(); + + let greaterThanZeroRule = { + wholeNumber: { + formula1: 0, + operator: Excel.DataValidationOperator.greaterThan + } + }; + rankingRange.dataValidation.rule = greaterThanZeroRule; + + rankingRange.dataValidation.prompt = { + message: "Please enter a positive number.", + showPrompt: true, + title: "Positive numbers only." + }; + + rankingRange.dataValidation.errorAlert = { + message: "Sorry, only positive numbers are allowed", + showAlert: true, + style: "Stop", + title: "Negative Number Entered" + }; + + await context.sync(); + }); + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/excel_1_9/excel/excel.cellborder.yml b/docs/docs-ref-autogen/excel_1_9/excel/excel.cellborder.yml index bc2f00c585..d0ccbdc739 100644 --- a/docs/docs-ref-autogen/excel_1_9/excel/excel.cellborder.yml +++ b/docs/docs-ref-autogen/excel_1_9/excel/excel.cellborder.yml @@ -13,6 +13,90 @@ remarks: >- \[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/cell-properties.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Creating the SettableCellProperties objects to use for the range. + // In your add-in, these should be created once, outside the function. + const topHeaderProps: Excel.SettableCellProperties = { + // The style property takes a string matching the name of an Excel style. + // Built-in style names are listed in the `BuiltInStyle` enum. + // Note that a style will overwrite any formatting, + // so do not use the format property with the style property. + style: "Heading1" + }; + + const headerProps: Excel.SettableCellProperties = { + // Any subproperties of format that are not set will not be changed when these cell properties are set. + format: { + fill: { + color: "Blue" + }, + font: { + color: "White", + bold: true + } + } + }; + + const nonApplicableProps: Excel.SettableCellProperties = { + format: { + fill: { + pattern: Excel.FillPattern.gray25 + }, + font: { + color: "Gray", + italic: true + } + } + }; + + const matchupScoreProps: Excel.SettableCellProperties = { + format: { + borders: { + bottom: { + style: Excel.BorderLineStyle.continuous + }, + left: { + style: Excel.BorderLineStyle.continuous + }, + right: { + style: Excel.BorderLineStyle.continuous + }, + top: { + style: Excel.BorderLineStyle.continuous + } + } + } + }; + + const range = sheet.getRange("A1:E5"); + + // You can use empty JSON objects to avoid changing a cell's properties. + range.setCellProperties([ + [topHeaderProps, {}, {}, {}, {}], + [{}, {}, headerProps, headerProps, headerProps], + [{}, headerProps, nonApplicableProps, matchupScoreProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, nonApplicableProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, matchupScoreProps, nonApplicableProps] + ]); + + sheet.getUsedRange().format.autofitColumns(); + await context.sync(); + }); + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/excel_1_9/excel/excel.datavalidationerroralert.yml b/docs/docs-ref-autogen/excel_1_9/excel/excel.datavalidationerroralert.yml index f5dfde1895..5bd9a15eb5 100644 --- a/docs/docs-ref-autogen/excel_1_9/excel/excel.datavalidationerroralert.yml +++ b/docs/docs-ref-autogen/excel_1_9/excel/excel.datavalidationerroralert.yml @@ -8,6 +8,50 @@ remarks: >- \[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/22-data-validation/data-validation.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Decision"); + const rankingRange = sheet.tables.getItem("NameOptionsTable").columns.getItem("Ranking").getDataBodyRange(); + + // When you are developing, it is a good practice to + // clear the dataValidation object with each run of your code. + rankingRange.dataValidation.clear(); + + let greaterThanZeroRule = { + wholeNumber: { + formula1: 0, + operator: Excel.DataValidationOperator.greaterThan + } + }; + rankingRange.dataValidation.rule = greaterThanZeroRule; + + rankingRange.dataValidation.prompt = { + message: "Please enter a positive number.", + showPrompt: true, + title: "Positive numbers only." + }; + + rankingRange.dataValidation.errorAlert = { + message: "Sorry, only positive numbers are allowed", + showAlert: true, + style: "Stop", + title: "Negative Number Entered" + }; + + await context.sync(); + }); + + ``` + isPreview: false isDeprecated: false type: interface 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 cca1b0c56e..c8bd52c201 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.cardlayoutsection.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.cardlayoutsection.yml @@ -9,6 +9,8 @@ remarks: >- 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + Learn more about the types in this type alias through the following links. @@ -16,6 +18,71 @@ remarks: >- [Excel.CardLayoutTableSection](/javascript/api/excel/excel.cardlayouttablesection), [Excel.CardLayoutTwoColumnSection](/javascript/api/excel/excel.cardlayouttwocolumnsection) + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-entity-attribution.yaml + + + function makeProductEntity(productID: number, productName: string, product?: + any) { + const entity: Excel.EntityCellValue = { + type: Excel.CellValueType.entity, + text: productName, + properties: { /* Excel.EntityPropertyType */ + "Product ID": { + type: Excel.CellValueType.string, + basicValue: productID.toString() || "" + }, + "Product Name": { + type: Excel.CellValueType.string, + basicValue: productName || "" + }, + "Quantity Per Unit": { + type: Excel.CellValueType.string, + basicValue: product.quantityPerUnit || "" + }, + // Add Unit Price as a formatted number. + "Unit Price": { + type: Excel.CellValueType.formattedNumber, + basicValue: product.unitPrice, + numberFormat: "$* #,##0.00" + } + }, + layouts: { /* Excel.EntityViewLayouts */ + card: { /* Excel.EntityCardLayout */ + title: { property: "Product Name" }, + sections: [ /* Excel.CardLayoutSection */ + { + layout: "List", + properties: ["Product ID"] + }, + { + layout: "List", + title: "Quantity and price", + collapsible: true, + collapsed: false, + properties: ["Quantity Per Unit", "Unit Price"] + } + ] + } + }, + provider: { + description: product.providerName, // Name of the data provider. Displays as a tooltip when hovering over the logo. Also displays as a fallback if the source address for the image is broken. + logoSourceAddress: product.sourceAddress, // Source URL of the logo to display. + logoTargetAddress: product.targetAddress // Destination URL that the logo navigates to when clicked. + } + }; + + return entity; + } + + ``` + isPreview: false isDeprecated: false syntax: >- diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.cellborder.yml b/docs/docs-ref-autogen/excel_online/excel/excel.cellborder.yml index bc2f00c585..d0ccbdc739 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.cellborder.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.cellborder.yml @@ -13,6 +13,90 @@ remarks: >- \[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/cell-properties.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Creating the SettableCellProperties objects to use for the range. + // In your add-in, these should be created once, outside the function. + const topHeaderProps: Excel.SettableCellProperties = { + // The style property takes a string matching the name of an Excel style. + // Built-in style names are listed in the `BuiltInStyle` enum. + // Note that a style will overwrite any formatting, + // so do not use the format property with the style property. + style: "Heading1" + }; + + const headerProps: Excel.SettableCellProperties = { + // Any subproperties of format that are not set will not be changed when these cell properties are set. + format: { + fill: { + color: "Blue" + }, + font: { + color: "White", + bold: true + } + } + }; + + const nonApplicableProps: Excel.SettableCellProperties = { + format: { + fill: { + pattern: Excel.FillPattern.gray25 + }, + font: { + color: "Gray", + italic: true + } + } + }; + + const matchupScoreProps: Excel.SettableCellProperties = { + format: { + borders: { + bottom: { + style: Excel.BorderLineStyle.continuous + }, + left: { + style: Excel.BorderLineStyle.continuous + }, + right: { + style: Excel.BorderLineStyle.continuous + }, + top: { + style: Excel.BorderLineStyle.continuous + } + } + } + }; + + const range = sheet.getRange("A1:E5"); + + // You can use empty JSON objects to avoid changing a cell's properties. + range.setCellProperties([ + [topHeaderProps, {}, {}, {}, {}], + [{}, {}, headerProps, headerProps, headerProps], + [{}, headerProps, nonApplicableProps, matchupScoreProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, nonApplicableProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, matchupScoreProps, nonApplicableProps] + ]); + + sheet.getUsedRange().format.autofitColumns(); + await context.sync(); + }); + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.datavalidationerroralert.yml b/docs/docs-ref-autogen/excel_online/excel/excel.datavalidationerroralert.yml index f5dfde1895..5bd9a15eb5 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.datavalidationerroralert.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.datavalidationerroralert.yml @@ -8,6 +8,50 @@ remarks: >- \[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/22-data-validation/data-validation.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Decision"); + const rankingRange = sheet.tables.getItem("NameOptionsTable").columns.getItem("Ranking").getDataBodyRange(); + + // When you are developing, it is a good practice to + // clear the dataValidation object with each run of your code. + rankingRange.dataValidation.clear(); + + let greaterThanZeroRule = { + wholeNumber: { + formula1: 0, + operator: Excel.DataValidationOperator.greaterThan + } + }; + rankingRange.dataValidation.rule = greaterThanZeroRule; + + rankingRange.dataValidation.prompt = { + message: "Please enter a positive number.", + showPrompt: true, + title: "Positive numbers only." + }; + + rankingRange.dataValidation.errorAlert = { + message: "Sorry, only positive numbers are allowed", + showAlert: true, + style: "Stop", + title: "Negative Number Entered" + }; + + await context.sync(); + }); + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.entitycardlayout.yml b/docs/docs-ref-autogen/excel_online/excel/excel.entitycardlayout.yml index 79647849b2..0980a175de 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.entitycardlayout.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.entitycardlayout.yml @@ -8,6 +8,71 @@ remarks: >- \[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-entity-attribution.yaml + + + function makeProductEntity(productID: number, productName: string, product?: + any) { + const entity: Excel.EntityCellValue = { + type: Excel.CellValueType.entity, + text: productName, + properties: { /* Excel.EntityPropertyType */ + "Product ID": { + type: Excel.CellValueType.string, + basicValue: productID.toString() || "" + }, + "Product Name": { + type: Excel.CellValueType.string, + basicValue: productName || "" + }, + "Quantity Per Unit": { + type: Excel.CellValueType.string, + basicValue: product.quantityPerUnit || "" + }, + // Add Unit Price as a formatted number. + "Unit Price": { + type: Excel.CellValueType.formattedNumber, + basicValue: product.unitPrice, + numberFormat: "$* #,##0.00" + } + }, + layouts: { /* Excel.EntityViewLayouts */ + card: { /* Excel.EntityCardLayout */ + title: { property: "Product Name" }, + sections: [ /* Excel.CardLayoutSection */ + { + layout: "List", + properties: ["Product ID"] + }, + { + layout: "List", + title: "Quantity and price", + collapsible: true, + collapsed: false, + properties: ["Quantity Per Unit", "Unit Price"] + } + ] + } + }, + provider: { + description: product.providerName, // Name of the data provider. Displays as a tooltip when hovering over the logo. Also displays as a fallback if the source address for the image is broken. + logoSourceAddress: product.sourceAddress, // Source URL of the logo to display. + logoTargetAddress: product.targetAddress // Destination URL that the logo navigates to when clicked. + } + }; + + return entity; + } + + ``` + isPreview: false isDeprecated: false type: interface 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 bc54a6eff6..b9afefd0e4 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.entitypropertytype.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.entitypropertytype.yml @@ -9,12 +9,79 @@ remarks: >- 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) + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-entity-attribution.yaml + + + function makeProductEntity(productID: number, productName: string, product?: + any) { + const entity: Excel.EntityCellValue = { + type: Excel.CellValueType.entity, + text: productName, + properties: { /* Excel.EntityPropertyType */ + "Product ID": { + type: Excel.CellValueType.string, + basicValue: productID.toString() || "" + }, + "Product Name": { + type: Excel.CellValueType.string, + basicValue: productName || "" + }, + "Quantity Per Unit": { + type: Excel.CellValueType.string, + basicValue: product.quantityPerUnit || "" + }, + // Add Unit Price as a formatted number. + "Unit Price": { + type: Excel.CellValueType.formattedNumber, + basicValue: product.unitPrice, + numberFormat: "$* #,##0.00" + } + }, + layouts: { /* Excel.EntityViewLayouts */ + card: { /* Excel.EntityCardLayout */ + title: { property: "Product Name" }, + sections: [ /* Excel.CardLayoutSection */ + { + layout: "List", + properties: ["Product ID"] + }, + { + layout: "List", + title: "Quantity and price", + collapsible: true, + collapsed: false, + properties: ["Quantity Per Unit", "Unit Price"] + } + ] + } + }, + provider: { + description: product.providerName, // Name of the data provider. Displays as a tooltip when hovering over the logo. Also displays as a fallback if the source address for the image is broken. + logoSourceAddress: product.sourceAddress, // Source URL of the logo to display. + logoTargetAddress: product.targetAddress // Destination URL that the logo navigates to when clicked. + } + }; + + return entity; + } + + ``` + isPreview: false isDeprecated: false syntax: export type EntityPropertyType = CellValueAndPropertyMetadata | CellValue; diff --git a/docs/docs-ref-autogen/excel_online/excel/excel.entityviewlayouts.yml b/docs/docs-ref-autogen/excel_online/excel/excel.entityviewlayouts.yml index 22c4101139..ed623b76d9 100644 --- a/docs/docs-ref-autogen/excel_online/excel/excel.entityviewlayouts.yml +++ b/docs/docs-ref-autogen/excel_online/excel/excel.entityviewlayouts.yml @@ -8,6 +8,71 @@ remarks: >- \[ [API set: ExcelApi 1.16](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \] + + #### Examples + + + ```TypeScript + + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-entity-attribution.yaml + + + function makeProductEntity(productID: number, productName: string, product?: + any) { + const entity: Excel.EntityCellValue = { + type: Excel.CellValueType.entity, + text: productName, + properties: { /* Excel.EntityPropertyType */ + "Product ID": { + type: Excel.CellValueType.string, + basicValue: productID.toString() || "" + }, + "Product Name": { + type: Excel.CellValueType.string, + basicValue: productName || "" + }, + "Quantity Per Unit": { + type: Excel.CellValueType.string, + basicValue: product.quantityPerUnit || "" + }, + // Add Unit Price as a formatted number. + "Unit Price": { + type: Excel.CellValueType.formattedNumber, + basicValue: product.unitPrice, + numberFormat: "$* #,##0.00" + } + }, + layouts: { /* Excel.EntityViewLayouts */ + card: { /* Excel.EntityCardLayout */ + title: { property: "Product Name" }, + sections: [ /* Excel.CardLayoutSection */ + { + layout: "List", + properties: ["Product ID"] + }, + { + layout: "List", + title: "Quantity and price", + collapsible: true, + collapsed: false, + properties: ["Quantity Per Unit", "Unit Price"] + } + ] + } + }, + provider: { + description: product.providerName, // Name of the data provider. Displays as a tooltip when hovering over the logo. Also displays as a fallback if the source address for the image is broken. + logoSourceAddress: product.sourceAddress, // Source URL of the logo to display. + logoTargetAddress: product.targetAddress // Destination URL that the logo navigates to when clicked. + } + }; + + return entity; + } + + ``` + isPreview: false isDeprecated: false type: interface diff --git a/docs/docs-ref-autogen/outlook/outlook/office.appointmentcompose.yml b/docs/docs-ref-autogen/outlook/outlook/office.appointmentcompose.yml index ba8ee8776c..4ce30646c1 100644 --- a/docs/docs-ref-autogen/outlook/outlook/office.appointmentcompose.yml +++ b/docs/docs-ref-autogen/outlook/outlook/office.appointmentcompose.yml @@ -291,6 +291,15 @@ properties: -->**: Appointment Organizer + **Important**: To manage the locations of an appointment in Outlook + clients that don't support Mailbox requirement set 1.8, use the `location` + property instead. For guidance on selecting the right location API for + your scenario, see [Get or set the location when composing an appointmnt + in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples @@ -496,6 +505,11 @@ properties: provides methods that are used to get and set the location of the appointment. remarks: >- + \[ [API set: Mailbox + 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) + \] + + **[Minimum permission level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** @@ -506,6 +520,16 @@ properties: -->**: Appointment Organizer + **Important**: The `enhancedLocation` property was introduced in + Mailbox requirement set 1.8. Use the `enhancedLocation` property to better + identify and manage appointment locations, especially if you need to + determine the location type. For guidance on selecting the right location + API for your scenario, see [Get or set the location when composing an + appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples diff --git a/docs/docs-ref-autogen/outlook/outlook/office.appointmentread.yml b/docs/docs-ref-autogen/outlook/outlook/office.appointmentread.yml index e7adac6ae2..1313c812e5 100644 --- a/docs/docs-ref-autogen/outlook/outlook/office.appointmentread.yml +++ b/docs/docs-ref-autogen/outlook/outlook/office.appointmentread.yml @@ -413,6 +413,15 @@ properties: -->**: Appointment Attendee + **Important**: To manage the locations of an appointment in Outlook + clients that don't support Mailbox requirement set 1.8, use the `location` + property instead. For guidance on selecting the right location API for + your scenario, see [Get or set the location when composing an appointmnt + in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples @@ -660,6 +669,11 @@ properties: The `location` property returns a string that contains the location of the appointment. remarks: >- + \[ [API set: Mailbox + 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) + \] + + **[Minimum permission level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** @@ -670,6 +684,16 @@ properties: -->**: Appointment Attendee + **Important**: The `enhancedLocation` property was introduced in + Mailbox requirement set 1.8. Use the `enhancedLocation` property to better + identify and manage appointment locations, especially if you need to + determine the location type. For guidance on selecting the right location + API for your scenario, see [Get or set the location when composing an + appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples diff --git a/docs/docs-ref-autogen/outlook/outlook/office.enhancedlocation.yml b/docs/docs-ref-autogen/outlook/outlook/office.enhancedlocation.yml index ff802dfb36..942dc43414 100644 --- a/docs/docs-ref-autogen/outlook/outlook/office.enhancedlocation.yml +++ b/docs/docs-ref-autogen/outlook/outlook/office.enhancedlocation.yml @@ -18,6 +18,15 @@ remarks: >- mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + + **Important**: To manage the locations of an appointment in Outlook + clients that don't support Mailbox requirement set 1.8, use the + Office.Location API instead. For guidance on selecting the right location API + for your scenario, see [Get or set the location when composing an appointmnt + in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + isPreview: false isDeprecated: false type: interface @@ -165,13 +174,7 @@ methods: uid: outlook!Office.EnhancedLocation#getAsync:member(1) package: outlook! fullName: getAsync(options, callback) - summary: >- - Gets the set of locations associated with the appointment. - - - **Note**: [Personal contact - groups](https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023) - added as appointment locations aren't returned by this method. + summary: Gets the set of locations associated with the appointment. remarks: >- \[ [API set: Mailbox 1.8](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) @@ -188,6 +191,19 @@ methods: -->**: Compose or Read + **Important**: + + + - The `getAsync` method doesn't return [personal contact + groups](https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023) + that were added to the **Location** field of an appointment. + + + - If a location was added using + `Office.context.mailbox.item.location.setAsync`, its location type + is `Office.MailboxEnums.LocationType.Custom`. + + #### Examples @@ -234,7 +250,9 @@ methods: description: >- Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, - `asyncResult`, which is an `Office.AsyncResult` object. + `asyncResult`, which is an `Office.AsyncResult` object. An + array of `Office.LocationDetails` objects representing the locations + of the appointment is returned in the `asyncResult.value` property. type: >- (asyncResult: <[]>) @@ -246,13 +264,7 @@ methods: uid: outlook!Office.EnhancedLocation#getAsync:member(2) package: outlook! fullName: getAsync(callback) - summary: >- - Gets the set of locations associated with the appointment. - - - **Note**: [Personal contact - groups](https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023) - added as appointment locations aren't returned by this method. + summary: Gets the set of locations associated with the appointment. remarks: >- \[ [API set: Mailbox 1.8](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) @@ -268,6 +280,19 @@ methods: mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + + **Important**: + + + - The `getAsync` method doesn't return [personal contact + groups](https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023) + that were added to the **Location** field of an appointment. + + + - If a location was added using + `Office.context.mailbox.item.location.setAsync`, its location type + is `Office.MailboxEnums.LocationType.Custom`. + isPreview: false isDeprecated: false syntax: @@ -279,7 +304,9 @@ methods: description: >- Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, - `asyncResult`, which is an `Office.AsyncResult` object. + `asyncResult`, which is an `Office.AsyncResult` object. An + array of `Office.LocationDetails` objects representing the locations + of the appointment is returned in the `asyncResult.value` property. type: >- (asyncResult: <[]>) diff --git a/docs/docs-ref-autogen/outlook/outlook/office.location.yml b/docs/docs-ref-autogen/outlook/outlook/office.location.yml index 127b664dc0..49de7b4b1a 100644 --- a/docs/docs-ref-autogen/outlook/outlook/office.location.yml +++ b/docs/docs-ref-autogen/outlook/outlook/office.location.yml @@ -20,6 +20,15 @@ remarks: >- mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose + + **Important**: The Office.EnhancedLocation API was introduced in Mailbox + requirement set 1.8. Use the EnhancedLocation API to better identify and + manage appointment locations, especially if you need to determine the location + type. For guidance on selecting the right location API for your scenario, see + [Get or set the location when composing an appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + isPreview: false isDeprecated: false type: interface @@ -184,6 +193,11 @@ methods: -->**: Compose + **Important**: To ensure that multiple locations resolve correctly in + Outlook, separate them with a semicolon and a space. For example, + "Conference Room 1; Conference Room 2". + + **Errors**: @@ -269,6 +283,11 @@ methods: -->**: Compose + **Important**: To ensure that multiple locations resolve correctly in + Outlook, separate them with a semicolon and a space. For example, + "Conference Room 1; Conference Room 2". + + **Errors**: diff --git a/docs/docs-ref-autogen/outlook_1_1/outlook/office.appointmentcompose.yml b/docs/docs-ref-autogen/outlook_1_1/outlook/office.appointmentcompose.yml index 772da2920f..954c21e71f 100644 --- a/docs/docs-ref-autogen/outlook_1_1/outlook/office.appointmentcompose.yml +++ b/docs/docs-ref-autogen/outlook_1_1/outlook/office.appointmentcompose.yml @@ -219,6 +219,11 @@ properties: provides methods that are used to get and set the location of the appointment. remarks: >- + \[ [API set: Mailbox + 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) + \] + + **[Minimum permission level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** @@ -229,6 +234,16 @@ properties: -->**: Appointment Organizer + **Important**: The `enhancedLocation` property was introduced in + Mailbox requirement set 1.8. Use the `enhancedLocation` property to better + identify and manage appointment locations, especially if you need to + determine the location type. For guidance on selecting the right location + API for your scenario, see [Get or set the location when composing an + appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples diff --git a/docs/docs-ref-autogen/outlook_1_1/outlook/office.appointmentread.yml b/docs/docs-ref-autogen/outlook_1_1/outlook/office.appointmentread.yml index 7a6d853548..9c50beaab6 100644 --- a/docs/docs-ref-autogen/outlook_1_1/outlook/office.appointmentread.yml +++ b/docs/docs-ref-autogen/outlook_1_1/outlook/office.appointmentread.yml @@ -451,6 +451,11 @@ properties: The `location` property returns a string that contains the location of the appointment. remarks: >- + \[ [API set: Mailbox + 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) + \] + + **[Minimum permission level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** @@ -461,6 +466,16 @@ properties: -->**: Appointment Attendee + **Important**: The `enhancedLocation` property was introduced in + Mailbox requirement set 1.8. Use the `enhancedLocation` property to better + identify and manage appointment locations, especially if you need to + determine the location type. For guidance on selecting the right location + API for your scenario, see [Get or set the location when composing an + appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples diff --git a/docs/docs-ref-autogen/outlook_1_1/outlook/office.location.yml b/docs/docs-ref-autogen/outlook_1_1/outlook/office.location.yml index 127b664dc0..49de7b4b1a 100644 --- a/docs/docs-ref-autogen/outlook_1_1/outlook/office.location.yml +++ b/docs/docs-ref-autogen/outlook_1_1/outlook/office.location.yml @@ -20,6 +20,15 @@ remarks: >- mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose + + **Important**: The Office.EnhancedLocation API was introduced in Mailbox + requirement set 1.8. Use the EnhancedLocation API to better identify and + manage appointment locations, especially if you need to determine the location + type. For guidance on selecting the right location API for your scenario, see + [Get or set the location when composing an appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + isPreview: false isDeprecated: false type: interface @@ -184,6 +193,11 @@ methods: -->**: Compose + **Important**: To ensure that multiple locations resolve correctly in + Outlook, separate them with a semicolon and a space. For example, + "Conference Room 1; Conference Room 2". + + **Errors**: @@ -269,6 +283,11 @@ methods: -->**: Compose + **Important**: To ensure that multiple locations resolve correctly in + Outlook, separate them with a semicolon and a space. For example, + "Conference Room 1; Conference Room 2". + + **Errors**: diff --git a/docs/docs-ref-autogen/outlook_1_10/outlook/office.appointmentcompose.yml b/docs/docs-ref-autogen/outlook_1_10/outlook/office.appointmentcompose.yml index bcddc4bfec..d1926494ee 100644 --- a/docs/docs-ref-autogen/outlook_1_10/outlook/office.appointmentcompose.yml +++ b/docs/docs-ref-autogen/outlook_1_10/outlook/office.appointmentcompose.yml @@ -291,6 +291,15 @@ properties: -->**: Appointment Organizer + **Important**: To manage the locations of an appointment in Outlook + clients that don't support Mailbox requirement set 1.8, use the `location` + property instead. For guidance on selecting the right location API for + your scenario, see [Get or set the location when composing an appointmnt + in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples @@ -434,6 +443,11 @@ properties: provides methods that are used to get and set the location of the appointment. remarks: >- + \[ [API set: Mailbox + 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) + \] + + **[Minimum permission level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** @@ -444,6 +458,16 @@ properties: -->**: Appointment Organizer + **Important**: The `enhancedLocation` property was introduced in + Mailbox requirement set 1.8. Use the `enhancedLocation` property to better + identify and manage appointment locations, especially if you need to + determine the location type. For guidance on selecting the right location + API for your scenario, see [Get or set the location when composing an + appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples diff --git a/docs/docs-ref-autogen/outlook_1_10/outlook/office.appointmentread.yml b/docs/docs-ref-autogen/outlook_1_10/outlook/office.appointmentread.yml index 54d62b6833..74217eb2f8 100644 --- a/docs/docs-ref-autogen/outlook_1_10/outlook/office.appointmentread.yml +++ b/docs/docs-ref-autogen/outlook_1_10/outlook/office.appointmentread.yml @@ -413,6 +413,15 @@ properties: -->**: Appointment Attendee + **Important**: To manage the locations of an appointment in Outlook + clients that don't support Mailbox requirement set 1.8, use the `location` + property instead. For guidance on selecting the right location API for + your scenario, see [Get or set the location when composing an appointmnt + in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples @@ -622,6 +631,11 @@ properties: The `location` property returns a string that contains the location of the appointment. remarks: >- + \[ [API set: Mailbox + 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) + \] + + **[Minimum permission level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** @@ -632,6 +646,16 @@ properties: -->**: Appointment Attendee + **Important**: The `enhancedLocation` property was introduced in + Mailbox requirement set 1.8. Use the `enhancedLocation` property to better + identify and manage appointment locations, especially if you need to + determine the location type. For guidance on selecting the right location + API for your scenario, see [Get or set the location when composing an + appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples diff --git a/docs/docs-ref-autogen/outlook_1_10/outlook/office.enhancedlocation.yml b/docs/docs-ref-autogen/outlook_1_10/outlook/office.enhancedlocation.yml index ff802dfb36..942dc43414 100644 --- a/docs/docs-ref-autogen/outlook_1_10/outlook/office.enhancedlocation.yml +++ b/docs/docs-ref-autogen/outlook_1_10/outlook/office.enhancedlocation.yml @@ -18,6 +18,15 @@ remarks: >- mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + + **Important**: To manage the locations of an appointment in Outlook + clients that don't support Mailbox requirement set 1.8, use the + Office.Location API instead. For guidance on selecting the right location API + for your scenario, see [Get or set the location when composing an appointmnt + in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + isPreview: false isDeprecated: false type: interface @@ -165,13 +174,7 @@ methods: uid: outlook!Office.EnhancedLocation#getAsync:member(1) package: outlook! fullName: getAsync(options, callback) - summary: >- - Gets the set of locations associated with the appointment. - - - **Note**: [Personal contact - groups](https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023) - added as appointment locations aren't returned by this method. + summary: Gets the set of locations associated with the appointment. remarks: >- \[ [API set: Mailbox 1.8](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) @@ -188,6 +191,19 @@ methods: -->**: Compose or Read + **Important**: + + + - The `getAsync` method doesn't return [personal contact + groups](https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023) + that were added to the **Location** field of an appointment. + + + - If a location was added using + `Office.context.mailbox.item.location.setAsync`, its location type + is `Office.MailboxEnums.LocationType.Custom`. + + #### Examples @@ -234,7 +250,9 @@ methods: description: >- Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, - `asyncResult`, which is an `Office.AsyncResult` object. + `asyncResult`, which is an `Office.AsyncResult` object. An + array of `Office.LocationDetails` objects representing the locations + of the appointment is returned in the `asyncResult.value` property. type: >- (asyncResult: <[]>) @@ -246,13 +264,7 @@ methods: uid: outlook!Office.EnhancedLocation#getAsync:member(2) package: outlook! fullName: getAsync(callback) - summary: >- - Gets the set of locations associated with the appointment. - - - **Note**: [Personal contact - groups](https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023) - added as appointment locations aren't returned by this method. + summary: Gets the set of locations associated with the appointment. remarks: >- \[ [API set: Mailbox 1.8](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) @@ -268,6 +280,19 @@ methods: mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + + **Important**: + + + - The `getAsync` method doesn't return [personal contact + groups](https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023) + that were added to the **Location** field of an appointment. + + + - If a location was added using + `Office.context.mailbox.item.location.setAsync`, its location type + is `Office.MailboxEnums.LocationType.Custom`. + isPreview: false isDeprecated: false syntax: @@ -279,7 +304,9 @@ methods: description: >- Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, - `asyncResult`, which is an `Office.AsyncResult` object. + `asyncResult`, which is an `Office.AsyncResult` object. An + array of `Office.LocationDetails` objects representing the locations + of the appointment is returned in the `asyncResult.value` property. type: >- (asyncResult: <[]>) diff --git a/docs/docs-ref-autogen/outlook_1_10/outlook/office.location.yml b/docs/docs-ref-autogen/outlook_1_10/outlook/office.location.yml index 127b664dc0..49de7b4b1a 100644 --- a/docs/docs-ref-autogen/outlook_1_10/outlook/office.location.yml +++ b/docs/docs-ref-autogen/outlook_1_10/outlook/office.location.yml @@ -20,6 +20,15 @@ remarks: >- mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose + + **Important**: The Office.EnhancedLocation API was introduced in Mailbox + requirement set 1.8. Use the EnhancedLocation API to better identify and + manage appointment locations, especially if you need to determine the location + type. For guidance on selecting the right location API for your scenario, see + [Get or set the location when composing an appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + isPreview: false isDeprecated: false type: interface @@ -184,6 +193,11 @@ methods: -->**: Compose + **Important**: To ensure that multiple locations resolve correctly in + Outlook, separate them with a semicolon and a space. For example, + "Conference Room 1; Conference Room 2". + + **Errors**: @@ -269,6 +283,11 @@ methods: -->**: Compose + **Important**: To ensure that multiple locations resolve correctly in + Outlook, separate them with a semicolon and a space. For example, + "Conference Room 1; Conference Room 2". + + **Errors**: diff --git a/docs/docs-ref-autogen/outlook_1_11/outlook/office.appointmentcompose.yml b/docs/docs-ref-autogen/outlook_1_11/outlook/office.appointmentcompose.yml index 8535263d51..780ef5895d 100644 --- a/docs/docs-ref-autogen/outlook_1_11/outlook/office.appointmentcompose.yml +++ b/docs/docs-ref-autogen/outlook_1_11/outlook/office.appointmentcompose.yml @@ -291,6 +291,15 @@ properties: -->**: Appointment Organizer + **Important**: To manage the locations of an appointment in Outlook + clients that don't support Mailbox requirement set 1.8, use the `location` + property instead. For guidance on selecting the right location API for + your scenario, see [Get or set the location when composing an appointmnt + in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples @@ -434,6 +443,11 @@ properties: provides methods that are used to get and set the location of the appointment. remarks: >- + \[ [API set: Mailbox + 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) + \] + + **[Minimum permission level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** @@ -444,6 +458,16 @@ properties: -->**: Appointment Organizer + **Important**: The `enhancedLocation` property was introduced in + Mailbox requirement set 1.8. Use the `enhancedLocation` property to better + identify and manage appointment locations, especially if you need to + determine the location type. For guidance on selecting the right location + API for your scenario, see [Get or set the location when composing an + appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples diff --git a/docs/docs-ref-autogen/outlook_1_11/outlook/office.appointmentread.yml b/docs/docs-ref-autogen/outlook_1_11/outlook/office.appointmentread.yml index 43399865df..8e7c6628bf 100644 --- a/docs/docs-ref-autogen/outlook_1_11/outlook/office.appointmentread.yml +++ b/docs/docs-ref-autogen/outlook_1_11/outlook/office.appointmentread.yml @@ -413,6 +413,15 @@ properties: -->**: Appointment Attendee + **Important**: To manage the locations of an appointment in Outlook + clients that don't support Mailbox requirement set 1.8, use the `location` + property instead. For guidance on selecting the right location API for + your scenario, see [Get or set the location when composing an appointmnt + in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples @@ -622,6 +631,11 @@ properties: The `location` property returns a string that contains the location of the appointment. remarks: >- + \[ [API set: Mailbox + 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) + \] + + **[Minimum permission level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** @@ -632,6 +646,16 @@ properties: -->**: Appointment Attendee + **Important**: The `enhancedLocation` property was introduced in + Mailbox requirement set 1.8. Use the `enhancedLocation` property to better + identify and manage appointment locations, especially if you need to + determine the location type. For guidance on selecting the right location + API for your scenario, see [Get or set the location when composing an + appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples diff --git a/docs/docs-ref-autogen/outlook_1_11/outlook/office.enhancedlocation.yml b/docs/docs-ref-autogen/outlook_1_11/outlook/office.enhancedlocation.yml index ff802dfb36..942dc43414 100644 --- a/docs/docs-ref-autogen/outlook_1_11/outlook/office.enhancedlocation.yml +++ b/docs/docs-ref-autogen/outlook_1_11/outlook/office.enhancedlocation.yml @@ -18,6 +18,15 @@ remarks: >- mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + + **Important**: To manage the locations of an appointment in Outlook + clients that don't support Mailbox requirement set 1.8, use the + Office.Location API instead. For guidance on selecting the right location API + for your scenario, see [Get or set the location when composing an appointmnt + in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + isPreview: false isDeprecated: false type: interface @@ -165,13 +174,7 @@ methods: uid: outlook!Office.EnhancedLocation#getAsync:member(1) package: outlook! fullName: getAsync(options, callback) - summary: >- - Gets the set of locations associated with the appointment. - - - **Note**: [Personal contact - groups](https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023) - added as appointment locations aren't returned by this method. + summary: Gets the set of locations associated with the appointment. remarks: >- \[ [API set: Mailbox 1.8](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) @@ -188,6 +191,19 @@ methods: -->**: Compose or Read + **Important**: + + + - The `getAsync` method doesn't return [personal contact + groups](https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023) + that were added to the **Location** field of an appointment. + + + - If a location was added using + `Office.context.mailbox.item.location.setAsync`, its location type + is `Office.MailboxEnums.LocationType.Custom`. + + #### Examples @@ -234,7 +250,9 @@ methods: description: >- Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, - `asyncResult`, which is an `Office.AsyncResult` object. + `asyncResult`, which is an `Office.AsyncResult` object. An + array of `Office.LocationDetails` objects representing the locations + of the appointment is returned in the `asyncResult.value` property. type: >- (asyncResult: <[]>) @@ -246,13 +264,7 @@ methods: uid: outlook!Office.EnhancedLocation#getAsync:member(2) package: outlook! fullName: getAsync(callback) - summary: >- - Gets the set of locations associated with the appointment. - - - **Note**: [Personal contact - groups](https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023) - added as appointment locations aren't returned by this method. + summary: Gets the set of locations associated with the appointment. remarks: >- \[ [API set: Mailbox 1.8](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) @@ -268,6 +280,19 @@ methods: mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + + **Important**: + + + - The `getAsync` method doesn't return [personal contact + groups](https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023) + that were added to the **Location** field of an appointment. + + + - If a location was added using + `Office.context.mailbox.item.location.setAsync`, its location type + is `Office.MailboxEnums.LocationType.Custom`. + isPreview: false isDeprecated: false syntax: @@ -279,7 +304,9 @@ methods: description: >- Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, - `asyncResult`, which is an `Office.AsyncResult` object. + `asyncResult`, which is an `Office.AsyncResult` object. An + array of `Office.LocationDetails` objects representing the locations + of the appointment is returned in the `asyncResult.value` property. type: >- (asyncResult: <[]>) diff --git a/docs/docs-ref-autogen/outlook_1_11/outlook/office.location.yml b/docs/docs-ref-autogen/outlook_1_11/outlook/office.location.yml index 127b664dc0..49de7b4b1a 100644 --- a/docs/docs-ref-autogen/outlook_1_11/outlook/office.location.yml +++ b/docs/docs-ref-autogen/outlook_1_11/outlook/office.location.yml @@ -20,6 +20,15 @@ remarks: >- mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose + + **Important**: The Office.EnhancedLocation API was introduced in Mailbox + requirement set 1.8. Use the EnhancedLocation API to better identify and + manage appointment locations, especially if you need to determine the location + type. For guidance on selecting the right location API for your scenario, see + [Get or set the location when composing an appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + isPreview: false isDeprecated: false type: interface @@ -184,6 +193,11 @@ methods: -->**: Compose + **Important**: To ensure that multiple locations resolve correctly in + Outlook, separate them with a semicolon and a space. For example, + "Conference Room 1; Conference Room 2". + + **Errors**: @@ -269,6 +283,11 @@ methods: -->**: Compose + **Important**: To ensure that multiple locations resolve correctly in + Outlook, separate them with a semicolon and a space. For example, + "Conference Room 1; Conference Room 2". + + **Errors**: diff --git a/docs/docs-ref-autogen/outlook_1_12/outlook/office.appointmentcompose.yml b/docs/docs-ref-autogen/outlook_1_12/outlook/office.appointmentcompose.yml index 7fddc0dad4..6274b15bf6 100644 --- a/docs/docs-ref-autogen/outlook_1_12/outlook/office.appointmentcompose.yml +++ b/docs/docs-ref-autogen/outlook_1_12/outlook/office.appointmentcompose.yml @@ -291,6 +291,15 @@ properties: -->**: Appointment Organizer + **Important**: To manage the locations of an appointment in Outlook + clients that don't support Mailbox requirement set 1.8, use the `location` + property instead. For guidance on selecting the right location API for + your scenario, see [Get or set the location when composing an appointmnt + in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples @@ -434,6 +443,11 @@ properties: provides methods that are used to get and set the location of the appointment. remarks: >- + \[ [API set: Mailbox + 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) + \] + + **[Minimum permission level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** @@ -444,6 +458,16 @@ properties: -->**: Appointment Organizer + **Important**: The `enhancedLocation` property was introduced in + Mailbox requirement set 1.8. Use the `enhancedLocation` property to better + identify and manage appointment locations, especially if you need to + determine the location type. For guidance on selecting the right location + API for your scenario, see [Get or set the location when composing an + appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples diff --git a/docs/docs-ref-autogen/outlook_1_12/outlook/office.appointmentread.yml b/docs/docs-ref-autogen/outlook_1_12/outlook/office.appointmentread.yml index 264a1d33e4..6a2a85cee6 100644 --- a/docs/docs-ref-autogen/outlook_1_12/outlook/office.appointmentread.yml +++ b/docs/docs-ref-autogen/outlook_1_12/outlook/office.appointmentread.yml @@ -413,6 +413,15 @@ properties: -->**: Appointment Attendee + **Important**: To manage the locations of an appointment in Outlook + clients that don't support Mailbox requirement set 1.8, use the `location` + property instead. For guidance on selecting the right location API for + your scenario, see [Get or set the location when composing an appointmnt + in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples @@ -622,6 +631,11 @@ properties: The `location` property returns a string that contains the location of the appointment. remarks: >- + \[ [API set: Mailbox + 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) + \] + + **[Minimum permission level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** @@ -632,6 +646,16 @@ properties: -->**: Appointment Attendee + **Important**: The `enhancedLocation` property was introduced in + Mailbox requirement set 1.8. Use the `enhancedLocation` property to better + identify and manage appointment locations, especially if you need to + determine the location type. For guidance on selecting the right location + API for your scenario, see [Get or set the location when composing an + appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples diff --git a/docs/docs-ref-autogen/outlook_1_12/outlook/office.enhancedlocation.yml b/docs/docs-ref-autogen/outlook_1_12/outlook/office.enhancedlocation.yml index ff802dfb36..942dc43414 100644 --- a/docs/docs-ref-autogen/outlook_1_12/outlook/office.enhancedlocation.yml +++ b/docs/docs-ref-autogen/outlook_1_12/outlook/office.enhancedlocation.yml @@ -18,6 +18,15 @@ remarks: >- mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + + **Important**: To manage the locations of an appointment in Outlook + clients that don't support Mailbox requirement set 1.8, use the + Office.Location API instead. For guidance on selecting the right location API + for your scenario, see [Get or set the location when composing an appointmnt + in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + isPreview: false isDeprecated: false type: interface @@ -165,13 +174,7 @@ methods: uid: outlook!Office.EnhancedLocation#getAsync:member(1) package: outlook! fullName: getAsync(options, callback) - summary: >- - Gets the set of locations associated with the appointment. - - - **Note**: [Personal contact - groups](https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023) - added as appointment locations aren't returned by this method. + summary: Gets the set of locations associated with the appointment. remarks: >- \[ [API set: Mailbox 1.8](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) @@ -188,6 +191,19 @@ methods: -->**: Compose or Read + **Important**: + + + - The `getAsync` method doesn't return [personal contact + groups](https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023) + that were added to the **Location** field of an appointment. + + + - If a location was added using + `Office.context.mailbox.item.location.setAsync`, its location type + is `Office.MailboxEnums.LocationType.Custom`. + + #### Examples @@ -234,7 +250,9 @@ methods: description: >- Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, - `asyncResult`, which is an `Office.AsyncResult` object. + `asyncResult`, which is an `Office.AsyncResult` object. An + array of `Office.LocationDetails` objects representing the locations + of the appointment is returned in the `asyncResult.value` property. type: >- (asyncResult: <[]>) @@ -246,13 +264,7 @@ methods: uid: outlook!Office.EnhancedLocation#getAsync:member(2) package: outlook! fullName: getAsync(callback) - summary: >- - Gets the set of locations associated with the appointment. - - - **Note**: [Personal contact - groups](https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023) - added as appointment locations aren't returned by this method. + summary: Gets the set of locations associated with the appointment. remarks: >- \[ [API set: Mailbox 1.8](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) @@ -268,6 +280,19 @@ methods: mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + + **Important**: + + + - The `getAsync` method doesn't return [personal contact + groups](https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023) + that were added to the **Location** field of an appointment. + + + - If a location was added using + `Office.context.mailbox.item.location.setAsync`, its location type + is `Office.MailboxEnums.LocationType.Custom`. + isPreview: false isDeprecated: false syntax: @@ -279,7 +304,9 @@ methods: description: >- Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, - `asyncResult`, which is an `Office.AsyncResult` object. + `asyncResult`, which is an `Office.AsyncResult` object. An + array of `Office.LocationDetails` objects representing the locations + of the appointment is returned in the `asyncResult.value` property. type: >- (asyncResult: <[]>) diff --git a/docs/docs-ref-autogen/outlook_1_12/outlook/office.location.yml b/docs/docs-ref-autogen/outlook_1_12/outlook/office.location.yml index 127b664dc0..49de7b4b1a 100644 --- a/docs/docs-ref-autogen/outlook_1_12/outlook/office.location.yml +++ b/docs/docs-ref-autogen/outlook_1_12/outlook/office.location.yml @@ -20,6 +20,15 @@ remarks: >- mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose + + **Important**: The Office.EnhancedLocation API was introduced in Mailbox + requirement set 1.8. Use the EnhancedLocation API to better identify and + manage appointment locations, especially if you need to determine the location + type. For guidance on selecting the right location API for your scenario, see + [Get or set the location when composing an appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + isPreview: false isDeprecated: false type: interface @@ -184,6 +193,11 @@ methods: -->**: Compose + **Important**: To ensure that multiple locations resolve correctly in + Outlook, separate them with a semicolon and a space. For example, + "Conference Room 1; Conference Room 2". + + **Errors**: @@ -269,6 +283,11 @@ methods: -->**: Compose + **Important**: To ensure that multiple locations resolve correctly in + Outlook, separate them with a semicolon and a space. For example, + "Conference Room 1; Conference Room 2". + + **Errors**: diff --git a/docs/docs-ref-autogen/outlook_1_13/outlook/office.appointmentcompose.yml b/docs/docs-ref-autogen/outlook_1_13/outlook/office.appointmentcompose.yml index c6539c9b33..0c5d4fb8a8 100644 --- a/docs/docs-ref-autogen/outlook_1_13/outlook/office.appointmentcompose.yml +++ b/docs/docs-ref-autogen/outlook_1_13/outlook/office.appointmentcompose.yml @@ -291,6 +291,15 @@ properties: -->**: Appointment Organizer + **Important**: To manage the locations of an appointment in Outlook + clients that don't support Mailbox requirement set 1.8, use the `location` + property instead. For guidance on selecting the right location API for + your scenario, see [Get or set the location when composing an appointmnt + in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples @@ -434,6 +443,11 @@ properties: provides methods that are used to get and set the location of the appointment. remarks: >- + \[ [API set: Mailbox + 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) + \] + + **[Minimum permission level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** @@ -444,6 +458,16 @@ properties: -->**: Appointment Organizer + **Important**: The `enhancedLocation` property was introduced in + Mailbox requirement set 1.8. Use the `enhancedLocation` property to better + identify and manage appointment locations, especially if you need to + determine the location type. For guidance on selecting the right location + API for your scenario, see [Get or set the location when composing an + appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples diff --git a/docs/docs-ref-autogen/outlook_1_13/outlook/office.appointmentread.yml b/docs/docs-ref-autogen/outlook_1_13/outlook/office.appointmentread.yml index ebf3f14097..3101e6f3cc 100644 --- a/docs/docs-ref-autogen/outlook_1_13/outlook/office.appointmentread.yml +++ b/docs/docs-ref-autogen/outlook_1_13/outlook/office.appointmentread.yml @@ -413,6 +413,15 @@ properties: -->**: Appointment Attendee + **Important**: To manage the locations of an appointment in Outlook + clients that don't support Mailbox requirement set 1.8, use the `location` + property instead. For guidance on selecting the right location API for + your scenario, see [Get or set the location when composing an appointmnt + in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples @@ -622,6 +631,11 @@ properties: The `location` property returns a string that contains the location of the appointment. remarks: >- + \[ [API set: Mailbox + 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) + \] + + **[Minimum permission level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** @@ -632,6 +646,16 @@ properties: -->**: Appointment Attendee + **Important**: The `enhancedLocation` property was introduced in + Mailbox requirement set 1.8. Use the `enhancedLocation` property to better + identify and manage appointment locations, especially if you need to + determine the location type. For guidance on selecting the right location + API for your scenario, see [Get or set the location when composing an + appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples diff --git a/docs/docs-ref-autogen/outlook_1_13/outlook/office.enhancedlocation.yml b/docs/docs-ref-autogen/outlook_1_13/outlook/office.enhancedlocation.yml index ff802dfb36..942dc43414 100644 --- a/docs/docs-ref-autogen/outlook_1_13/outlook/office.enhancedlocation.yml +++ b/docs/docs-ref-autogen/outlook_1_13/outlook/office.enhancedlocation.yml @@ -18,6 +18,15 @@ remarks: >- mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + + **Important**: To manage the locations of an appointment in Outlook + clients that don't support Mailbox requirement set 1.8, use the + Office.Location API instead. For guidance on selecting the right location API + for your scenario, see [Get or set the location when composing an appointmnt + in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + isPreview: false isDeprecated: false type: interface @@ -165,13 +174,7 @@ methods: uid: outlook!Office.EnhancedLocation#getAsync:member(1) package: outlook! fullName: getAsync(options, callback) - summary: >- - Gets the set of locations associated with the appointment. - - - **Note**: [Personal contact - groups](https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023) - added as appointment locations aren't returned by this method. + summary: Gets the set of locations associated with the appointment. remarks: >- \[ [API set: Mailbox 1.8](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) @@ -188,6 +191,19 @@ methods: -->**: Compose or Read + **Important**: + + + - The `getAsync` method doesn't return [personal contact + groups](https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023) + that were added to the **Location** field of an appointment. + + + - If a location was added using + `Office.context.mailbox.item.location.setAsync`, its location type + is `Office.MailboxEnums.LocationType.Custom`. + + #### Examples @@ -234,7 +250,9 @@ methods: description: >- Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, - `asyncResult`, which is an `Office.AsyncResult` object. + `asyncResult`, which is an `Office.AsyncResult` object. An + array of `Office.LocationDetails` objects representing the locations + of the appointment is returned in the `asyncResult.value` property. type: >- (asyncResult: <[]>) @@ -246,13 +264,7 @@ methods: uid: outlook!Office.EnhancedLocation#getAsync:member(2) package: outlook! fullName: getAsync(callback) - summary: >- - Gets the set of locations associated with the appointment. - - - **Note**: [Personal contact - groups](https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023) - added as appointment locations aren't returned by this method. + summary: Gets the set of locations associated with the appointment. remarks: >- \[ [API set: Mailbox 1.8](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) @@ -268,6 +280,19 @@ methods: mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + + **Important**: + + + - The `getAsync` method doesn't return [personal contact + groups](https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023) + that were added to the **Location** field of an appointment. + + + - If a location was added using + `Office.context.mailbox.item.location.setAsync`, its location type + is `Office.MailboxEnums.LocationType.Custom`. + isPreview: false isDeprecated: false syntax: @@ -279,7 +304,9 @@ methods: description: >- Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, - `asyncResult`, which is an `Office.AsyncResult` object. + `asyncResult`, which is an `Office.AsyncResult` object. An + array of `Office.LocationDetails` objects representing the locations + of the appointment is returned in the `asyncResult.value` property. type: >- (asyncResult: <[]>) diff --git a/docs/docs-ref-autogen/outlook_1_13/outlook/office.location.yml b/docs/docs-ref-autogen/outlook_1_13/outlook/office.location.yml index 127b664dc0..49de7b4b1a 100644 --- a/docs/docs-ref-autogen/outlook_1_13/outlook/office.location.yml +++ b/docs/docs-ref-autogen/outlook_1_13/outlook/office.location.yml @@ -20,6 +20,15 @@ remarks: >- mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose + + **Important**: The Office.EnhancedLocation API was introduced in Mailbox + requirement set 1.8. Use the EnhancedLocation API to better identify and + manage appointment locations, especially if you need to determine the location + type. For guidance on selecting the right location API for your scenario, see + [Get or set the location when composing an appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + isPreview: false isDeprecated: false type: interface @@ -184,6 +193,11 @@ methods: -->**: Compose + **Important**: To ensure that multiple locations resolve correctly in + Outlook, separate them with a semicolon and a space. For example, + "Conference Room 1; Conference Room 2". + + **Errors**: @@ -269,6 +283,11 @@ methods: -->**: Compose + **Important**: To ensure that multiple locations resolve correctly in + Outlook, separate them with a semicolon and a space. For example, + "Conference Room 1; Conference Room 2". + + **Errors**: diff --git a/docs/docs-ref-autogen/outlook_1_14/outlook/office.appointmentcompose.yml b/docs/docs-ref-autogen/outlook_1_14/outlook/office.appointmentcompose.yml index 6797006bd7..2db00d16cf 100644 --- a/docs/docs-ref-autogen/outlook_1_14/outlook/office.appointmentcompose.yml +++ b/docs/docs-ref-autogen/outlook_1_14/outlook/office.appointmentcompose.yml @@ -291,6 +291,15 @@ properties: -->**: Appointment Organizer + **Important**: To manage the locations of an appointment in Outlook + clients that don't support Mailbox requirement set 1.8, use the `location` + property instead. For guidance on selecting the right location API for + your scenario, see [Get or set the location when composing an appointmnt + in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples @@ -434,6 +443,11 @@ properties: provides methods that are used to get and set the location of the appointment. remarks: >- + \[ [API set: Mailbox + 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) + \] + + **[Minimum permission level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** @@ -444,6 +458,16 @@ properties: -->**: Appointment Organizer + **Important**: The `enhancedLocation` property was introduced in + Mailbox requirement set 1.8. Use the `enhancedLocation` property to better + identify and manage appointment locations, especially if you need to + determine the location type. For guidance on selecting the right location + API for your scenario, see [Get or set the location when composing an + appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples diff --git a/docs/docs-ref-autogen/outlook_1_14/outlook/office.appointmentread.yml b/docs/docs-ref-autogen/outlook_1_14/outlook/office.appointmentread.yml index f1a83a47e2..7b7a36d7e3 100644 --- a/docs/docs-ref-autogen/outlook_1_14/outlook/office.appointmentread.yml +++ b/docs/docs-ref-autogen/outlook_1_14/outlook/office.appointmentread.yml @@ -413,6 +413,15 @@ properties: -->**: Appointment Attendee + **Important**: To manage the locations of an appointment in Outlook + clients that don't support Mailbox requirement set 1.8, use the `location` + property instead. For guidance on selecting the right location API for + your scenario, see [Get or set the location when composing an appointmnt + in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples @@ -622,6 +631,11 @@ properties: The `location` property returns a string that contains the location of the appointment. remarks: >- + \[ [API set: Mailbox + 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) + \] + + **[Minimum permission level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** @@ -632,6 +646,16 @@ properties: -->**: Appointment Attendee + **Important**: The `enhancedLocation` property was introduced in + Mailbox requirement set 1.8. Use the `enhancedLocation` property to better + identify and manage appointment locations, especially if you need to + determine the location type. For guidance on selecting the right location + API for your scenario, see [Get or set the location when composing an + appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples diff --git a/docs/docs-ref-autogen/outlook_1_14/outlook/office.enhancedlocation.yml b/docs/docs-ref-autogen/outlook_1_14/outlook/office.enhancedlocation.yml index ff802dfb36..942dc43414 100644 --- a/docs/docs-ref-autogen/outlook_1_14/outlook/office.enhancedlocation.yml +++ b/docs/docs-ref-autogen/outlook_1_14/outlook/office.enhancedlocation.yml @@ -18,6 +18,15 @@ remarks: >- mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + + **Important**: To manage the locations of an appointment in Outlook + clients that don't support Mailbox requirement set 1.8, use the + Office.Location API instead. For guidance on selecting the right location API + for your scenario, see [Get or set the location when composing an appointmnt + in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + isPreview: false isDeprecated: false type: interface @@ -165,13 +174,7 @@ methods: uid: outlook!Office.EnhancedLocation#getAsync:member(1) package: outlook! fullName: getAsync(options, callback) - summary: >- - Gets the set of locations associated with the appointment. - - - **Note**: [Personal contact - groups](https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023) - added as appointment locations aren't returned by this method. + summary: Gets the set of locations associated with the appointment. remarks: >- \[ [API set: Mailbox 1.8](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) @@ -188,6 +191,19 @@ methods: -->**: Compose or Read + **Important**: + + + - The `getAsync` method doesn't return [personal contact + groups](https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023) + that were added to the **Location** field of an appointment. + + + - If a location was added using + `Office.context.mailbox.item.location.setAsync`, its location type + is `Office.MailboxEnums.LocationType.Custom`. + + #### Examples @@ -234,7 +250,9 @@ methods: description: >- Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, - `asyncResult`, which is an `Office.AsyncResult` object. + `asyncResult`, which is an `Office.AsyncResult` object. An + array of `Office.LocationDetails` objects representing the locations + of the appointment is returned in the `asyncResult.value` property. type: >- (asyncResult: <[]>) @@ -246,13 +264,7 @@ methods: uid: outlook!Office.EnhancedLocation#getAsync:member(2) package: outlook! fullName: getAsync(callback) - summary: >- - Gets the set of locations associated with the appointment. - - - **Note**: [Personal contact - groups](https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023) - added as appointment locations aren't returned by this method. + summary: Gets the set of locations associated with the appointment. remarks: >- \[ [API set: Mailbox 1.8](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) @@ -268,6 +280,19 @@ methods: mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + + **Important**: + + + - The `getAsync` method doesn't return [personal contact + groups](https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023) + that were added to the **Location** field of an appointment. + + + - If a location was added using + `Office.context.mailbox.item.location.setAsync`, its location type + is `Office.MailboxEnums.LocationType.Custom`. + isPreview: false isDeprecated: false syntax: @@ -279,7 +304,9 @@ methods: description: >- Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, - `asyncResult`, which is an `Office.AsyncResult` object. + `asyncResult`, which is an `Office.AsyncResult` object. An + array of `Office.LocationDetails` objects representing the locations + of the appointment is returned in the `asyncResult.value` property. type: >- (asyncResult: <[]>) diff --git a/docs/docs-ref-autogen/outlook_1_14/outlook/office.location.yml b/docs/docs-ref-autogen/outlook_1_14/outlook/office.location.yml index 127b664dc0..49de7b4b1a 100644 --- a/docs/docs-ref-autogen/outlook_1_14/outlook/office.location.yml +++ b/docs/docs-ref-autogen/outlook_1_14/outlook/office.location.yml @@ -20,6 +20,15 @@ remarks: >- mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose + + **Important**: The Office.EnhancedLocation API was introduced in Mailbox + requirement set 1.8. Use the EnhancedLocation API to better identify and + manage appointment locations, especially if you need to determine the location + type. For guidance on selecting the right location API for your scenario, see + [Get or set the location when composing an appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + isPreview: false isDeprecated: false type: interface @@ -184,6 +193,11 @@ methods: -->**: Compose + **Important**: To ensure that multiple locations resolve correctly in + Outlook, separate them with a semicolon and a space. For example, + "Conference Room 1; Conference Room 2". + + **Errors**: @@ -269,6 +283,11 @@ methods: -->**: Compose + **Important**: To ensure that multiple locations resolve correctly in + Outlook, separate them with a semicolon and a space. For example, + "Conference Room 1; Conference Room 2". + + **Errors**: diff --git a/docs/docs-ref-autogen/outlook_1_15/outlook/office.appointmentcompose.yml b/docs/docs-ref-autogen/outlook_1_15/outlook/office.appointmentcompose.yml index c75b849bfe..4ed2b057ac 100644 --- a/docs/docs-ref-autogen/outlook_1_15/outlook/office.appointmentcompose.yml +++ b/docs/docs-ref-autogen/outlook_1_15/outlook/office.appointmentcompose.yml @@ -291,6 +291,15 @@ properties: -->**: Appointment Organizer + **Important**: To manage the locations of an appointment in Outlook + clients that don't support Mailbox requirement set 1.8, use the `location` + property instead. For guidance on selecting the right location API for + your scenario, see [Get or set the location when composing an appointmnt + in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples @@ -434,6 +443,11 @@ properties: provides methods that are used to get and set the location of the appointment. remarks: >- + \[ [API set: Mailbox + 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) + \] + + **[Minimum permission level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** @@ -444,6 +458,16 @@ properties: -->**: Appointment Organizer + **Important**: The `enhancedLocation` property was introduced in + Mailbox requirement set 1.8. Use the `enhancedLocation` property to better + identify and manage appointment locations, especially if you need to + determine the location type. For guidance on selecting the right location + API for your scenario, see [Get or set the location when composing an + appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples diff --git a/docs/docs-ref-autogen/outlook_1_15/outlook/office.appointmentread.yml b/docs/docs-ref-autogen/outlook_1_15/outlook/office.appointmentread.yml index 946082b5ad..097f3cf0d8 100644 --- a/docs/docs-ref-autogen/outlook_1_15/outlook/office.appointmentread.yml +++ b/docs/docs-ref-autogen/outlook_1_15/outlook/office.appointmentread.yml @@ -413,6 +413,15 @@ properties: -->**: Appointment Attendee + **Important**: To manage the locations of an appointment in Outlook + clients that don't support Mailbox requirement set 1.8, use the `location` + property instead. For guidance on selecting the right location API for + your scenario, see [Get or set the location when composing an appointmnt + in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples @@ -622,6 +631,11 @@ properties: The `location` property returns a string that contains the location of the appointment. remarks: >- + \[ [API set: Mailbox + 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) + \] + + **[Minimum permission level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** @@ -632,6 +646,16 @@ properties: -->**: Appointment Attendee + **Important**: The `enhancedLocation` property was introduced in + Mailbox requirement set 1.8. Use the `enhancedLocation` property to better + identify and manage appointment locations, especially if you need to + determine the location type. For guidance on selecting the right location + API for your scenario, see [Get or set the location when composing an + appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples diff --git a/docs/docs-ref-autogen/outlook_1_15/outlook/office.enhancedlocation.yml b/docs/docs-ref-autogen/outlook_1_15/outlook/office.enhancedlocation.yml index ff802dfb36..942dc43414 100644 --- a/docs/docs-ref-autogen/outlook_1_15/outlook/office.enhancedlocation.yml +++ b/docs/docs-ref-autogen/outlook_1_15/outlook/office.enhancedlocation.yml @@ -18,6 +18,15 @@ remarks: >- mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + + **Important**: To manage the locations of an appointment in Outlook + clients that don't support Mailbox requirement set 1.8, use the + Office.Location API instead. For guidance on selecting the right location API + for your scenario, see [Get or set the location when composing an appointmnt + in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + isPreview: false isDeprecated: false type: interface @@ -165,13 +174,7 @@ methods: uid: outlook!Office.EnhancedLocation#getAsync:member(1) package: outlook! fullName: getAsync(options, callback) - summary: >- - Gets the set of locations associated with the appointment. - - - **Note**: [Personal contact - groups](https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023) - added as appointment locations aren't returned by this method. + summary: Gets the set of locations associated with the appointment. remarks: >- \[ [API set: Mailbox 1.8](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) @@ -188,6 +191,19 @@ methods: -->**: Compose or Read + **Important**: + + + - The `getAsync` method doesn't return [personal contact + groups](https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023) + that were added to the **Location** field of an appointment. + + + - If a location was added using + `Office.context.mailbox.item.location.setAsync`, its location type + is `Office.MailboxEnums.LocationType.Custom`. + + #### Examples @@ -234,7 +250,9 @@ methods: description: >- Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, - `asyncResult`, which is an `Office.AsyncResult` object. + `asyncResult`, which is an `Office.AsyncResult` object. An + array of `Office.LocationDetails` objects representing the locations + of the appointment is returned in the `asyncResult.value` property. type: >- (asyncResult: <[]>) @@ -246,13 +264,7 @@ methods: uid: outlook!Office.EnhancedLocation#getAsync:member(2) package: outlook! fullName: getAsync(callback) - summary: >- - Gets the set of locations associated with the appointment. - - - **Note**: [Personal contact - groups](https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023) - added as appointment locations aren't returned by this method. + summary: Gets the set of locations associated with the appointment. remarks: >- \[ [API set: Mailbox 1.8](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) @@ -268,6 +280,19 @@ methods: mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + + **Important**: + + + - The `getAsync` method doesn't return [personal contact + groups](https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023) + that were added to the **Location** field of an appointment. + + + - If a location was added using + `Office.context.mailbox.item.location.setAsync`, its location type + is `Office.MailboxEnums.LocationType.Custom`. + isPreview: false isDeprecated: false syntax: @@ -279,7 +304,9 @@ methods: description: >- Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, - `asyncResult`, which is an `Office.AsyncResult` object. + `asyncResult`, which is an `Office.AsyncResult` object. An + array of `Office.LocationDetails` objects representing the locations + of the appointment is returned in the `asyncResult.value` property. type: >- (asyncResult: <[]>) diff --git a/docs/docs-ref-autogen/outlook_1_15/outlook/office.location.yml b/docs/docs-ref-autogen/outlook_1_15/outlook/office.location.yml index 127b664dc0..49de7b4b1a 100644 --- a/docs/docs-ref-autogen/outlook_1_15/outlook/office.location.yml +++ b/docs/docs-ref-autogen/outlook_1_15/outlook/office.location.yml @@ -20,6 +20,15 @@ remarks: >- mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose + + **Important**: The Office.EnhancedLocation API was introduced in Mailbox + requirement set 1.8. Use the EnhancedLocation API to better identify and + manage appointment locations, especially if you need to determine the location + type. For guidance on selecting the right location API for your scenario, see + [Get or set the location when composing an appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + isPreview: false isDeprecated: false type: interface @@ -184,6 +193,11 @@ methods: -->**: Compose + **Important**: To ensure that multiple locations resolve correctly in + Outlook, separate them with a semicolon and a space. For example, + "Conference Room 1; Conference Room 2". + + **Errors**: @@ -269,6 +283,11 @@ methods: -->**: Compose + **Important**: To ensure that multiple locations resolve correctly in + Outlook, separate them with a semicolon and a space. For example, + "Conference Room 1; Conference Room 2". + + **Errors**: diff --git a/docs/docs-ref-autogen/outlook_1_2/outlook/office.appointmentcompose.yml b/docs/docs-ref-autogen/outlook_1_2/outlook/office.appointmentcompose.yml index d9ba45e8c4..dfb95d3ebc 100644 --- a/docs/docs-ref-autogen/outlook_1_2/outlook/office.appointmentcompose.yml +++ b/docs/docs-ref-autogen/outlook_1_2/outlook/office.appointmentcompose.yml @@ -219,6 +219,11 @@ properties: provides methods that are used to get and set the location of the appointment. remarks: >- + \[ [API set: Mailbox + 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) + \] + + **[Minimum permission level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** @@ -229,6 +234,16 @@ properties: -->**: Appointment Organizer + **Important**: The `enhancedLocation` property was introduced in + Mailbox requirement set 1.8. Use the `enhancedLocation` property to better + identify and manage appointment locations, especially if you need to + determine the location type. For guidance on selecting the right location + API for your scenario, see [Get or set the location when composing an + appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples diff --git a/docs/docs-ref-autogen/outlook_1_2/outlook/office.appointmentread.yml b/docs/docs-ref-autogen/outlook_1_2/outlook/office.appointmentread.yml index 26a4b022b9..721b13231e 100644 --- a/docs/docs-ref-autogen/outlook_1_2/outlook/office.appointmentread.yml +++ b/docs/docs-ref-autogen/outlook_1_2/outlook/office.appointmentread.yml @@ -451,6 +451,11 @@ properties: The `location` property returns a string that contains the location of the appointment. remarks: >- + \[ [API set: Mailbox + 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) + \] + + **[Minimum permission level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** @@ -461,6 +466,16 @@ properties: -->**: Appointment Attendee + **Important**: The `enhancedLocation` property was introduced in + Mailbox requirement set 1.8. Use the `enhancedLocation` property to better + identify and manage appointment locations, especially if you need to + determine the location type. For guidance on selecting the right location + API for your scenario, see [Get or set the location when composing an + appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples diff --git a/docs/docs-ref-autogen/outlook_1_2/outlook/office.location.yml b/docs/docs-ref-autogen/outlook_1_2/outlook/office.location.yml index 127b664dc0..49de7b4b1a 100644 --- a/docs/docs-ref-autogen/outlook_1_2/outlook/office.location.yml +++ b/docs/docs-ref-autogen/outlook_1_2/outlook/office.location.yml @@ -20,6 +20,15 @@ remarks: >- mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose + + **Important**: The Office.EnhancedLocation API was introduced in Mailbox + requirement set 1.8. Use the EnhancedLocation API to better identify and + manage appointment locations, especially if you need to determine the location + type. For guidance on selecting the right location API for your scenario, see + [Get or set the location when composing an appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + isPreview: false isDeprecated: false type: interface @@ -184,6 +193,11 @@ methods: -->**: Compose + **Important**: To ensure that multiple locations resolve correctly in + Outlook, separate them with a semicolon and a space. For example, + "Conference Room 1; Conference Room 2". + + **Errors**: @@ -269,6 +283,11 @@ methods: -->**: Compose + **Important**: To ensure that multiple locations resolve correctly in + Outlook, separate them with a semicolon and a space. For example, + "Conference Room 1; Conference Room 2". + + **Errors**: diff --git a/docs/docs-ref-autogen/outlook_1_3/outlook/office.appointmentcompose.yml b/docs/docs-ref-autogen/outlook_1_3/outlook/office.appointmentcompose.yml index 5c06d3dbd9..85564ad7c3 100644 --- a/docs/docs-ref-autogen/outlook_1_3/outlook/office.appointmentcompose.yml +++ b/docs/docs-ref-autogen/outlook_1_3/outlook/office.appointmentcompose.yml @@ -219,6 +219,11 @@ properties: provides methods that are used to get and set the location of the appointment. remarks: >- + \[ [API set: Mailbox + 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) + \] + + **[Minimum permission level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** @@ -229,6 +234,16 @@ properties: -->**: Appointment Organizer + **Important**: The `enhancedLocation` property was introduced in + Mailbox requirement set 1.8. Use the `enhancedLocation` property to better + identify and manage appointment locations, especially if you need to + determine the location type. For guidance on selecting the right location + API for your scenario, see [Get or set the location when composing an + appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples diff --git a/docs/docs-ref-autogen/outlook_1_3/outlook/office.appointmentread.yml b/docs/docs-ref-autogen/outlook_1_3/outlook/office.appointmentread.yml index 09219ed81d..ad8d9ef4aa 100644 --- a/docs/docs-ref-autogen/outlook_1_3/outlook/office.appointmentread.yml +++ b/docs/docs-ref-autogen/outlook_1_3/outlook/office.appointmentread.yml @@ -451,6 +451,11 @@ properties: The `location` property returns a string that contains the location of the appointment. remarks: >- + \[ [API set: Mailbox + 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) + \] + + **[Minimum permission level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** @@ -461,6 +466,16 @@ properties: -->**: Appointment Attendee + **Important**: The `enhancedLocation` property was introduced in + Mailbox requirement set 1.8. Use the `enhancedLocation` property to better + identify and manage appointment locations, especially if you need to + determine the location type. For guidance on selecting the right location + API for your scenario, see [Get or set the location when composing an + appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples diff --git a/docs/docs-ref-autogen/outlook_1_3/outlook/office.location.yml b/docs/docs-ref-autogen/outlook_1_3/outlook/office.location.yml index 127b664dc0..49de7b4b1a 100644 --- a/docs/docs-ref-autogen/outlook_1_3/outlook/office.location.yml +++ b/docs/docs-ref-autogen/outlook_1_3/outlook/office.location.yml @@ -20,6 +20,15 @@ remarks: >- mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose + + **Important**: The Office.EnhancedLocation API was introduced in Mailbox + requirement set 1.8. Use the EnhancedLocation API to better identify and + manage appointment locations, especially if you need to determine the location + type. For guidance on selecting the right location API for your scenario, see + [Get or set the location when composing an appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + isPreview: false isDeprecated: false type: interface @@ -184,6 +193,11 @@ methods: -->**: Compose + **Important**: To ensure that multiple locations resolve correctly in + Outlook, separate them with a semicolon and a space. For example, + "Conference Room 1; Conference Room 2". + + **Errors**: @@ -269,6 +283,11 @@ methods: -->**: Compose + **Important**: To ensure that multiple locations resolve correctly in + Outlook, separate them with a semicolon and a space. For example, + "Conference Room 1; Conference Room 2". + + **Errors**: diff --git a/docs/docs-ref-autogen/outlook_1_4/outlook/office.appointmentcompose.yml b/docs/docs-ref-autogen/outlook_1_4/outlook/office.appointmentcompose.yml index 2ada952499..edb0097fdb 100644 --- a/docs/docs-ref-autogen/outlook_1_4/outlook/office.appointmentcompose.yml +++ b/docs/docs-ref-autogen/outlook_1_4/outlook/office.appointmentcompose.yml @@ -219,6 +219,11 @@ properties: provides methods that are used to get and set the location of the appointment. remarks: >- + \[ [API set: Mailbox + 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) + \] + + **[Minimum permission level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** @@ -229,6 +234,16 @@ properties: -->**: Appointment Organizer + **Important**: The `enhancedLocation` property was introduced in + Mailbox requirement set 1.8. Use the `enhancedLocation` property to better + identify and manage appointment locations, especially if you need to + determine the location type. For guidance on selecting the right location + API for your scenario, see [Get or set the location when composing an + appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples diff --git a/docs/docs-ref-autogen/outlook_1_4/outlook/office.appointmentread.yml b/docs/docs-ref-autogen/outlook_1_4/outlook/office.appointmentread.yml index 0506ca5010..39ed109b11 100644 --- a/docs/docs-ref-autogen/outlook_1_4/outlook/office.appointmentread.yml +++ b/docs/docs-ref-autogen/outlook_1_4/outlook/office.appointmentread.yml @@ -451,6 +451,11 @@ properties: The `location` property returns a string that contains the location of the appointment. remarks: >- + \[ [API set: Mailbox + 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) + \] + + **[Minimum permission level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** @@ -461,6 +466,16 @@ properties: -->**: Appointment Attendee + **Important**: The `enhancedLocation` property was introduced in + Mailbox requirement set 1.8. Use the `enhancedLocation` property to better + identify and manage appointment locations, especially if you need to + determine the location type. For guidance on selecting the right location + API for your scenario, see [Get or set the location when composing an + appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples diff --git a/docs/docs-ref-autogen/outlook_1_4/outlook/office.location.yml b/docs/docs-ref-autogen/outlook_1_4/outlook/office.location.yml index 127b664dc0..49de7b4b1a 100644 --- a/docs/docs-ref-autogen/outlook_1_4/outlook/office.location.yml +++ b/docs/docs-ref-autogen/outlook_1_4/outlook/office.location.yml @@ -20,6 +20,15 @@ remarks: >- mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose + + **Important**: The Office.EnhancedLocation API was introduced in Mailbox + requirement set 1.8. Use the EnhancedLocation API to better identify and + manage appointment locations, especially if you need to determine the location + type. For guidance on selecting the right location API for your scenario, see + [Get or set the location when composing an appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + isPreview: false isDeprecated: false type: interface @@ -184,6 +193,11 @@ methods: -->**: Compose + **Important**: To ensure that multiple locations resolve correctly in + Outlook, separate them with a semicolon and a space. For example, + "Conference Room 1; Conference Room 2". + + **Errors**: @@ -269,6 +283,11 @@ methods: -->**: Compose + **Important**: To ensure that multiple locations resolve correctly in + Outlook, separate them with a semicolon and a space. For example, + "Conference Room 1; Conference Room 2". + + **Errors**: diff --git a/docs/docs-ref-autogen/outlook_1_5/outlook/office.appointmentcompose.yml b/docs/docs-ref-autogen/outlook_1_5/outlook/office.appointmentcompose.yml index 95a3c05d5a..7b19861b5b 100644 --- a/docs/docs-ref-autogen/outlook_1_5/outlook/office.appointmentcompose.yml +++ b/docs/docs-ref-autogen/outlook_1_5/outlook/office.appointmentcompose.yml @@ -219,6 +219,11 @@ properties: provides methods that are used to get and set the location of the appointment. remarks: >- + \[ [API set: Mailbox + 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) + \] + + **[Minimum permission level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** @@ -229,6 +234,16 @@ properties: -->**: Appointment Organizer + **Important**: The `enhancedLocation` property was introduced in + Mailbox requirement set 1.8. Use the `enhancedLocation` property to better + identify and manage appointment locations, especially if you need to + determine the location type. For guidance on selecting the right location + API for your scenario, see [Get or set the location when composing an + appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples diff --git a/docs/docs-ref-autogen/outlook_1_5/outlook/office.appointmentread.yml b/docs/docs-ref-autogen/outlook_1_5/outlook/office.appointmentread.yml index dca04d2acc..598527ce1b 100644 --- a/docs/docs-ref-autogen/outlook_1_5/outlook/office.appointmentread.yml +++ b/docs/docs-ref-autogen/outlook_1_5/outlook/office.appointmentread.yml @@ -451,6 +451,11 @@ properties: The `location` property returns a string that contains the location of the appointment. remarks: >- + \[ [API set: Mailbox + 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) + \] + + **[Minimum permission level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** @@ -461,6 +466,16 @@ properties: -->**: Appointment Attendee + **Important**: The `enhancedLocation` property was introduced in + Mailbox requirement set 1.8. Use the `enhancedLocation` property to better + identify and manage appointment locations, especially if you need to + determine the location type. For guidance on selecting the right location + API for your scenario, see [Get or set the location when composing an + appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples diff --git a/docs/docs-ref-autogen/outlook_1_5/outlook/office.location.yml b/docs/docs-ref-autogen/outlook_1_5/outlook/office.location.yml index 127b664dc0..49de7b4b1a 100644 --- a/docs/docs-ref-autogen/outlook_1_5/outlook/office.location.yml +++ b/docs/docs-ref-autogen/outlook_1_5/outlook/office.location.yml @@ -20,6 +20,15 @@ remarks: >- mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose + + **Important**: The Office.EnhancedLocation API was introduced in Mailbox + requirement set 1.8. Use the EnhancedLocation API to better identify and + manage appointment locations, especially if you need to determine the location + type. For guidance on selecting the right location API for your scenario, see + [Get or set the location when composing an appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + isPreview: false isDeprecated: false type: interface @@ -184,6 +193,11 @@ methods: -->**: Compose + **Important**: To ensure that multiple locations resolve correctly in + Outlook, separate them with a semicolon and a space. For example, + "Conference Room 1; Conference Room 2". + + **Errors**: @@ -269,6 +283,11 @@ methods: -->**: Compose + **Important**: To ensure that multiple locations resolve correctly in + Outlook, separate them with a semicolon and a space. For example, + "Conference Room 1; Conference Room 2". + + **Errors**: diff --git a/docs/docs-ref-autogen/outlook_1_6/outlook/office.appointmentcompose.yml b/docs/docs-ref-autogen/outlook_1_6/outlook/office.appointmentcompose.yml index ef52b7dd8a..a3698842c2 100644 --- a/docs/docs-ref-autogen/outlook_1_6/outlook/office.appointmentcompose.yml +++ b/docs/docs-ref-autogen/outlook_1_6/outlook/office.appointmentcompose.yml @@ -219,6 +219,11 @@ properties: provides methods that are used to get and set the location of the appointment. remarks: >- + \[ [API set: Mailbox + 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) + \] + + **[Minimum permission level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** @@ -229,6 +234,16 @@ properties: -->**: Appointment Organizer + **Important**: The `enhancedLocation` property was introduced in + Mailbox requirement set 1.8. Use the `enhancedLocation` property to better + identify and manage appointment locations, especially if you need to + determine the location type. For guidance on selecting the right location + API for your scenario, see [Get or set the location when composing an + appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples diff --git a/docs/docs-ref-autogen/outlook_1_6/outlook/office.appointmentread.yml b/docs/docs-ref-autogen/outlook_1_6/outlook/office.appointmentread.yml index 3343e2dabb..4b0e7ba0d0 100644 --- a/docs/docs-ref-autogen/outlook_1_6/outlook/office.appointmentread.yml +++ b/docs/docs-ref-autogen/outlook_1_6/outlook/office.appointmentread.yml @@ -451,6 +451,11 @@ properties: The `location` property returns a string that contains the location of the appointment. remarks: >- + \[ [API set: Mailbox + 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) + \] + + **[Minimum permission level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** @@ -461,6 +466,16 @@ properties: -->**: Appointment Attendee + **Important**: The `enhancedLocation` property was introduced in + Mailbox requirement set 1.8. Use the `enhancedLocation` property to better + identify and manage appointment locations, especially if you need to + determine the location type. For guidance on selecting the right location + API for your scenario, see [Get or set the location when composing an + appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples diff --git a/docs/docs-ref-autogen/outlook_1_6/outlook/office.location.yml b/docs/docs-ref-autogen/outlook_1_6/outlook/office.location.yml index 127b664dc0..49de7b4b1a 100644 --- a/docs/docs-ref-autogen/outlook_1_6/outlook/office.location.yml +++ b/docs/docs-ref-autogen/outlook_1_6/outlook/office.location.yml @@ -20,6 +20,15 @@ remarks: >- mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose + + **Important**: The Office.EnhancedLocation API was introduced in Mailbox + requirement set 1.8. Use the EnhancedLocation API to better identify and + manage appointment locations, especially if you need to determine the location + type. For guidance on selecting the right location API for your scenario, see + [Get or set the location when composing an appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + isPreview: false isDeprecated: false type: interface @@ -184,6 +193,11 @@ methods: -->**: Compose + **Important**: To ensure that multiple locations resolve correctly in + Outlook, separate them with a semicolon and a space. For example, + "Conference Room 1; Conference Room 2". + + **Errors**: @@ -269,6 +283,11 @@ methods: -->**: Compose + **Important**: To ensure that multiple locations resolve correctly in + Outlook, separate them with a semicolon and a space. For example, + "Conference Room 1; Conference Room 2". + + **Errors**: diff --git a/docs/docs-ref-autogen/outlook_1_7/outlook/office.appointmentcompose.yml b/docs/docs-ref-autogen/outlook_1_7/outlook/office.appointmentcompose.yml index c780bfd38c..bce14524d8 100644 --- a/docs/docs-ref-autogen/outlook_1_7/outlook/office.appointmentcompose.yml +++ b/docs/docs-ref-autogen/outlook_1_7/outlook/office.appointmentcompose.yml @@ -219,6 +219,11 @@ properties: provides methods that are used to get and set the location of the appointment. remarks: >- + \[ [API set: Mailbox + 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) + \] + + **[Minimum permission level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** @@ -229,6 +234,16 @@ properties: -->**: Appointment Organizer + **Important**: The `enhancedLocation` property was introduced in + Mailbox requirement set 1.8. Use the `enhancedLocation` property to better + identify and manage appointment locations, especially if you need to + determine the location type. For guidance on selecting the right location + API for your scenario, see [Get or set the location when composing an + appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples diff --git a/docs/docs-ref-autogen/outlook_1_7/outlook/office.appointmentread.yml b/docs/docs-ref-autogen/outlook_1_7/outlook/office.appointmentread.yml index cf02602d30..2733ce96cb 100644 --- a/docs/docs-ref-autogen/outlook_1_7/outlook/office.appointmentread.yml +++ b/docs/docs-ref-autogen/outlook_1_7/outlook/office.appointmentread.yml @@ -451,6 +451,11 @@ properties: The `location` property returns a string that contains the location of the appointment. remarks: >- + \[ [API set: Mailbox + 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) + \] + + **[Minimum permission level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** @@ -461,6 +466,16 @@ properties: -->**: Appointment Attendee + **Important**: The `enhancedLocation` property was introduced in + Mailbox requirement set 1.8. Use the `enhancedLocation` property to better + identify and manage appointment locations, especially if you need to + determine the location type. For guidance on selecting the right location + API for your scenario, see [Get or set the location when composing an + appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples diff --git a/docs/docs-ref-autogen/outlook_1_7/outlook/office.location.yml b/docs/docs-ref-autogen/outlook_1_7/outlook/office.location.yml index 127b664dc0..49de7b4b1a 100644 --- a/docs/docs-ref-autogen/outlook_1_7/outlook/office.location.yml +++ b/docs/docs-ref-autogen/outlook_1_7/outlook/office.location.yml @@ -20,6 +20,15 @@ remarks: >- mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose + + **Important**: The Office.EnhancedLocation API was introduced in Mailbox + requirement set 1.8. Use the EnhancedLocation API to better identify and + manage appointment locations, especially if you need to determine the location + type. For guidance on selecting the right location API for your scenario, see + [Get or set the location when composing an appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + isPreview: false isDeprecated: false type: interface @@ -184,6 +193,11 @@ methods: -->**: Compose + **Important**: To ensure that multiple locations resolve correctly in + Outlook, separate them with a semicolon and a space. For example, + "Conference Room 1; Conference Room 2". + + **Errors**: @@ -269,6 +283,11 @@ methods: -->**: Compose + **Important**: To ensure that multiple locations resolve correctly in + Outlook, separate them with a semicolon and a space. For example, + "Conference Room 1; Conference Room 2". + + **Errors**: diff --git a/docs/docs-ref-autogen/outlook_1_8/outlook/office.appointmentcompose.yml b/docs/docs-ref-autogen/outlook_1_8/outlook/office.appointmentcompose.yml index 71f1ea9419..a184e8e764 100644 --- a/docs/docs-ref-autogen/outlook_1_8/outlook/office.appointmentcompose.yml +++ b/docs/docs-ref-autogen/outlook_1_8/outlook/office.appointmentcompose.yml @@ -291,6 +291,15 @@ properties: -->**: Appointment Organizer + **Important**: To manage the locations of an appointment in Outlook + clients that don't support Mailbox requirement set 1.8, use the `location` + property instead. For guidance on selecting the right location API for + your scenario, see [Get or set the location when composing an appointmnt + in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples @@ -434,6 +443,11 @@ properties: provides methods that are used to get and set the location of the appointment. remarks: >- + \[ [API set: Mailbox + 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) + \] + + **[Minimum permission level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** @@ -444,6 +458,16 @@ properties: -->**: Appointment Organizer + **Important**: The `enhancedLocation` property was introduced in + Mailbox requirement set 1.8. Use the `enhancedLocation` property to better + identify and manage appointment locations, especially if you need to + determine the location type. For guidance on selecting the right location + API for your scenario, see [Get or set the location when composing an + appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples diff --git a/docs/docs-ref-autogen/outlook_1_8/outlook/office.appointmentread.yml b/docs/docs-ref-autogen/outlook_1_8/outlook/office.appointmentread.yml index c08af7d41f..e8819fdc1c 100644 --- a/docs/docs-ref-autogen/outlook_1_8/outlook/office.appointmentread.yml +++ b/docs/docs-ref-autogen/outlook_1_8/outlook/office.appointmentread.yml @@ -413,6 +413,15 @@ properties: -->**: Appointment Attendee + **Important**: To manage the locations of an appointment in Outlook + clients that don't support Mailbox requirement set 1.8, use the `location` + property instead. For guidance on selecting the right location API for + your scenario, see [Get or set the location when composing an appointmnt + in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples @@ -622,6 +631,11 @@ properties: The `location` property returns a string that contains the location of the appointment. remarks: >- + \[ [API set: Mailbox + 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) + \] + + **[Minimum permission level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** @@ -632,6 +646,16 @@ properties: -->**: Appointment Attendee + **Important**: The `enhancedLocation` property was introduced in + Mailbox requirement set 1.8. Use the `enhancedLocation` property to better + identify and manage appointment locations, especially if you need to + determine the location type. For guidance on selecting the right location + API for your scenario, see [Get or set the location when composing an + appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples diff --git a/docs/docs-ref-autogen/outlook_1_8/outlook/office.enhancedlocation.yml b/docs/docs-ref-autogen/outlook_1_8/outlook/office.enhancedlocation.yml index ff802dfb36..942dc43414 100644 --- a/docs/docs-ref-autogen/outlook_1_8/outlook/office.enhancedlocation.yml +++ b/docs/docs-ref-autogen/outlook_1_8/outlook/office.enhancedlocation.yml @@ -18,6 +18,15 @@ remarks: >- mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + + **Important**: To manage the locations of an appointment in Outlook + clients that don't support Mailbox requirement set 1.8, use the + Office.Location API instead. For guidance on selecting the right location API + for your scenario, see [Get or set the location when composing an appointmnt + in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + isPreview: false isDeprecated: false type: interface @@ -165,13 +174,7 @@ methods: uid: outlook!Office.EnhancedLocation#getAsync:member(1) package: outlook! fullName: getAsync(options, callback) - summary: >- - Gets the set of locations associated with the appointment. - - - **Note**: [Personal contact - groups](https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023) - added as appointment locations aren't returned by this method. + summary: Gets the set of locations associated with the appointment. remarks: >- \[ [API set: Mailbox 1.8](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) @@ -188,6 +191,19 @@ methods: -->**: Compose or Read + **Important**: + + + - The `getAsync` method doesn't return [personal contact + groups](https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023) + that were added to the **Location** field of an appointment. + + + - If a location was added using + `Office.context.mailbox.item.location.setAsync`, its location type + is `Office.MailboxEnums.LocationType.Custom`. + + #### Examples @@ -234,7 +250,9 @@ methods: description: >- Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, - `asyncResult`, which is an `Office.AsyncResult` object. + `asyncResult`, which is an `Office.AsyncResult` object. An + array of `Office.LocationDetails` objects representing the locations + of the appointment is returned in the `asyncResult.value` property. type: >- (asyncResult: <[]>) @@ -246,13 +264,7 @@ methods: uid: outlook!Office.EnhancedLocation#getAsync:member(2) package: outlook! fullName: getAsync(callback) - summary: >- - Gets the set of locations associated with the appointment. - - - **Note**: [Personal contact - groups](https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023) - added as appointment locations aren't returned by this method. + summary: Gets the set of locations associated with the appointment. remarks: >- \[ [API set: Mailbox 1.8](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) @@ -268,6 +280,19 @@ methods: mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + + **Important**: + + + - The `getAsync` method doesn't return [personal contact + groups](https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023) + that were added to the **Location** field of an appointment. + + + - If a location was added using + `Office.context.mailbox.item.location.setAsync`, its location type + is `Office.MailboxEnums.LocationType.Custom`. + isPreview: false isDeprecated: false syntax: @@ -279,7 +304,9 @@ methods: description: >- Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, - `asyncResult`, which is an `Office.AsyncResult` object. + `asyncResult`, which is an `Office.AsyncResult` object. An + array of `Office.LocationDetails` objects representing the locations + of the appointment is returned in the `asyncResult.value` property. type: >- (asyncResult: <[]>) diff --git a/docs/docs-ref-autogen/outlook_1_8/outlook/office.location.yml b/docs/docs-ref-autogen/outlook_1_8/outlook/office.location.yml index 127b664dc0..49de7b4b1a 100644 --- a/docs/docs-ref-autogen/outlook_1_8/outlook/office.location.yml +++ b/docs/docs-ref-autogen/outlook_1_8/outlook/office.location.yml @@ -20,6 +20,15 @@ remarks: >- mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose + + **Important**: The Office.EnhancedLocation API was introduced in Mailbox + requirement set 1.8. Use the EnhancedLocation API to better identify and + manage appointment locations, especially if you need to determine the location + type. For guidance on selecting the right location API for your scenario, see + [Get or set the location when composing an appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + isPreview: false isDeprecated: false type: interface @@ -184,6 +193,11 @@ methods: -->**: Compose + **Important**: To ensure that multiple locations resolve correctly in + Outlook, separate them with a semicolon and a space. For example, + "Conference Room 1; Conference Room 2". + + **Errors**: @@ -269,6 +283,11 @@ methods: -->**: Compose + **Important**: To ensure that multiple locations resolve correctly in + Outlook, separate them with a semicolon and a space. For example, + "Conference Room 1; Conference Room 2". + + **Errors**: diff --git a/docs/docs-ref-autogen/outlook_1_9/outlook/office.appointmentcompose.yml b/docs/docs-ref-autogen/outlook_1_9/outlook/office.appointmentcompose.yml index 5ce58291e9..21c5d0f4d2 100644 --- a/docs/docs-ref-autogen/outlook_1_9/outlook/office.appointmentcompose.yml +++ b/docs/docs-ref-autogen/outlook_1_9/outlook/office.appointmentcompose.yml @@ -291,6 +291,15 @@ properties: -->**: Appointment Organizer + **Important**: To manage the locations of an appointment in Outlook + clients that don't support Mailbox requirement set 1.8, use the `location` + property instead. For guidance on selecting the right location API for + your scenario, see [Get or set the location when composing an appointmnt + in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples @@ -434,6 +443,11 @@ properties: provides methods that are used to get and set the location of the appointment. remarks: >- + \[ [API set: Mailbox + 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) + \] + + **[Minimum permission level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** @@ -444,6 +458,16 @@ properties: -->**: Appointment Organizer + **Important**: The `enhancedLocation` property was introduced in + Mailbox requirement set 1.8. Use the `enhancedLocation` property to better + identify and manage appointment locations, especially if you need to + determine the location type. For guidance on selecting the right location + API for your scenario, see [Get or set the location when composing an + appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples diff --git a/docs/docs-ref-autogen/outlook_1_9/outlook/office.appointmentread.yml b/docs/docs-ref-autogen/outlook_1_9/outlook/office.appointmentread.yml index d866f7fdbe..e929d26ba7 100644 --- a/docs/docs-ref-autogen/outlook_1_9/outlook/office.appointmentread.yml +++ b/docs/docs-ref-autogen/outlook_1_9/outlook/office.appointmentread.yml @@ -413,6 +413,15 @@ properties: -->**: Appointment Attendee + **Important**: To manage the locations of an appointment in Outlook + clients that don't support Mailbox requirement set 1.8, use the `location` + property instead. For guidance on selecting the right location API for + your scenario, see [Get or set the location when composing an appointmnt + in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples @@ -622,6 +631,11 @@ properties: The `location` property returns a string that contains the location of the appointment. remarks: >- + \[ [API set: Mailbox + 1.1](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) + \] + + **[Minimum permission level](https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions)**: **read item** @@ -632,6 +646,16 @@ properties: -->**: Appointment Attendee + **Important**: The `enhancedLocation` property was introduced in + Mailbox requirement set 1.8. Use the `enhancedLocation` property to better + identify and manage appointment locations, especially if you need to + determine the location type. For guidance on selecting the right location + API for your scenario, see [Get or set the location when composing an + appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + + #### Examples diff --git a/docs/docs-ref-autogen/outlook_1_9/outlook/office.enhancedlocation.yml b/docs/docs-ref-autogen/outlook_1_9/outlook/office.enhancedlocation.yml index ff802dfb36..942dc43414 100644 --- a/docs/docs-ref-autogen/outlook_1_9/outlook/office.enhancedlocation.yml +++ b/docs/docs-ref-autogen/outlook_1_9/outlook/office.enhancedlocation.yml @@ -18,6 +18,15 @@ remarks: >- mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + + **Important**: To manage the locations of an appointment in Outlook + clients that don't support Mailbox requirement set 1.8, use the + Office.Location API instead. For guidance on selecting the right location API + for your scenario, see [Get or set the location when composing an appointmnt + in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + isPreview: false isDeprecated: false type: interface @@ -165,13 +174,7 @@ methods: uid: outlook!Office.EnhancedLocation#getAsync:member(1) package: outlook! fullName: getAsync(options, callback) - summary: >- - Gets the set of locations associated with the appointment. - - - **Note**: [Personal contact - groups](https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023) - added as appointment locations aren't returned by this method. + summary: Gets the set of locations associated with the appointment. remarks: >- \[ [API set: Mailbox 1.8](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) @@ -188,6 +191,19 @@ methods: -->**: Compose or Read + **Important**: + + + - The `getAsync` method doesn't return [personal contact + groups](https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023) + that were added to the **Location** field of an appointment. + + + - If a location was added using + `Office.context.mailbox.item.location.setAsync`, its location type + is `Office.MailboxEnums.LocationType.Custom`. + + #### Examples @@ -234,7 +250,9 @@ methods: description: >- Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, - `asyncResult`, which is an `Office.AsyncResult` object. + `asyncResult`, which is an `Office.AsyncResult` object. An + array of `Office.LocationDetails` objects representing the locations + of the appointment is returned in the `asyncResult.value` property. type: >- (asyncResult: <[]>) @@ -246,13 +264,7 @@ methods: uid: outlook!Office.EnhancedLocation#getAsync:member(2) package: outlook! fullName: getAsync(callback) - summary: >- - Gets the set of locations associated with the appointment. - - - **Note**: [Personal contact - groups](https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023) - added as appointment locations aren't returned by this method. + summary: Gets the set of locations associated with the appointment. remarks: >- \[ [API set: Mailbox 1.8](/javascript/api/requirement-sets/outlook/outlook-api-requirement-sets) @@ -268,6 +280,19 @@ methods: mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose or Read + + **Important**: + + + - The `getAsync` method doesn't return [personal contact + groups](https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023) + that were added to the **Location** field of an appointment. + + + - If a location was added using + `Office.context.mailbox.item.location.setAsync`, its location type + is `Office.MailboxEnums.LocationType.Custom`. + isPreview: false isDeprecated: false syntax: @@ -279,7 +304,9 @@ methods: description: >- Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, - `asyncResult`, which is an `Office.AsyncResult` object. + `asyncResult`, which is an `Office.AsyncResult` object. An + array of `Office.LocationDetails` objects representing the locations + of the appointment is returned in the `asyncResult.value` property. type: >- (asyncResult: <[]>) diff --git a/docs/docs-ref-autogen/outlook_1_9/outlook/office.location.yml b/docs/docs-ref-autogen/outlook_1_9/outlook/office.location.yml index 127b664dc0..49de7b4b1a 100644 --- a/docs/docs-ref-autogen/outlook_1_9/outlook/office.location.yml +++ b/docs/docs-ref-autogen/outlook_1_9/outlook/office.location.yml @@ -20,6 +20,15 @@ remarks: >- mode](https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points)**: Compose + + **Important**: The Office.EnhancedLocation API was introduced in Mailbox + requirement set 1.8. Use the EnhancedLocation API to better identify and + manage appointment locations, especially if you need to determine the location + type. For guidance on selecting the right location API for your scenario, see + [Get or set the location when composing an appointmnt in + Outlook](https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment). + isPreview: false isDeprecated: false type: interface @@ -184,6 +193,11 @@ methods: -->**: Compose + **Important**: To ensure that multiple locations resolve correctly in + Outlook, separate them with a semicolon and a space. For example, + "Conference Room 1; Conference Room 2". + + **Errors**: @@ -269,6 +283,11 @@ methods: -->**: Compose + **Important**: To ensure that multiple locations resolve correctly in + Outlook, separate them with a semicolon and a space. For example, + "Conference Room 1; Conference Room 2". + + **Errors**: diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.binding.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.binding.yml index 6801ffe219..37d82977e9 100644 --- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.binding.yml +++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.binding.yml @@ -105,7 +105,7 @@ methods: package: powerpoint! fullName: getShape() summary: >- - Returns the shape represented by the binding. Will throw an error if the + Returns the shape represented by the binding. Throws an error if the binding isn't of the correct type. remarks: >- \[ [API set: PowerPointApi diff --git a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slide.yml b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slide.yml index 98b757f8be..60dc99ac0c 100644 --- a/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slide.yml +++ b/docs/docs-ref-autogen/powerpoint/powerpoint/powerpoint.slide.yml @@ -289,16 +289,16 @@ methods: summary: >- Exports the slide to its own presentation file, returned as Base64-encoded data. + + + Note: This method is optimized to export a single slide. Exporting + multiple slides can impact performance. remarks: >- \[ [API set: PowerPointApi 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] - This method is optimized to export a single slide. Exporting multiple - slides can impact performance. - - #### Examples diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.binding.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.binding.yml index 6801ffe219..37d82977e9 100644 --- a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.binding.yml +++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.binding.yml @@ -105,7 +105,7 @@ methods: package: powerpoint! fullName: getShape() summary: >- - Returns the shape represented by the binding. Will throw an error if the + Returns the shape represented by the binding. Throws an error if the binding isn't of the correct type. remarks: >- \[ [API set: PowerPointApi diff --git a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.slide.yml b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.slide.yml index 0b47f361a5..25a3a18230 100644 --- a/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.slide.yml +++ b/docs/docs-ref-autogen/powerpoint_1_8/powerpoint/powerpoint.slide.yml @@ -257,16 +257,16 @@ methods: summary: >- Exports the slide to its own presentation file, returned as Base64-encoded data. + + + Note: This method is optimized to export a single slide. Exporting + multiple slides can impact performance. remarks: >- \[ [API set: PowerPointApi 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] - This method is optimized to export a single slide. Exporting multiple - slides can impact performance. - - #### Examples diff --git a/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.binding.yml b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.binding.yml index 6801ffe219..37d82977e9 100644 --- a/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.binding.yml +++ b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.binding.yml @@ -105,7 +105,7 @@ methods: package: powerpoint! fullName: getShape() summary: >- - Returns the shape represented by the binding. Will throw an error if the + Returns the shape represented by the binding. Throws an error if the binding isn't of the correct type. remarks: >- \[ [API set: PowerPointApi diff --git a/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.slide.yml b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.slide.yml index 0b47f361a5..25a3a18230 100644 --- a/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.slide.yml +++ b/docs/docs-ref-autogen/powerpoint_1_9/powerpoint/powerpoint.slide.yml @@ -257,16 +257,16 @@ methods: summary: >- Exports the slide to its own presentation file, returned as Base64-encoded data. + + + Note: This method is optimized to export a single slide. Exporting + multiple slides can impact performance. remarks: >- \[ [API set: PowerPointApi 1.8](/javascript/api/requirement-sets/powerpoint/powerpoint-api-requirement-sets) \] - This method is optimized to export a single slide. Exporting multiple - slides can impact performance. - - #### Examples diff --git a/docs/docs-ref-autogen/word/word/word.body.yml b/docs/docs-ref-autogen/word/word/word.body.yml index 2a15a73148..78082ea555 100644 --- a/docs/docs-ref-autogen/word/word/word.body.yml +++ b/docs/docs-ref-autogen/word/word/word.body.yml @@ -129,7 +129,7 @@ properties: fullName: font summary: >- Gets the text format of the body. Use this to get and set font name, size, - color and other properties. + color, and other properties. remarks: >- \[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] diff --git a/docs/docs-ref-autogen/word/word/word.customxmlvalidationerror.yml b/docs/docs-ref-autogen/word/word/word.customxmlvalidationerror.yml index 57124e06c6..d168decbe8 100644 --- a/docs/docs-ref-autogen/word/word/word.customxmlvalidationerror.yml +++ b/docs/docs-ref-autogen/word/word/word.customxmlvalidationerror.yml @@ -53,7 +53,7 @@ properties: fullName: name summary: >- Gets the name of the error in the `CustomXmlValidationError` object. If no - errors exist, the property returns `Nothing` + errors exist, the property returns `"Nothing"`. remarks: >- \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.customxmlvalidationerrorcollectionloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.customxmlvalidationerrorcollectionloadoptions.yml index 3e7e93fcdf..5581966451 100644 --- a/docs/docs-ref-autogen/word/word/word.interfaces.customxmlvalidationerrorcollectionloadoptions.yml +++ b/docs/docs-ref-autogen/word/word/word.interfaces.customxmlvalidationerrorcollectionloadoptions.yml @@ -58,7 +58,7 @@ properties: summary: >- For EACH ITEM in the collection: Gets the name of the error in the `CustomXmlValidationError` object. If no errors exist, the property - returns `Nothing` + returns `"Nothing"`. remarks: >- \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.customxmlvalidationerrordata.yml b/docs/docs-ref-autogen/word/word/word.interfaces.customxmlvalidationerrordata.yml index 09070960db..579492343b 100644 --- a/docs/docs-ref-autogen/word/word/word.interfaces.customxmlvalidationerrordata.yml +++ b/docs/docs-ref-autogen/word/word/word.interfaces.customxmlvalidationerrordata.yml @@ -35,7 +35,7 @@ properties: fullName: name summary: >- Gets the name of the error in the `CustomXmlValidationError` object. If no - errors exist, the property returns `Nothing` + errors exist, the property returns `"Nothing"`. remarks: >- \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] diff --git a/docs/docs-ref-autogen/word/word/word.interfaces.customxmlvalidationerrorloadoptions.yml b/docs/docs-ref-autogen/word/word/word.interfaces.customxmlvalidationerrorloadoptions.yml index 1c75b21d81..e7e9831f18 100644 --- a/docs/docs-ref-autogen/word/word/word.interfaces.customxmlvalidationerrorloadoptions.yml +++ b/docs/docs-ref-autogen/word/word/word.interfaces.customxmlvalidationerrorloadoptions.yml @@ -54,7 +54,7 @@ properties: fullName: name summary: >- Gets the name of the error in the `CustomXmlValidationError` object. If no - errors exist, the property returns `Nothing` + errors exist, the property returns `"Nothing"`. remarks: >- \[ [API set: WordApi BETA (PREVIEW ONLY)](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] diff --git a/docs/docs-ref-autogen/word/word/word.selection.yml b/docs/docs-ref-autogen/word/word/word.selection.yml index ee16e6a422..bf71d99b44 100644 --- a/docs/docs-ref-autogen/word/word/word.selection.yml +++ b/docs/docs-ref-autogen/word/word/word.selection.yml @@ -1815,10 +1815,10 @@ methods: return: type: void description: '' - - name: insertXML(xml, transform) - uid: word!Word.Selection#insertXML:member(1) + - name: insertXml(xml, transform) + uid: word!Word.Selection#insertXml:member(1) package: word! - fullName: insertXML(xml, transform) + fullName: insertXml(xml, transform) summary: >- Inserts the specified XML into the document at the cursor, replacing any selected text. @@ -1829,7 +1829,7 @@ methods: isPreview: true isDeprecated: false syntax: - content: 'insertXML(xml: string, transform?: string): void;' + content: 'insertXml(xml: string, transform?: string): void;' parameters: - id: xml description: The XML string to insert. diff --git a/docs/docs-ref-autogen/word_1_1/word/word.body.yml b/docs/docs-ref-autogen/word_1_1/word/word.body.yml index 3a1145cb8d..ffbe735e84 100644 --- a/docs/docs-ref-autogen/word_1_1/word/word.body.yml +++ b/docs/docs-ref-autogen/word_1_1/word/word.body.yml @@ -68,7 +68,7 @@ properties: fullName: font summary: >- Gets the text format of the body. Use this to get and set font name, size, - color and other properties. + color, and other properties. remarks: >- \[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] diff --git a/docs/docs-ref-autogen/word_1_2/word/word.body.yml b/docs/docs-ref-autogen/word_1_2/word/word.body.yml index aabb062e3e..9ab976063b 100644 --- a/docs/docs-ref-autogen/word_1_2/word/word.body.yml +++ b/docs/docs-ref-autogen/word_1_2/word/word.body.yml @@ -68,7 +68,7 @@ properties: fullName: font summary: >- Gets the text format of the body. Use this to get and set font name, size, - color and other properties. + color, and other properties. remarks: >- \[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] diff --git a/docs/docs-ref-autogen/word_1_3/word/word.body.yml b/docs/docs-ref-autogen/word_1_3/word/word.body.yml index 222a23433b..e53767805a 100644 --- a/docs/docs-ref-autogen/word_1_3/word/word.body.yml +++ b/docs/docs-ref-autogen/word_1_3/word/word.body.yml @@ -68,7 +68,7 @@ properties: fullName: font summary: >- Gets the text format of the body. Use this to get and set font name, size, - color and other properties. + color, and other properties. remarks: >- \[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] diff --git a/docs/docs-ref-autogen/word_1_3_hidden_document/word/word.body.yml b/docs/docs-ref-autogen/word_1_3_hidden_document/word/word.body.yml index 222a23433b..e53767805a 100644 --- a/docs/docs-ref-autogen/word_1_3_hidden_document/word/word.body.yml +++ b/docs/docs-ref-autogen/word_1_3_hidden_document/word/word.body.yml @@ -68,7 +68,7 @@ properties: fullName: font summary: >- Gets the text format of the body. Use this to get and set font name, size, - color and other properties. + color, and other properties. remarks: >- \[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] diff --git a/docs/docs-ref-autogen/word_1_4/word/word.body.yml b/docs/docs-ref-autogen/word_1_4/word/word.body.yml index e86a1b59c6..bad33dbf84 100644 --- a/docs/docs-ref-autogen/word_1_4/word/word.body.yml +++ b/docs/docs-ref-autogen/word_1_4/word/word.body.yml @@ -114,7 +114,7 @@ properties: fullName: font summary: >- Gets the text format of the body. Use this to get and set font name, size, - color and other properties. + color, and other properties. remarks: >- \[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] diff --git a/docs/docs-ref-autogen/word_1_4_hidden_document/word/word.body.yml b/docs/docs-ref-autogen/word_1_4_hidden_document/word/word.body.yml index e86a1b59c6..bad33dbf84 100644 --- a/docs/docs-ref-autogen/word_1_4_hidden_document/word/word.body.yml +++ b/docs/docs-ref-autogen/word_1_4_hidden_document/word/word.body.yml @@ -114,7 +114,7 @@ properties: fullName: font summary: >- Gets the text format of the body. Use this to get and set font name, size, - color and other properties. + color, and other properties. remarks: >- \[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] diff --git a/docs/docs-ref-autogen/word_1_5/word/word.body.yml b/docs/docs-ref-autogen/word_1_5/word/word.body.yml index c8466aa19b..24c37a38a2 100644 --- a/docs/docs-ref-autogen/word_1_5/word/word.body.yml +++ b/docs/docs-ref-autogen/word_1_5/word/word.body.yml @@ -129,7 +129,7 @@ properties: fullName: font summary: >- Gets the text format of the body. Use this to get and set font name, size, - color and other properties. + color, and other properties. remarks: >- \[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] diff --git a/docs/docs-ref-autogen/word_1_5_hidden_document/word/word.body.yml b/docs/docs-ref-autogen/word_1_5_hidden_document/word/word.body.yml index c8466aa19b..24c37a38a2 100644 --- a/docs/docs-ref-autogen/word_1_5_hidden_document/word/word.body.yml +++ b/docs/docs-ref-autogen/word_1_5_hidden_document/word/word.body.yml @@ -129,7 +129,7 @@ properties: fullName: font summary: >- Gets the text format of the body. Use this to get and set font name, size, - color and other properties. + color, and other properties. remarks: >- \[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] diff --git a/docs/docs-ref-autogen/word_1_6/word/word.body.yml b/docs/docs-ref-autogen/word_1_6/word/word.body.yml index 2a7c25930f..c59ad9d3fd 100644 --- a/docs/docs-ref-autogen/word_1_6/word/word.body.yml +++ b/docs/docs-ref-autogen/word_1_6/word/word.body.yml @@ -129,7 +129,7 @@ properties: fullName: font summary: >- Gets the text format of the body. Use this to get and set font name, size, - color and other properties. + color, and other properties. remarks: >- \[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] diff --git a/docs/docs-ref-autogen/word_1_7/word/word.body.yml b/docs/docs-ref-autogen/word_1_7/word/word.body.yml index 2a7c25930f..c59ad9d3fd 100644 --- a/docs/docs-ref-autogen/word_1_7/word/word.body.yml +++ b/docs/docs-ref-autogen/word_1_7/word/word.body.yml @@ -129,7 +129,7 @@ properties: fullName: font summary: >- Gets the text format of the body. Use this to get and set font name, size, - color and other properties. + color, and other properties. remarks: >- \[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] diff --git a/docs/docs-ref-autogen/word_1_8/word/word.body.yml b/docs/docs-ref-autogen/word_1_8/word/word.body.yml index 2a7c25930f..c59ad9d3fd 100644 --- a/docs/docs-ref-autogen/word_1_8/word/word.body.yml +++ b/docs/docs-ref-autogen/word_1_8/word/word.body.yml @@ -129,7 +129,7 @@ properties: fullName: font summary: >- Gets the text format of the body. Use this to get and set font name, size, - color and other properties. + color, and other properties. remarks: >- \[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] diff --git a/docs/docs-ref-autogen/word_1_9/word/word.body.yml b/docs/docs-ref-autogen/word_1_9/word/word.body.yml index 2a7c25930f..c59ad9d3fd 100644 --- a/docs/docs-ref-autogen/word_1_9/word/word.body.yml +++ b/docs/docs-ref-autogen/word_1_9/word/word.body.yml @@ -129,7 +129,7 @@ properties: fullName: font summary: >- Gets the text format of the body. Use this to get and set font name, size, - color and other properties. + color, and other properties. remarks: >- \[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] diff --git a/docs/docs-ref-autogen/word_desktop_1_1/word/word.body.yml b/docs/docs-ref-autogen/word_desktop_1_1/word/word.body.yml index 2a7c25930f..c59ad9d3fd 100644 --- a/docs/docs-ref-autogen/word_desktop_1_1/word/word.body.yml +++ b/docs/docs-ref-autogen/word_desktop_1_1/word/word.body.yml @@ -129,7 +129,7 @@ properties: fullName: font summary: >- Gets the text format of the body. Use this to get and set font name, size, - color and other properties. + color, and other properties. remarks: >- \[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] diff --git a/docs/docs-ref-autogen/word_desktop_1_2/word/word.body.yml b/docs/docs-ref-autogen/word_desktop_1_2/word/word.body.yml index faf2907d40..4672eca9ea 100644 --- a/docs/docs-ref-autogen/word_desktop_1_2/word/word.body.yml +++ b/docs/docs-ref-autogen/word_desktop_1_2/word/word.body.yml @@ -129,7 +129,7 @@ properties: fullName: font summary: >- Gets the text format of the body. Use this to get and set font name, size, - color and other properties. + color, and other properties. remarks: >- \[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] diff --git a/docs/docs-ref-autogen/word_desktop_1_3/word/word.body.yml b/docs/docs-ref-autogen/word_desktop_1_3/word/word.body.yml index faf2907d40..4672eca9ea 100644 --- a/docs/docs-ref-autogen/word_desktop_1_3/word/word.body.yml +++ b/docs/docs-ref-autogen/word_desktop_1_3/word/word.body.yml @@ -129,7 +129,7 @@ properties: fullName: font summary: >- Gets the text format of the body. Use this to get and set font name, size, - color and other properties. + color, and other properties. remarks: >- \[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] diff --git a/docs/docs-ref-autogen/word_online/word/word.body.yml b/docs/docs-ref-autogen/word_online/word/word.body.yml index 2a7c25930f..c59ad9d3fd 100644 --- a/docs/docs-ref-autogen/word_online/word/word.body.yml +++ b/docs/docs-ref-autogen/word_online/word/word.body.yml @@ -129,7 +129,7 @@ properties: fullName: font summary: >- Gets the text format of the body. Use this to get and set font name, size, - color and other properties. + color, and other properties. remarks: >- \[ [API set: WordApi 1.1](/javascript/api/requirement-sets/word/word-api-requirement-sets) \] diff --git a/docs/includes/outlook-1_1.md b/docs/includes/outlook-1_1.md index 1574fd5341..aeca3a0a71 100644 --- a/docs/includes/outlook-1_1.md +++ b/docs/includes/outlook-1_1.md @@ -6,6 +6,7 @@ ||[addItemAttachmentAsync(itemId: any, attachmentName: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-additemattachmentasync-member(1))|Adds an Exchange item, such as a message, as an attachment to the message or appointment.| ||[body](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-body-member)|Gets an object that provides methods for manipulating the body of an item.| ||[loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void, userContext?: any)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-loadcustompropertiesasync-member(1))|Asynchronously loads custom properties for this add-in on the selected item.| +||[location](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-location-member)|Gets or sets the location of an appointment.| ||[removeAttachmentAsync(attachmentId: string, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-removeattachmentasync-member(1))|Removes an attachment from a message or appointment.| ||[removeAttachmentAsync(attachmentId: string, options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void)](/javascript/api/outlook/office.appointmentcompose#outlook-office-appointmentcompose-removeattachmentasync-member(1))|Removes an attachment from a message or appointment.| |[AppointmentForm](/javascript/api/outlook/office.appointmentform)|[body](/javascript/api/outlook/office.appointmentform#outlook-office-appointmentform-body-member)|Gets an object that provides methods for manipulating the body of an item.| @@ -19,6 +20,7 @@ ||[getRegExMatches()](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-getregexmatches-member(1))|Returns string values in the selected item that match the regular expressions defined in an add-in only manifest file.| ||[getRegExMatchesByName(name: string)](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-getregexmatchesbyname-member(1))|Returns string values in the selected item that match the named regular expression defined in an add-in only manifest file.| ||[loadCustomPropertiesAsync(callback: (asyncResult: Office.AsyncResult) => void, userContext?: any)](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-loadcustompropertiesasync-member(1))|Asynchronously loads custom properties for this add-in on the selected item.| +||[location](/javascript/api/outlook/office.appointmentread#outlook-office-appointmentread-location-member)|Gets the location of an appointment.| |[AttachmentDetails](/javascript/api/outlook/office.attachmentdetails)|[attachmentType](/javascript/api/outlook/office.attachmentdetails#outlook-office-attachmentdetails-attachmenttype-member)|Gets a value that indicates the attachment's type.| ||[contentType](/javascript/api/outlook/office.attachmentdetails#outlook-office-attachmentdetails-contenttype-member)|Gets the MIME content type of the attachment.| ||[id](/javascript/api/outlook/office.attachmentdetails#outlook-office-attachmentdetails-id-member)|Gets the Exchange attachment ID of the attachment.| diff --git a/docs/includes/word-preview.md b/docs/includes/word-preview.md index e982fe8f55..d93c8bada5 100644 --- a/docs/includes/word-preview.md +++ b/docs/includes/word-preview.md @@ -676,7 +676,7 @@ ||[insertRowsBelow(numRows: number)](/javascript/api/word/word.selection#word-word-selection-insertrowsbelow-member(1))|Inserts rows below the current selection.| ||[insertSymbol(characterNumber: number, options?: Word.SelectionInsertSymbolOptions)](/javascript/api/word/word.selection#word-word-selection-insertsymbol-member(1))|Inserts a symbol in place of the specified selection.| ||[insertText(Text: string)](/javascript/api/word/word.selection#word-word-selection-inserttext-member(1))|Inserts the specified text.| -||[insertXML(xml: string, transform?: string)](/javascript/api/word/word.selection#word-word-selection-insertxml-member(1))|Inserts the specified XML into the document at the cursor, replacing any selected text.| +||[insertXml(xml: string, transform?: string)](/javascript/api/word/word.selection#word-word-selection-insertxml-member(1))|Inserts the specified XML into the document at the cursor, replacing any selected text.| ||[isActive](/javascript/api/word/word.selection#word-word-selection-isactive-member)|Returns whether the selection in the specified window or pane is active.| ||[isColumnSelectModeActive](/javascript/api/word/word.selection#word-word-selection-iscolumnselectmodeactive-member)|Specifies whether column selection mode is active.| ||[isEndOfRowMark](/javascript/api/word/word.selection#word-word-selection-isendofrowmark-member)|Returns whether the selection is at the end-of-row mark in a table.| diff --git a/generate-docs/API Coverage Report.csv b/generate-docs/API Coverage Report.csv index cfce39fff5..65a39fca85 100644 --- a/generate-docs/API Coverage Report.csv +++ b/generate-docs/API Coverage Report.csv @@ -542,7 +542,7 @@ excel,Excel.CardLayoutListSection,N/A,Interface,Unknown,false excel,Excel.CardLayoutListSection,"layout",Property,Poor,false excel,Excel.CardLayoutPropertyReference,N/A,Interface,Unknown,false excel,Excel.CardLayoutPropertyReference,"property",Property,Good,false -excel,Excel.CardLayoutSection,N/A,TypeAlias,Fine,false +excel,Excel.CardLayoutSection,N/A,TypeAlias,Fine,true excel,Excel.CardLayoutSectionStandardProperties,N/A,Interface,Unknown,false excel,Excel.CardLayoutSectionStandardProperties,"collapsed",Property,Fine,false excel,Excel.CardLayoutSectionStandardProperties,"collapsible",Property,Excellent,false @@ -557,7 +557,7 @@ excel,Excel.CardLayoutTableSection,N/A,Interface,Unknown,false excel,Excel.CardLayoutTableSection,"layout",Property,Poor,false excel,Excel.CardLayoutTwoColumnSection,N/A,Interface,Unknown,false excel,Excel.CardLayoutTwoColumnSection,"layout",Property,Poor,false -excel,Excel.CellBorder,N/A,Interface,Unknown,false +excel,Excel.CellBorder,N/A,Interface,Unknown,true excel,Excel.CellBorder,"color",Property,Good,false excel,Excel.CellBorder,"style",Property,Good,false excel,Excel.CellBorder,"tintAndShade",Property,Good,false @@ -2435,7 +2435,7 @@ excel,Excel.DataValidationAlertStyle,N/A,Enum,Unknown,false excel,Excel.DataValidationAlertStyle,"information",EnumField,Fine,false excel,Excel.DataValidationAlertStyle,"stop",EnumField,Fine,false excel,Excel.DataValidationAlertStyle,"warning",EnumField,Fine,false -excel,Excel.DataValidationErrorAlert,N/A,Interface,Unknown,false +excel,Excel.DataValidationErrorAlert,N/A,Interface,Unknown,true excel,Excel.DataValidationErrorAlert,"message",Property,Fine,false excel,Excel.DataValidationErrorAlert,"showAlert",Property,Excellent,false excel,Excel.DataValidationErrorAlert,"style",Property,Fine,false @@ -2717,7 +2717,7 @@ excel,Excel.EntityArrayCardLayout,"displayName",Property,Excellent,false excel,Excel.EntityArrayCardLayout,"firstRowIsHeader",Property,Good,false excel,Excel.EntityArrayCardLayout,"layout",Property,Poor,false excel,Excel.EntityArrayCardLayout,"rowsToReport",Property,Good,false -excel,Excel.EntityCardLayout,N/A,Interface,Fine,false +excel,Excel.EntityCardLayout,N/A,Interface,Fine,true excel,Excel.EntityCardLayout,"layout",Property,Poor,false excel,Excel.EntityCardLayoutType,N/A,Enum,Fine,false excel,Excel.EntityCardLayoutType,"array",EnumField,Good,false @@ -3286,8 +3286,8 @@ excel,Excel.EntityCompactLayoutIcons,"xray",EnumField,Fine,false excel,Excel.EntityCompactLayoutIcons,"yoga",EnumField,Fine,false excel,Excel.EntityPropertyExtraProperties,N/A,Interface,Unknown,false excel,Excel.EntityPropertyExtraProperties,"propertyMetadata",Property,Fine,false -excel,Excel.EntityPropertyType,N/A,TypeAlias,Good,false -excel,Excel.EntityViewLayouts,N/A,Interface,Unknown,false +excel,Excel.EntityPropertyType,N/A,TypeAlias,Good,true +excel,Excel.EntityViewLayouts,N/A,Interface,Unknown,true excel,Excel.EntityViewLayouts,"card",Property,Excellent,false excel,Excel.EntityViewLayouts,"compact",Property,Great,false excel,Excel.ErrorCellValue,N/A,TypeAlias,Good,true @@ -9224,8 +9224,8 @@ outlook,Office.EmailUser,"emailAddress",Property,Poor,false outlook,Office.EnhancedLocation,N/A,Interface,Unknown,false outlook,Office.EnhancedLocation,"addAsync(locationIdentifiers, options, callback)",Method,Fine,true outlook,Office.EnhancedLocation,"addAsync(locationIdentifiers, callback)",Method,Fine,false -outlook,Office.EnhancedLocation,"getAsync(options, callback)",Method,Good,true -outlook,Office.EnhancedLocation,"getAsync(callback)",Method,Good,false +outlook,Office.EnhancedLocation,"getAsync(options, callback)",Method,Fine,true +outlook,Office.EnhancedLocation,"getAsync(callback)",Method,Fine,false outlook,Office.EnhancedLocation,"removeAsync(locationIdentifiers, options, callback)",Method,Good,true outlook,Office.EnhancedLocation,"removeAsync(locationIdentifiers, callback)",Method,Good,false outlook,Office.EnhancedLocationsChangedEventArgs,N/A,Interface,Fine,true @@ -9361,7 +9361,7 @@ outlook,Office.Location,N/A,Interface,Unknown,false outlook,Office.Location,"getAsync(options, callback)",Method,Excellent,true outlook,Office.Location,"getAsync(callback)",Method,Excellent,true outlook,Office.Location,"setAsync(location, options, callback)",Method,Good,true -outlook,Office.Location,"setAsync(location, callback)",Method,Good,false +outlook,Office.Location,"setAsync(location, callback)",Method,Good,true outlook,Office.LocationDetails,N/A,Interface,Unknown,true outlook,Office.LocationDetails,"displayName",Property,Poor,false outlook,Office.LocationDetails,"emailAddress",Property,Fine,false @@ -10780,7 +10780,7 @@ powerpoint,PowerPoint.ShapeZOrder,"bringForward",EnumField,Fine,false powerpoint,PowerPoint.ShapeZOrder,"bringToFront",EnumField,Fine,false powerpoint,PowerPoint.ShapeZOrder,"sendBackward",EnumField,Fine,false powerpoint,PowerPoint.ShapeZOrder,"sendToBack",EnumField,Fine,false -powerpoint,PowerPoint.Slide,N/A,Class,Good,true +powerpoint,PowerPoint.Slide,N/A,Class,Unknown,true powerpoint,PowerPoint.Slide,"background",Property,Poor,false powerpoint,PowerPoint.Slide,"context",Property,Excellent,false powerpoint,PowerPoint.Slide,"customXmlParts",Property,Good,false @@ -10794,7 +10794,7 @@ powerpoint,PowerPoint.Slide,"tags",Property,Fine,false powerpoint,PowerPoint.Slide,"themeColorScheme",Property,Fine,false powerpoint,PowerPoint.Slide,"applyLayout(slideLayout)",Method,Good,false powerpoint,PowerPoint.Slide,"delete()",Method,Great,true -powerpoint,PowerPoint.Slide,"exportAsBase64()",Method,Fine,true +powerpoint,PowerPoint.Slide,"exportAsBase64()",Method,Good,true powerpoint,PowerPoint.Slide,"getImageAsBase64(options)",Method,Great,true powerpoint,PowerPoint.Slide,"load(options)",Method,Excellent,false powerpoint,PowerPoint.Slide,"load(propertyNames)",Method,Excellent,false @@ -17219,7 +17219,7 @@ word,Word.Selection,"insertRowsAbove(numRows)",Method,Poor,false word,Word.Selection,"insertRowsBelow(numRows)",Method,Poor,false word,Word.Selection,"insertSymbol(characterNumber, options)",Method,Good,false word,Word.Selection,"insertText(Text)",Method,Fine,false -word,Word.Selection,"insertXML(xml, transform)",Method,Good,false +word,Word.Selection,"insertXml(xml, transform)",Method,Good,false word,Word.Selection,"isEqual(range)",Method,Great,false word,Word.Selection,"isInRange(range)",Method,Excellent,false word,Word.Selection,"isInStory(range)",Method,Great,false diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_1/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-excel-release/Excel_1_1/tsdoc-metadata.json index d95757eac5..018ab4c3f2 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_1/tsdoc-metadata.json +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_1/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.52.13" + "packageVersion": "7.52.15" } ] } diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_10/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-excel-release/Excel_1_10/tsdoc-metadata.json index d95757eac5..018ab4c3f2 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_10/tsdoc-metadata.json +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_10/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.52.13" + "packageVersion": "7.52.15" } ] } diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_11/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-excel-release/Excel_1_11/tsdoc-metadata.json index d95757eac5..018ab4c3f2 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_11/tsdoc-metadata.json +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_11/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.52.13" + "packageVersion": "7.52.15" } ] } diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_12/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-excel-release/Excel_1_12/tsdoc-metadata.json index d95757eac5..018ab4c3f2 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_12/tsdoc-metadata.json +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_12/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.52.13" + "packageVersion": "7.52.15" } ] } diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_13/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-excel-release/Excel_1_13/tsdoc-metadata.json index d95757eac5..018ab4c3f2 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_13/tsdoc-metadata.json +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_13/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.52.13" + "packageVersion": "7.52.15" } ] } diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_14/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-excel-release/Excel_1_14/tsdoc-metadata.json index d95757eac5..018ab4c3f2 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_14/tsdoc-metadata.json +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_14/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.52.13" + "packageVersion": "7.52.15" } ] } diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_15/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-excel-release/Excel_1_15/tsdoc-metadata.json index d95757eac5..018ab4c3f2 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_15/tsdoc-metadata.json +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_15/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.52.13" + "packageVersion": "7.52.15" } ] } diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_16/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-excel-release/Excel_1_16/tsdoc-metadata.json index d95757eac5..018ab4c3f2 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_16/tsdoc-metadata.json +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_16/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.52.13" + "packageVersion": "7.52.15" } ] } diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_17/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-excel-release/Excel_1_17/tsdoc-metadata.json index d95757eac5..018ab4c3f2 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_17/tsdoc-metadata.json +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_17/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.52.13" + "packageVersion": "7.52.15" } ] } diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_18/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-excel-release/Excel_1_18/tsdoc-metadata.json index d95757eac5..018ab4c3f2 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_18/tsdoc-metadata.json +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_18/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.52.13" + "packageVersion": "7.52.15" } ] } diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_19/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-excel-release/Excel_1_19/tsdoc-metadata.json index d95757eac5..018ab4c3f2 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_19/tsdoc-metadata.json +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_19/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.52.13" + "packageVersion": "7.52.15" } ] } diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_2/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-excel-release/Excel_1_2/tsdoc-metadata.json index d95757eac5..018ab4c3f2 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_2/tsdoc-metadata.json +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_2/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.52.13" + "packageVersion": "7.52.15" } ] } diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_20/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-excel-release/Excel_1_20/tsdoc-metadata.json index d95757eac5..018ab4c3f2 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_20/tsdoc-metadata.json +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_20/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.52.13" + "packageVersion": "7.52.15" } ] } diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_3/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-excel-release/Excel_1_3/tsdoc-metadata.json index d95757eac5..018ab4c3f2 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_3/tsdoc-metadata.json +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_3/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.52.13" + "packageVersion": "7.52.15" } ] } diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_4/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-excel-release/Excel_1_4/tsdoc-metadata.json index d95757eac5..018ab4c3f2 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_4/tsdoc-metadata.json +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_4/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.52.13" + "packageVersion": "7.52.15" } ] } diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_5/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-excel-release/Excel_1_5/tsdoc-metadata.json index d95757eac5..018ab4c3f2 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_5/tsdoc-metadata.json +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_5/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.52.13" + "packageVersion": "7.52.15" } ] } diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_6/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-excel-release/Excel_1_6/tsdoc-metadata.json index d95757eac5..018ab4c3f2 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_6/tsdoc-metadata.json +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_6/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.52.13" + "packageVersion": "7.52.15" } ] } diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_7/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-excel-release/Excel_1_7/tsdoc-metadata.json index d95757eac5..018ab4c3f2 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_7/tsdoc-metadata.json +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_7/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.52.13" + "packageVersion": "7.52.15" } ] } diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_8/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-excel-release/Excel_1_8/tsdoc-metadata.json index d95757eac5..018ab4c3f2 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_8/tsdoc-metadata.json +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_8/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.52.13" + "packageVersion": "7.52.15" } ] } diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_1_9/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-excel-release/Excel_1_9/tsdoc-metadata.json index d95757eac5..018ab4c3f2 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_1_9/tsdoc-metadata.json +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_1_9/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.52.13" + "packageVersion": "7.52.15" } ] } diff --git a/generate-docs/api-extractor-inputs-excel-release/Excel_online/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-excel-release/Excel_online/tsdoc-metadata.json index d95757eac5..018ab4c3f2 100644 --- a/generate-docs/api-extractor-inputs-excel-release/Excel_online/tsdoc-metadata.json +++ b/generate-docs/api-extractor-inputs-excel-release/Excel_online/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.52.13" + "packageVersion": "7.52.15" } ] } diff --git a/generate-docs/api-extractor-inputs-excel/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-excel/tsdoc-metadata.json index d95757eac5..018ab4c3f2 100644 --- a/generate-docs/api-extractor-inputs-excel/tsdoc-metadata.json +++ b/generate-docs/api-extractor-inputs-excel/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.52.13" + "packageVersion": "7.52.15" } ] } diff --git a/generate-docs/api-extractor-inputs-office/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-office/tsdoc-metadata.json index d95757eac5..018ab4c3f2 100644 --- a/generate-docs/api-extractor-inputs-office/tsdoc-metadata.json +++ b/generate-docs/api-extractor-inputs-office/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.52.13" + "packageVersion": "7.52.15" } ] } diff --git a/generate-docs/api-extractor-inputs-onenote/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-onenote/tsdoc-metadata.json index d95757eac5..018ab4c3f2 100644 --- a/generate-docs/api-extractor-inputs-onenote/tsdoc-metadata.json +++ b/generate-docs/api-extractor-inputs-onenote/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.52.13" + "packageVersion": "7.52.15" } ] } diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_1/Outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_1/Outlook.d.ts index 31266ef414..b5e645b7f8 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_1/Outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_1/Outlook.d.ts @@ -423,9 +423,15 @@ export declare namespace Office { * * @remarks * + * [Api set: Mailbox 1.1] + * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer + * + * **Important**: The `enhancedLocation` property was introduced in Mailbox requirement set 1.8. Use the `enhancedLocation` property to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ location: Location; @@ -1090,9 +1096,15 @@ export declare namespace Office { * * @remarks * + * [Api set: Mailbox 1.1] + * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee + * + * **Important**: The `enhancedLocation` property was introduced in Mailbox requirement set 1.8. Use the `enhancedLocation` property to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ location: string; /** @@ -2344,6 +2356,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose + * + * **Important**: The Office.EnhancedLocation API was introduced in Mailbox requirement set 1.8. Use the EnhancedLocation API to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ export interface Location { /** @@ -2395,6 +2411,9 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * + * **Important**: To ensure that multiple locations resolve correctly in Outlook, separate them with a semicolon and a space. For example, + * "Conference Room 1; Conference Room 2". + * * **Errors**: * * - DataExceedsMaximumSize: The location parameter is longer than 255 characters. @@ -2419,6 +2438,9 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * + * **Important**: To ensure that multiple locations resolve correctly in Outlook, separate them with a semicolon and a space. For example, + * "Conference Room 1; Conference Room 2". + * * **Errors**: * * - DataExceedsMaximumSize: The location parameter is longer than 255 characters. diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_1/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_1/tsdoc-metadata.json index d95757eac5..018ab4c3f2 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_1/tsdoc-metadata.json +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_1/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.52.13" + "packageVersion": "7.52.15" } ] } diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_10/outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_10/outlook.d.ts index 8f23579298..5f04da76ed 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_10/outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_10/outlook.d.ts @@ -1512,6 +1512,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer + * + * **Important**: To manage the locations of an appointment in Outlook clients that don't support Mailbox requirement set 1.8, use the `location` property instead. + * For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ enhancedLocation: EnhancedLocation; /** @@ -1532,9 +1536,15 @@ export declare namespace Office { * * @remarks * + * [Api set: Mailbox 1.1] + * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer + * + * **Important**: The `enhancedLocation` property was introduced in Mailbox requirement set 1.8. Use the `enhancedLocation` property to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ location: Location; /** @@ -2929,6 +2939,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee + * + * **Important**: To manage the locations of an appointment in Outlook clients that don't support Mailbox requirement set 1.8, use the `location` property instead. + * For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ enhancedLocation: EnhancedLocation; /** @@ -2984,9 +2998,15 @@ export declare namespace Office { * * @remarks * + * [Api set: Mailbox 1.1] + * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee + * + * **Important**: The `enhancedLocation` property was introduced in Mailbox requirement set 1.8. Use the `enhancedLocation` property to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ location: string; /** @@ -5346,6 +5366,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * + * **Important**: To manage the locations of an appointment in Outlook clients that don't support Mailbox requirement set 1.8, use the Office.Location API instead. + * For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ export interface EnhancedLocation { /** @@ -5391,9 +5415,6 @@ export declare namespace Office { /** * Gets the set of locations associated with the appointment. * - * **Note**: {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | Personal contact groups} - * added as appointment locations aren't returned by this method. - * * @remarks * [Api set: Mailbox 1.8] * @@ -5401,18 +5422,23 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * + * **Important**: + * + * - The `getAsync` method doesn't return {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | personal contact groups} that + * were added to the **Location** field of an appointment. + * + * - If a location was added using `Office.context.mailbox.item.location.setAsync`, its location type is `Office.MailboxEnums.LocationType.Custom`. + * * @param options - An object literal that contains one or more of the following properties:- * `asyncContext`: Developers can provide any object they wish to access in the callback function. * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, - * `asyncResult`, which is an `Office.AsyncResult` object. + * `asyncResult`, which is an `Office.AsyncResult` object. An array of `Office.LocationDetails` objects representing the locations of the + * appointment is returned in the `asyncResult.value` property. */ getAsync(options: CommonAPI.AsyncContextOptions, callback?: (asyncResult: CommonAPI.AsyncResult) => void): void; /** * Gets the set of locations associated with the appointment. * - * **Note**: {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | Personal contact groups} - * added as appointment locations aren't returned by this method. - * * @remarks * [Api set: Mailbox 1.8] * @@ -5420,8 +5446,16 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * + * **Important**: + * + * - The `getAsync` method doesn't return {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | personal contact groups} that + * were added to the **Location** field of an appointment. + * + * - If a location was added using `Office.context.mailbox.item.location.setAsync`, its location type is `Office.MailboxEnums.LocationType.Custom`. + * * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, - * `asyncResult`, which is an `Office.AsyncResult` object. + * `asyncResult`, which is an `Office.AsyncResult` object. An array of `Office.LocationDetails` objects representing the locations of the + * appointment is returned in the `asyncResult.value` property. */ getAsync(callback?: (asyncResult: CommonAPI.AsyncResult) => void): void; /** @@ -6041,6 +6075,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose + * + * **Important**: The Office.EnhancedLocation API was introduced in Mailbox requirement set 1.8. Use the EnhancedLocation API to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ export interface Location { /** @@ -6092,6 +6130,9 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * + * **Important**: To ensure that multiple locations resolve correctly in Outlook, separate them with a semicolon and a space. For example, + * "Conference Room 1; Conference Room 2". + * * **Errors**: * * - DataExceedsMaximumSize: The location parameter is longer than 255 characters. @@ -6116,6 +6157,9 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * + * **Important**: To ensure that multiple locations resolve correctly in Outlook, separate them with a semicolon and a space. For example, + * "Conference Room 1; Conference Room 2". + * * **Errors**: * * - DataExceedsMaximumSize: The location parameter is longer than 255 characters. diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_10/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_10/tsdoc-metadata.json index d95757eac5..018ab4c3f2 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_10/tsdoc-metadata.json +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_10/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.52.13" + "packageVersion": "7.52.15" } ] } diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_11/outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_11/outlook.d.ts index 93acc5a15b..e3904f5f94 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_11/outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_11/outlook.d.ts @@ -1512,6 +1512,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer + * + * **Important**: To manage the locations of an appointment in Outlook clients that don't support Mailbox requirement set 1.8, use the `location` property instead. + * For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ enhancedLocation: EnhancedLocation; /** @@ -1532,9 +1536,15 @@ export declare namespace Office { * * @remarks * + * [Api set: Mailbox 1.1] + * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer + * + * **Important**: The `enhancedLocation` property was introduced in Mailbox requirement set 1.8. Use the `enhancedLocation` property to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ location: Location; /** @@ -2941,6 +2951,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee + * + * **Important**: To manage the locations of an appointment in Outlook clients that don't support Mailbox requirement set 1.8, use the `location` property instead. + * For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ enhancedLocation: EnhancedLocation; /** @@ -2996,9 +3010,15 @@ export declare namespace Office { * * @remarks * + * [Api set: Mailbox 1.1] + * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee + * + * **Important**: The `enhancedLocation` property was introduced in Mailbox requirement set 1.8. Use the `enhancedLocation` property to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ location: string; /** @@ -5358,6 +5378,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * + * **Important**: To manage the locations of an appointment in Outlook clients that don't support Mailbox requirement set 1.8, use the Office.Location API instead. + * For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ export interface EnhancedLocation { /** @@ -5403,9 +5427,6 @@ export declare namespace Office { /** * Gets the set of locations associated with the appointment. * - * **Note**: {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | Personal contact groups} - * added as appointment locations aren't returned by this method. - * * @remarks * [Api set: Mailbox 1.8] * @@ -5413,18 +5434,23 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * + * **Important**: + * + * - The `getAsync` method doesn't return {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | personal contact groups} that + * were added to the **Location** field of an appointment. + * + * - If a location was added using `Office.context.mailbox.item.location.setAsync`, its location type is `Office.MailboxEnums.LocationType.Custom`. + * * @param options - An object literal that contains one or more of the following properties:- * `asyncContext`: Developers can provide any object they wish to access in the callback function. * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, - * `asyncResult`, which is an `Office.AsyncResult` object. + * `asyncResult`, which is an `Office.AsyncResult` object. An array of `Office.LocationDetails` objects representing the locations of the + * appointment is returned in the `asyncResult.value` property. */ getAsync(options: CommonAPI.AsyncContextOptions, callback?: (asyncResult: CommonAPI.AsyncResult) => void): void; /** * Gets the set of locations associated with the appointment. * - * **Note**: {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | Personal contact groups} - * added as appointment locations aren't returned by this method. - * * @remarks * [Api set: Mailbox 1.8] * @@ -5432,8 +5458,16 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * + * **Important**: + * + * - The `getAsync` method doesn't return {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | personal contact groups} that + * were added to the **Location** field of an appointment. + * + * - If a location was added using `Office.context.mailbox.item.location.setAsync`, its location type is `Office.MailboxEnums.LocationType.Custom`. + * * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, - * `asyncResult`, which is an `Office.AsyncResult` object. + * `asyncResult`, which is an `Office.AsyncResult` object. An array of `Office.LocationDetails` objects representing the locations of the + * appointment is returned in the `asyncResult.value` property. */ getAsync(callback?: (asyncResult: CommonAPI.AsyncResult) => void): void; /** @@ -6053,6 +6087,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose + * + * **Important**: The Office.EnhancedLocation API was introduced in Mailbox requirement set 1.8. Use the EnhancedLocation API to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ export interface Location { /** @@ -6104,6 +6142,9 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * + * **Important**: To ensure that multiple locations resolve correctly in Outlook, separate them with a semicolon and a space. For example, + * "Conference Room 1; Conference Room 2". + * * **Errors**: * * - DataExceedsMaximumSize: The location parameter is longer than 255 characters. @@ -6128,6 +6169,9 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * + * **Important**: To ensure that multiple locations resolve correctly in Outlook, separate them with a semicolon and a space. For example, + * "Conference Room 1; Conference Room 2". + * * **Errors**: * * - DataExceedsMaximumSize: The location parameter is longer than 255 characters. diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_11/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_11/tsdoc-metadata.json index d95757eac5..018ab4c3f2 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_11/tsdoc-metadata.json +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_11/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.52.13" + "packageVersion": "7.52.15" } ] } diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_12/outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_12/outlook.d.ts index f816bf6545..aa37017353 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_12/outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_12/outlook.d.ts @@ -1512,6 +1512,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer + * + * **Important**: To manage the locations of an appointment in Outlook clients that don't support Mailbox requirement set 1.8, use the `location` property instead. + * For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ enhancedLocation: EnhancedLocation; /** @@ -1532,9 +1536,15 @@ export declare namespace Office { * * @remarks * + * [Api set: Mailbox 1.1] + * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer + * + * **Important**: The `enhancedLocation` property was introduced in Mailbox requirement set 1.8. Use the `enhancedLocation` property to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ location: Location; /** @@ -2941,6 +2951,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee + * + * **Important**: To manage the locations of an appointment in Outlook clients that don't support Mailbox requirement set 1.8, use the `location` property instead. + * For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ enhancedLocation: EnhancedLocation; /** @@ -2996,9 +3010,15 @@ export declare namespace Office { * * @remarks * + * [Api set: Mailbox 1.1] + * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee + * + * **Important**: The `enhancedLocation` property was introduced in Mailbox requirement set 1.8. Use the `enhancedLocation` property to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ location: string; /** @@ -5358,6 +5378,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * + * **Important**: To manage the locations of an appointment in Outlook clients that don't support Mailbox requirement set 1.8, use the Office.Location API instead. + * For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ export interface EnhancedLocation { /** @@ -5403,9 +5427,6 @@ export declare namespace Office { /** * Gets the set of locations associated with the appointment. * - * **Note**: {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | Personal contact groups} - * added as appointment locations aren't returned by this method. - * * @remarks * [Api set: Mailbox 1.8] * @@ -5413,18 +5434,23 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * + * **Important**: + * + * - The `getAsync` method doesn't return {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | personal contact groups} that + * were added to the **Location** field of an appointment. + * + * - If a location was added using `Office.context.mailbox.item.location.setAsync`, its location type is `Office.MailboxEnums.LocationType.Custom`. + * * @param options - An object literal that contains one or more of the following properties:- * `asyncContext`: Developers can provide any object they wish to access in the callback function. * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, - * `asyncResult`, which is an `Office.AsyncResult` object. + * `asyncResult`, which is an `Office.AsyncResult` object. An array of `Office.LocationDetails` objects representing the locations of the + * appointment is returned in the `asyncResult.value` property. */ getAsync(options: CommonAPI.AsyncContextOptions, callback?: (asyncResult: CommonAPI.AsyncResult) => void): void; /** * Gets the set of locations associated with the appointment. * - * **Note**: {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | Personal contact groups} - * added as appointment locations aren't returned by this method. - * * @remarks * [Api set: Mailbox 1.8] * @@ -5432,8 +5458,16 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * + * **Important**: + * + * - The `getAsync` method doesn't return {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | personal contact groups} that + * were added to the **Location** field of an appointment. + * + * - If a location was added using `Office.context.mailbox.item.location.setAsync`, its location type is `Office.MailboxEnums.LocationType.Custom`. + * * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, - * `asyncResult`, which is an `Office.AsyncResult` object. + * `asyncResult`, which is an `Office.AsyncResult` object. An array of `Office.LocationDetails` objects representing the locations of the + * appointment is returned in the `asyncResult.value` property. */ getAsync(callback?: (asyncResult: CommonAPI.AsyncResult) => void): void; /** @@ -6053,6 +6087,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose + * + * **Important**: The Office.EnhancedLocation API was introduced in Mailbox requirement set 1.8. Use the EnhancedLocation API to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ export interface Location { /** @@ -6104,6 +6142,9 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * + * **Important**: To ensure that multiple locations resolve correctly in Outlook, separate them with a semicolon and a space. For example, + * "Conference Room 1; Conference Room 2". + * * **Errors**: * * - DataExceedsMaximumSize: The location parameter is longer than 255 characters. @@ -6128,6 +6169,9 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * + * **Important**: To ensure that multiple locations resolve correctly in Outlook, separate them with a semicolon and a space. For example, + * "Conference Room 1; Conference Room 2". + * * **Errors**: * * - DataExceedsMaximumSize: The location parameter is longer than 255 characters. diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_12/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_12/tsdoc-metadata.json index d95757eac5..018ab4c3f2 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_12/tsdoc-metadata.json +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_12/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.52.13" + "packageVersion": "7.52.15" } ] } diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_13/outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_13/outlook.d.ts index f5ae64e104..557e144571 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_13/outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_13/outlook.d.ts @@ -1512,6 +1512,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer + * + * **Important**: To manage the locations of an appointment in Outlook clients that don't support Mailbox requirement set 1.8, use the `location` property instead. + * For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ enhancedLocation: EnhancedLocation; /** @@ -1532,9 +1536,15 @@ export declare namespace Office { * * @remarks * + * [Api set: Mailbox 1.1] + * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer + * + * **Important**: The `enhancedLocation` property was introduced in Mailbox requirement set 1.8. Use the `enhancedLocation` property to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ location: Location; /** @@ -2956,6 +2966,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee + * + * **Important**: To manage the locations of an appointment in Outlook clients that don't support Mailbox requirement set 1.8, use the `location` property instead. + * For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ enhancedLocation: EnhancedLocation; /** @@ -3011,9 +3025,15 @@ export declare namespace Office { * * @remarks * + * [Api set: Mailbox 1.1] + * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee + * + * **Important**: The `enhancedLocation` property was introduced in Mailbox requirement set 1.8. Use the `enhancedLocation` property to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ location: string; /** @@ -5573,6 +5593,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * + * **Important**: To manage the locations of an appointment in Outlook clients that don't support Mailbox requirement set 1.8, use the Office.Location API instead. + * For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ export interface EnhancedLocation { /** @@ -5618,9 +5642,6 @@ export declare namespace Office { /** * Gets the set of locations associated with the appointment. * - * **Note**: {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | Personal contact groups} - * added as appointment locations aren't returned by this method. - * * @remarks * [Api set: Mailbox 1.8] * @@ -5628,18 +5649,23 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * + * **Important**: + * + * - The `getAsync` method doesn't return {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | personal contact groups} that + * were added to the **Location** field of an appointment. + * + * - If a location was added using `Office.context.mailbox.item.location.setAsync`, its location type is `Office.MailboxEnums.LocationType.Custom`. + * * @param options - An object literal that contains one or more of the following properties:- * `asyncContext`: Developers can provide any object they wish to access in the callback function. * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, - * `asyncResult`, which is an `Office.AsyncResult` object. + * `asyncResult`, which is an `Office.AsyncResult` object. An array of `Office.LocationDetails` objects representing the locations of the + * appointment is returned in the `asyncResult.value` property. */ getAsync(options: CommonAPI.AsyncContextOptions, callback?: (asyncResult: CommonAPI.AsyncResult) => void): void; /** * Gets the set of locations associated with the appointment. * - * **Note**: {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | Personal contact groups} - * added as appointment locations aren't returned by this method. - * * @remarks * [Api set: Mailbox 1.8] * @@ -5647,8 +5673,16 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * + * **Important**: + * + * - The `getAsync` method doesn't return {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | personal contact groups} that + * were added to the **Location** field of an appointment. + * + * - If a location was added using `Office.context.mailbox.item.location.setAsync`, its location type is `Office.MailboxEnums.LocationType.Custom`. + * * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, - * `asyncResult`, which is an `Office.AsyncResult` object. + * `asyncResult`, which is an `Office.AsyncResult` object. An array of `Office.LocationDetails` objects representing the locations of the + * appointment is returned in the `asyncResult.value` property. */ getAsync(callback?: (asyncResult: CommonAPI.AsyncResult) => void): void; /** @@ -6268,6 +6302,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose + * + * **Important**: The Office.EnhancedLocation API was introduced in Mailbox requirement set 1.8. Use the EnhancedLocation API to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ export interface Location { /** @@ -6319,6 +6357,9 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * + * **Important**: To ensure that multiple locations resolve correctly in Outlook, separate them with a semicolon and a space. For example, + * "Conference Room 1; Conference Room 2". + * * **Errors**: * * - DataExceedsMaximumSize: The location parameter is longer than 255 characters. @@ -6343,6 +6384,9 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * + * **Important**: To ensure that multiple locations resolve correctly in Outlook, separate them with a semicolon and a space. For example, + * "Conference Room 1; Conference Room 2". + * * **Errors**: * * - DataExceedsMaximumSize: The location parameter is longer than 255 characters. diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_13/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_13/tsdoc-metadata.json index d95757eac5..018ab4c3f2 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_13/tsdoc-metadata.json +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_13/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.52.13" + "packageVersion": "7.52.15" } ] } diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_14/outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_14/outlook.d.ts index 03d4473e7c..8146c2b602 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_14/outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_14/outlook.d.ts @@ -1595,6 +1595,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer + * + * **Important**: To manage the locations of an appointment in Outlook clients that don't support Mailbox requirement set 1.8, use the `location` property instead. + * For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ enhancedLocation: EnhancedLocation; /** @@ -1615,9 +1619,15 @@ export declare namespace Office { * * @remarks * + * [Api set: Mailbox 1.1] + * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer + * + * **Important**: The `enhancedLocation` property was introduced in Mailbox requirement set 1.8. Use the `enhancedLocation` property to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ location: Location; /** @@ -3054,6 +3064,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee + * + * **Important**: To manage the locations of an appointment in Outlook clients that don't support Mailbox requirement set 1.8, use the `location` property instead. + * For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ enhancedLocation: EnhancedLocation; /** @@ -3109,9 +3123,15 @@ export declare namespace Office { * * @remarks * + * [Api set: Mailbox 1.1] + * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee + * + * **Important**: The `enhancedLocation` property was introduced in Mailbox requirement set 1.8. Use the `enhancedLocation` property to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ location: string; /** @@ -5684,6 +5704,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * + * **Important**: To manage the locations of an appointment in Outlook clients that don't support Mailbox requirement set 1.8, use the Office.Location API instead. + * For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ export interface EnhancedLocation { /** @@ -5729,9 +5753,6 @@ export declare namespace Office { /** * Gets the set of locations associated with the appointment. * - * **Note**: {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | Personal contact groups} - * added as appointment locations aren't returned by this method. - * * @remarks * [Api set: Mailbox 1.8] * @@ -5739,18 +5760,23 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * + * **Important**: + * + * - The `getAsync` method doesn't return {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | personal contact groups} that + * were added to the **Location** field of an appointment. + * + * - If a location was added using `Office.context.mailbox.item.location.setAsync`, its location type is `Office.MailboxEnums.LocationType.Custom`. + * * @param options - An object literal that contains one or more of the following properties:- * `asyncContext`: Developers can provide any object they wish to access in the callback function. * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, - * `asyncResult`, which is an `Office.AsyncResult` object. + * `asyncResult`, which is an `Office.AsyncResult` object. An array of `Office.LocationDetails` objects representing the locations of the + * appointment is returned in the `asyncResult.value` property. */ getAsync(options: CommonAPI.AsyncContextOptions, callback?: (asyncResult: CommonAPI.AsyncResult) => void): void; /** * Gets the set of locations associated with the appointment. * - * **Note**: {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | Personal contact groups} - * added as appointment locations aren't returned by this method. - * * @remarks * [Api set: Mailbox 1.8] * @@ -5758,8 +5784,16 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * + * **Important**: + * + * - The `getAsync` method doesn't return {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | personal contact groups} that + * were added to the **Location** field of an appointment. + * + * - If a location was added using `Office.context.mailbox.item.location.setAsync`, its location type is `Office.MailboxEnums.LocationType.Custom`. + * * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, - * `asyncResult`, which is an `Office.AsyncResult` object. + * `asyncResult`, which is an `Office.AsyncResult` object. An array of `Office.LocationDetails` objects representing the locations of the + * appointment is returned in the `asyncResult.value` property. */ getAsync(callback?: (asyncResult: CommonAPI.AsyncResult) => void): void; /** @@ -6379,6 +6413,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose + * + * **Important**: The Office.EnhancedLocation API was introduced in Mailbox requirement set 1.8. Use the EnhancedLocation API to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ export interface Location { /** @@ -6430,6 +6468,9 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * + * **Important**: To ensure that multiple locations resolve correctly in Outlook, separate them with a semicolon and a space. For example, + * "Conference Room 1; Conference Room 2". + * * **Errors**: * * - DataExceedsMaximumSize: The location parameter is longer than 255 characters. @@ -6454,6 +6495,9 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * + * **Important**: To ensure that multiple locations resolve correctly in Outlook, separate them with a semicolon and a space. For example, + * "Conference Room 1; Conference Room 2". + * * **Errors**: * * - DataExceedsMaximumSize: The location parameter is longer than 255 characters. diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_14/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_14/tsdoc-metadata.json index d95757eac5..018ab4c3f2 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_14/tsdoc-metadata.json +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_14/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.52.13" + "packageVersion": "7.52.15" } ] } diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_15/outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_15/outlook.d.ts index 1285cacfe3..f2d415e4b8 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_15/outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_15/outlook.d.ts @@ -1604,6 +1604,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer + * + * **Important**: To manage the locations of an appointment in Outlook clients that don't support Mailbox requirement set 1.8, use the `location` property instead. + * For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ enhancedLocation: EnhancedLocation; /** @@ -1624,9 +1628,15 @@ export declare namespace Office { * * @remarks * + * [Api set: Mailbox 1.1] + * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer + * + * **Important**: The `enhancedLocation` property was introduced in Mailbox requirement set 1.8. Use the `enhancedLocation` property to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ location: Location; /** @@ -3129,6 +3139,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee + * + * **Important**: To manage the locations of an appointment in Outlook clients that don't support Mailbox requirement set 1.8, use the `location` property instead. + * For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ enhancedLocation: EnhancedLocation; /** @@ -3184,9 +3198,15 @@ export declare namespace Office { * * @remarks * + * [Api set: Mailbox 1.1] + * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee + * + * **Important**: The `enhancedLocation` property was introduced in Mailbox requirement set 1.8. Use the `enhancedLocation` property to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ location: string; /** @@ -5759,6 +5779,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * + * **Important**: To manage the locations of an appointment in Outlook clients that don't support Mailbox requirement set 1.8, use the Office.Location API instead. + * For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ export interface EnhancedLocation { /** @@ -5804,9 +5828,6 @@ export declare namespace Office { /** * Gets the set of locations associated with the appointment. * - * **Note**: {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | Personal contact groups} - * added as appointment locations aren't returned by this method. - * * @remarks * [Api set: Mailbox 1.8] * @@ -5814,18 +5835,23 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * + * **Important**: + * + * - The `getAsync` method doesn't return {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | personal contact groups} that + * were added to the **Location** field of an appointment. + * + * - If a location was added using `Office.context.mailbox.item.location.setAsync`, its location type is `Office.MailboxEnums.LocationType.Custom`. + * * @param options - An object literal that contains one or more of the following properties:- * `asyncContext`: Developers can provide any object they wish to access in the callback function. * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, - * `asyncResult`, which is an `Office.AsyncResult` object. + * `asyncResult`, which is an `Office.AsyncResult` object. An array of `Office.LocationDetails` objects representing the locations of the + * appointment is returned in the `asyncResult.value` property. */ getAsync(options: CommonAPI.AsyncContextOptions, callback?: (asyncResult: CommonAPI.AsyncResult) => void): void; /** * Gets the set of locations associated with the appointment. * - * **Note**: {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | Personal contact groups} - * added as appointment locations aren't returned by this method. - * * @remarks * [Api set: Mailbox 1.8] * @@ -5833,8 +5859,16 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * + * **Important**: + * + * - The `getAsync` method doesn't return {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | personal contact groups} that + * were added to the **Location** field of an appointment. + * + * - If a location was added using `Office.context.mailbox.item.location.setAsync`, its location type is `Office.MailboxEnums.LocationType.Custom`. + * * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, - * `asyncResult`, which is an `Office.AsyncResult` object. + * `asyncResult`, which is an `Office.AsyncResult` object. An array of `Office.LocationDetails` objects representing the locations of the + * appointment is returned in the `asyncResult.value` property. */ getAsync(callback?: (asyncResult: CommonAPI.AsyncResult) => void): void; /** @@ -8272,6 +8306,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose + * + * **Important**: The Office.EnhancedLocation API was introduced in Mailbox requirement set 1.8. Use the EnhancedLocation API to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ export interface Location { /** @@ -8323,6 +8361,9 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * + * **Important**: To ensure that multiple locations resolve correctly in Outlook, separate them with a semicolon and a space. For example, + * "Conference Room 1; Conference Room 2". + * * **Errors**: * * - DataExceedsMaximumSize: The location parameter is longer than 255 characters. @@ -8347,6 +8388,9 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * + * **Important**: To ensure that multiple locations resolve correctly in Outlook, separate them with a semicolon and a space. For example, + * "Conference Room 1; Conference Room 2". + * * **Errors**: * * - DataExceedsMaximumSize: The location parameter is longer than 255 characters. diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_15/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_15/tsdoc-metadata.json index d95757eac5..018ab4c3f2 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_15/tsdoc-metadata.json +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_15/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.52.13" + "packageVersion": "7.52.15" } ] } diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_2/Outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_2/Outlook.d.ts index 4c2cbf8086..0e5738b00f 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_2/Outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_2/Outlook.d.ts @@ -440,9 +440,15 @@ export declare namespace Office { * * @remarks * + * [Api set: Mailbox 1.1] + * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer + * + * **Important**: The `enhancedLocation` property was introduced in Mailbox requirement set 1.8. Use the `enhancedLocation` property to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ location: Location; @@ -1213,9 +1219,15 @@ export declare namespace Office { * * @remarks * + * [Api set: Mailbox 1.1] + * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee + * + * **Important**: The `enhancedLocation` property was introduced in Mailbox requirement set 1.8. Use the `enhancedLocation` property to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ location: string; /** @@ -2467,6 +2479,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose + * + * **Important**: The Office.EnhancedLocation API was introduced in Mailbox requirement set 1.8. Use the EnhancedLocation API to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ export interface Location { /** @@ -2518,6 +2534,9 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * + * **Important**: To ensure that multiple locations resolve correctly in Outlook, separate them with a semicolon and a space. For example, + * "Conference Room 1; Conference Room 2". + * * **Errors**: * * - DataExceedsMaximumSize: The location parameter is longer than 255 characters. @@ -2542,6 +2561,9 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * + * **Important**: To ensure that multiple locations resolve correctly in Outlook, separate them with a semicolon and a space. For example, + * "Conference Room 1; Conference Room 2". + * * **Errors**: * * - DataExceedsMaximumSize: The location parameter is longer than 255 characters. diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_2/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_2/tsdoc-metadata.json index d95757eac5..018ab4c3f2 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_2/tsdoc-metadata.json +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_2/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.52.13" + "packageVersion": "7.52.15" } ] } diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_3/Outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_3/Outlook.d.ts index b117b09349..f4877d981a 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_3/Outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_3/Outlook.d.ts @@ -488,9 +488,15 @@ export declare namespace Office { * * @remarks * + * [Api set: Mailbox 1.1] + * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer + * + * **Important**: The `enhancedLocation` property was introduced in Mailbox requirement set 1.8. Use the `enhancedLocation` property to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ location: Location; /** @@ -1384,9 +1390,15 @@ export declare namespace Office { * * @remarks * + * [Api set: Mailbox 1.1] + * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee + * + * **Important**: The `enhancedLocation` property was introduced in Mailbox requirement set 1.8. Use the `enhancedLocation` property to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ location: string; /** @@ -2858,6 +2870,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose + * + * **Important**: The Office.EnhancedLocation API was introduced in Mailbox requirement set 1.8. Use the EnhancedLocation API to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ export interface Location { /** @@ -2909,6 +2925,9 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * + * **Important**: To ensure that multiple locations resolve correctly in Outlook, separate them with a semicolon and a space. For example, + * "Conference Room 1; Conference Room 2". + * * **Errors**: * * - DataExceedsMaximumSize: The location parameter is longer than 255 characters. @@ -2933,6 +2952,9 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * + * **Important**: To ensure that multiple locations resolve correctly in Outlook, separate them with a semicolon and a space. For example, + * "Conference Room 1; Conference Room 2". + * * **Errors**: * * - DataExceedsMaximumSize: The location parameter is longer than 255 characters. diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_3/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_3/tsdoc-metadata.json index d95757eac5..018ab4c3f2 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_3/tsdoc-metadata.json +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_3/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.52.13" + "packageVersion": "7.52.15" } ] } diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_4/Outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_4/Outlook.d.ts index 597c3c6872..5463bdceec 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_4/Outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_4/Outlook.d.ts @@ -488,9 +488,15 @@ export declare namespace Office { * * @remarks * + * [Api set: Mailbox 1.1] + * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer + * + * **Important**: The `enhancedLocation` property was introduced in Mailbox requirement set 1.8. Use the `enhancedLocation` property to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ location: Location; /** @@ -1384,9 +1390,15 @@ export declare namespace Office { * * @remarks * + * [Api set: Mailbox 1.1] + * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee + * + * **Important**: The `enhancedLocation` property was introduced in Mailbox requirement set 1.8. Use the `enhancedLocation` property to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ location: string; /** @@ -2858,6 +2870,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose + * + * **Important**: The Office.EnhancedLocation API was introduced in Mailbox requirement set 1.8. Use the EnhancedLocation API to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ export interface Location { /** @@ -2909,6 +2925,9 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * + * **Important**: To ensure that multiple locations resolve correctly in Outlook, separate them with a semicolon and a space. For example, + * "Conference Room 1; Conference Room 2". + * * **Errors**: * * - DataExceedsMaximumSize: The location parameter is longer than 255 characters. @@ -2933,6 +2952,9 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * + * **Important**: To ensure that multiple locations resolve correctly in Outlook, separate them with a semicolon and a space. For example, + * "Conference Room 1; Conference Room 2". + * * **Errors**: * * - DataExceedsMaximumSize: The location parameter is longer than 255 characters. diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_4/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_4/tsdoc-metadata.json index d95757eac5..018ab4c3f2 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_4/tsdoc-metadata.json +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_4/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.52.13" + "packageVersion": "7.52.15" } ] } diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_5/Outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_5/Outlook.d.ts index c8ddcc863e..c1d41bbe34 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_5/Outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_5/Outlook.d.ts @@ -488,9 +488,15 @@ export declare namespace Office { * * @remarks * + * [Api set: Mailbox 1.1] + * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer + * + * **Important**: The `enhancedLocation` property was introduced in Mailbox requirement set 1.8. Use the `enhancedLocation` property to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ location: Location; /** @@ -1384,9 +1390,15 @@ export declare namespace Office { * * @remarks * + * [Api set: Mailbox 1.1] + * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee + * + * **Important**: The `enhancedLocation` property was introduced in Mailbox requirement set 1.8. Use the `enhancedLocation` property to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ location: string; /** @@ -3023,6 +3035,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose + * + * **Important**: The Office.EnhancedLocation API was introduced in Mailbox requirement set 1.8. Use the EnhancedLocation API to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ export interface Location { /** @@ -3074,6 +3090,9 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * + * **Important**: To ensure that multiple locations resolve correctly in Outlook, separate them with a semicolon and a space. For example, + * "Conference Room 1; Conference Room 2". + * * **Errors**: * * - DataExceedsMaximumSize: The location parameter is longer than 255 characters. @@ -3098,6 +3117,9 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * + * **Important**: To ensure that multiple locations resolve correctly in Outlook, separate them with a semicolon and a space. For example, + * "Conference Room 1; Conference Room 2". + * * **Errors**: * * - DataExceedsMaximumSize: The location parameter is longer than 255 characters. diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_5/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_5/tsdoc-metadata.json index d95757eac5..018ab4c3f2 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_5/tsdoc-metadata.json +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_5/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.52.13" + "packageVersion": "7.52.15" } ] } diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_6/Outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_6/Outlook.d.ts index 2b1b9ff0fe..885b2a38cd 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_6/Outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_6/Outlook.d.ts @@ -488,9 +488,15 @@ export declare namespace Office { * * @remarks * + * [Api set: Mailbox 1.1] + * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer + * + * **Important**: The `enhancedLocation` property was introduced in Mailbox requirement set 1.8. Use the `enhancedLocation` property to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ location: Location; /** @@ -1384,9 +1390,15 @@ export declare namespace Office { * * @remarks * + * [Api set: Mailbox 1.1] + * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee + * + * **Important**: The `enhancedLocation` property was introduced in Mailbox requirement set 1.8. Use the `enhancedLocation` property to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ location: string; /** @@ -3076,6 +3088,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose + * + * **Important**: The Office.EnhancedLocation API was introduced in Mailbox requirement set 1.8. Use the EnhancedLocation API to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ export interface Location { /** @@ -3127,6 +3143,9 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * + * **Important**: To ensure that multiple locations resolve correctly in Outlook, separate them with a semicolon and a space. For example, + * "Conference Room 1; Conference Room 2". + * * **Errors**: * * - DataExceedsMaximumSize: The location parameter is longer than 255 characters. @@ -3151,6 +3170,9 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * + * **Important**: To ensure that multiple locations resolve correctly in Outlook, separate them with a semicolon and a space. For example, + * "Conference Room 1; Conference Room 2". + * * **Errors**: * * - DataExceedsMaximumSize: The location parameter is longer than 255 characters. diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_6/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_6/tsdoc-metadata.json index d95757eac5..018ab4c3f2 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_6/tsdoc-metadata.json +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_6/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.52.13" + "packageVersion": "7.52.15" } ] } diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_7/Outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_7/Outlook.d.ts index 188656e5d4..3404b0556d 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_7/Outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_7/Outlook.d.ts @@ -1205,9 +1205,15 @@ export declare namespace Office { * * @remarks * + * [Api set: Mailbox 1.1] + * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer + * + * **Important**: The `enhancedLocation` property was introduced in Mailbox requirement set 1.8. Use the `enhancedLocation` property to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ location: Location; /** @@ -2229,9 +2235,15 @@ export declare namespace Office { * * @remarks * + * [Api set: Mailbox 1.1] + * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee + * + * **Important**: The `enhancedLocation` property was introduced in Mailbox requirement set 1.8. Use the `enhancedLocation` property to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ location: string; /** @@ -4139,6 +4151,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose + * + * **Important**: The Office.EnhancedLocation API was introduced in Mailbox requirement set 1.8. Use the EnhancedLocation API to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ export interface Location { /** @@ -4190,6 +4206,9 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * + * **Important**: To ensure that multiple locations resolve correctly in Outlook, separate them with a semicolon and a space. For example, + * "Conference Room 1; Conference Room 2". + * * **Errors**: * * - DataExceedsMaximumSize: The location parameter is longer than 255 characters. @@ -4214,6 +4233,9 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * + * **Important**: To ensure that multiple locations resolve correctly in Outlook, separate them with a semicolon and a space. For example, + * "Conference Room 1; Conference Room 2". + * * **Errors**: * * - DataExceedsMaximumSize: The location parameter is longer than 255 characters. diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_7/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_7/tsdoc-metadata.json index d95757eac5..018ab4c3f2 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_7/tsdoc-metadata.json +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_7/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.52.13" + "packageVersion": "7.52.15" } ] } diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_8/outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_8/outlook.d.ts index 22a40d0808..64a13ddf10 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_8/outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_8/outlook.d.ts @@ -1424,6 +1424,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer + * + * **Important**: To manage the locations of an appointment in Outlook clients that don't support Mailbox requirement set 1.8, use the `location` property instead. + * For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ enhancedLocation: EnhancedLocation; /** @@ -1444,9 +1448,15 @@ export declare namespace Office { * * @remarks * + * [Api set: Mailbox 1.1] + * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer + * + * **Important**: The `enhancedLocation` property was introduced in Mailbox requirement set 1.8. Use the `enhancedLocation` property to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ location: Location; /** @@ -2761,6 +2771,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee + * + * **Important**: To manage the locations of an appointment in Outlook clients that don't support Mailbox requirement set 1.8, use the `location` property instead. + * For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ enhancedLocation: EnhancedLocation; /** @@ -2816,9 +2830,15 @@ export declare namespace Office { * * @remarks * + * [Api set: Mailbox 1.1] + * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee + * + * **Important**: The `enhancedLocation` property was introduced in Mailbox requirement set 1.8. Use the `enhancedLocation` property to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ location: string; /** @@ -4877,6 +4897,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * + * **Important**: To manage the locations of an appointment in Outlook clients that don't support Mailbox requirement set 1.8, use the Office.Location API instead. + * For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ export interface EnhancedLocation { /** @@ -4922,9 +4946,6 @@ export declare namespace Office { /** * Gets the set of locations associated with the appointment. * - * **Note**: {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | Personal contact groups} - * added as appointment locations aren't returned by this method. - * * @remarks * [Api set: Mailbox 1.8] * @@ -4932,18 +4953,23 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * + * **Important**: + * + * - The `getAsync` method doesn't return {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | personal contact groups} that + * were added to the **Location** field of an appointment. + * + * - If a location was added using `Office.context.mailbox.item.location.setAsync`, its location type is `Office.MailboxEnums.LocationType.Custom`. + * * @param options - An object literal that contains one or more of the following properties:- * `asyncContext`: Developers can provide any object they wish to access in the callback function. * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, - * `asyncResult`, which is an `Office.AsyncResult` object. + * `asyncResult`, which is an `Office.AsyncResult` object. An array of `Office.LocationDetails` objects representing the locations of the + * appointment is returned in the `asyncResult.value` property. */ getAsync(options: CommonAPI.AsyncContextOptions, callback?: (asyncResult: CommonAPI.AsyncResult) => void): void; /** * Gets the set of locations associated with the appointment. * - * **Note**: {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | Personal contact groups} - * added as appointment locations aren't returned by this method. - * * @remarks * [Api set: Mailbox 1.8] * @@ -4951,8 +4977,16 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * + * **Important**: + * + * - The `getAsync` method doesn't return {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | personal contact groups} that + * were added to the **Location** field of an appointment. + * + * - If a location was added using `Office.context.mailbox.item.location.setAsync`, its location type is `Office.MailboxEnums.LocationType.Custom`. + * * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, - * `asyncResult`, which is an `Office.AsyncResult` object. + * `asyncResult`, which is an `Office.AsyncResult` object. An array of `Office.LocationDetails` objects representing the locations of the + * appointment is returned in the `asyncResult.value` property. */ getAsync(callback?: (asyncResult: CommonAPI.AsyncResult) => void): void; /** @@ -5530,6 +5564,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose + * + * **Important**: The Office.EnhancedLocation API was introduced in Mailbox requirement set 1.8. Use the EnhancedLocation API to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ export interface Location { /** @@ -5581,6 +5619,9 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * + * **Important**: To ensure that multiple locations resolve correctly in Outlook, separate them with a semicolon and a space. For example, + * "Conference Room 1; Conference Room 2". + * * **Errors**: * * - DataExceedsMaximumSize: The location parameter is longer than 255 characters. @@ -5605,6 +5646,9 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * + * **Important**: To ensure that multiple locations resolve correctly in Outlook, separate them with a semicolon and a space. For example, + * "Conference Room 1; Conference Room 2". + * * **Errors**: * * - DataExceedsMaximumSize: The location parameter is longer than 255 characters. diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_8/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_8/tsdoc-metadata.json index d95757eac5..018ab4c3f2 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_8/tsdoc-metadata.json +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_8/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.52.13" + "packageVersion": "7.52.15" } ] } diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_9/outlook.d.ts b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_9/outlook.d.ts index b27258d857..1d62331802 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_9/outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_9/outlook.d.ts @@ -1424,6 +1424,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer + * + * **Important**: To manage the locations of an appointment in Outlook clients that don't support Mailbox requirement set 1.8, use the `location` property instead. + * For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ enhancedLocation: EnhancedLocation; /** @@ -1444,9 +1448,15 @@ export declare namespace Office { * * @remarks * + * [Api set: Mailbox 1.1] + * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer + * + * **Important**: The `enhancedLocation` property was introduced in Mailbox requirement set 1.8. Use the `enhancedLocation` property to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ location: Location; /** @@ -2761,6 +2771,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee + * + * **Important**: To manage the locations of an appointment in Outlook clients that don't support Mailbox requirement set 1.8, use the `location` property instead. + * For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ enhancedLocation: EnhancedLocation; /** @@ -2816,9 +2830,15 @@ export declare namespace Office { * * @remarks * + * [Api set: Mailbox 1.1] + * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee + * + * **Important**: The `enhancedLocation` property was introduced in Mailbox requirement set 1.8. Use the `enhancedLocation` property to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ location: string; /** @@ -5090,6 +5110,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * + * **Important**: To manage the locations of an appointment in Outlook clients that don't support Mailbox requirement set 1.8, use the Office.Location API instead. + * For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ export interface EnhancedLocation { /** @@ -5135,9 +5159,6 @@ export declare namespace Office { /** * Gets the set of locations associated with the appointment. * - * **Note**: {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | Personal contact groups} - * added as appointment locations aren't returned by this method. - * * @remarks * [Api set: Mailbox 1.8] * @@ -5145,18 +5166,23 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * + * **Important**: + * + * - The `getAsync` method doesn't return {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | personal contact groups} that + * were added to the **Location** field of an appointment. + * + * - If a location was added using `Office.context.mailbox.item.location.setAsync`, its location type is `Office.MailboxEnums.LocationType.Custom`. + * * @param options - An object literal that contains one or more of the following properties:- * `asyncContext`: Developers can provide any object they wish to access in the callback function. * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, - * `asyncResult`, which is an `Office.AsyncResult` object. + * `asyncResult`, which is an `Office.AsyncResult` object. An array of `Office.LocationDetails` objects representing the locations of the + * appointment is returned in the `asyncResult.value` property. */ getAsync(options: CommonAPI.AsyncContextOptions, callback?: (asyncResult: CommonAPI.AsyncResult) => void): void; /** * Gets the set of locations associated with the appointment. * - * **Note**: {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | Personal contact groups} - * added as appointment locations aren't returned by this method. - * * @remarks * [Api set: Mailbox 1.8] * @@ -5164,8 +5190,16 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * + * **Important**: + * + * - The `getAsync` method doesn't return {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | personal contact groups} that + * were added to the **Location** field of an appointment. + * + * - If a location was added using `Office.context.mailbox.item.location.setAsync`, its location type is `Office.MailboxEnums.LocationType.Custom`. + * * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, - * `asyncResult`, which is an `Office.AsyncResult` object. + * `asyncResult`, which is an `Office.AsyncResult` object. An array of `Office.LocationDetails` objects representing the locations of the + * appointment is returned in the `asyncResult.value` property. */ getAsync(callback?: (asyncResult: CommonAPI.AsyncResult) => void): void; /** @@ -5743,6 +5777,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose + * + * **Important**: The Office.EnhancedLocation API was introduced in Mailbox requirement set 1.8. Use the EnhancedLocation API to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ export interface Location { /** @@ -5794,6 +5832,9 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * + * **Important**: To ensure that multiple locations resolve correctly in Outlook, separate them with a semicolon and a space. For example, + * "Conference Room 1; Conference Room 2". + * * **Errors**: * * - DataExceedsMaximumSize: The location parameter is longer than 255 characters. @@ -5818,6 +5859,9 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * + * **Important**: To ensure that multiple locations resolve correctly in Outlook, separate them with a semicolon and a space. For example, + * "Conference Room 1; Conference Room 2". + * * **Errors**: * * - DataExceedsMaximumSize: The location parameter is longer than 255 characters. diff --git a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_9/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_9/tsdoc-metadata.json index d95757eac5..018ab4c3f2 100644 --- a/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_9/tsdoc-metadata.json +++ b/generate-docs/api-extractor-inputs-outlook-release/Outlook_1_9/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.52.13" + "packageVersion": "7.52.15" } ] } diff --git a/generate-docs/api-extractor-inputs-outlook/outlook.d.ts b/generate-docs/api-extractor-inputs-outlook/outlook.d.ts index 83716c53be..f388407d84 100644 --- a/generate-docs/api-extractor-inputs-outlook/outlook.d.ts +++ b/generate-docs/api-extractor-inputs-outlook/outlook.d.ts @@ -1604,6 +1604,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer + * + * **Important**: To manage the locations of an appointment in Outlook clients that don't support Mailbox requirement set 1.8, use the `location` property instead. + * For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ enhancedLocation: EnhancedLocation; /** @@ -1637,9 +1641,15 @@ export declare namespace Office { * * @remarks * + * [Api set: Mailbox 1.1] + * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer + * + * **Important**: The `enhancedLocation` property was introduced in Mailbox requirement set 1.8. Use the `enhancedLocation` property to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ location: Location; /** @@ -3138,6 +3148,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee + * + * **Important**: To manage the locations of an appointment in Outlook clients that don't support Mailbox requirement set 1.8, use the `location` property instead. + * For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ enhancedLocation: EnhancedLocation; /** @@ -3206,9 +3220,15 @@ export declare namespace Office { * * @remarks * + * [Api set: Mailbox 1.1] + * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee + * + * **Important**: The `enhancedLocation` property was introduced in Mailbox requirement set 1.8. Use the `enhancedLocation` property to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ location: string; /** @@ -5969,6 +5989,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * + * **Important**: To manage the locations of an appointment in Outlook clients that don't support Mailbox requirement set 1.8, use the Office.Location API instead. + * For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ export interface EnhancedLocation { /** @@ -6013,9 +6037,6 @@ export declare namespace Office { addAsync(locationIdentifiers: LocationIdentifier[], callback?: (asyncResult: CommonAPI.AsyncResult) => void): void; /** * Gets the set of locations associated with the appointment. - * - * **Note**: {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | Personal contact groups} - * added as appointment locations aren't returned by this method. * * @remarks * [Api set: Mailbox 1.8] @@ -6024,18 +6045,23 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * + * **Important**: + * + * - The `getAsync` method doesn't return {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | personal contact groups} that + * were added to the **Location** field of an appointment. + * + * - If a location was added using `Office.context.mailbox.item.location.setAsync`, its location type is `Office.MailboxEnums.LocationType.Custom`. + * * @param options - An object literal that contains one or more of the following properties:- * `asyncContext`: Developers can provide any object they wish to access in the callback function. * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, - * `asyncResult`, which is an `Office.AsyncResult` object. + * `asyncResult`, which is an `Office.AsyncResult` object. An array of `Office.LocationDetails` objects representing the locations of the + * appointment is returned in the `asyncResult.value` property. */ getAsync(options: CommonAPI.AsyncContextOptions, callback?: (asyncResult: CommonAPI.AsyncResult) => void): void; /** * Gets the set of locations associated with the appointment. * - * **Note**: {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | Personal contact groups} - * added as appointment locations aren't returned by this method. - * * @remarks * [Api set: Mailbox 1.8] * @@ -6043,8 +6069,16 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * + * **Important**: + * + * - The `getAsync` method doesn't return {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | personal contact groups} that + * were added to the **Location** field of an appointment. + * + * - If a location was added using `Office.context.mailbox.item.location.setAsync`, its location type is `Office.MailboxEnums.LocationType.Custom`. + * * @param callback - Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, - * `asyncResult`, which is an `Office.AsyncResult` object. + * `asyncResult`, which is an `Office.AsyncResult` object. An array of `Office.LocationDetails` objects representing the locations of the + * appointment is returned in the `asyncResult.value` property. */ getAsync(callback?: (asyncResult: CommonAPI.AsyncResult) => void): void; /** @@ -8517,6 +8551,10 @@ export declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose + * + * **Important**: The Office.EnhancedLocation API was introduced in Mailbox requirement set 1.8. Use the EnhancedLocation API to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ export interface Location { /** @@ -8568,6 +8606,9 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * + * **Important**: To ensure that multiple locations resolve correctly in Outlook, separate them with a semicolon and a space. For example, + * "Conference Room 1; Conference Room 2". + * * **Errors**: * * - DataExceedsMaximumSize: The location parameter is longer than 255 characters. @@ -8592,6 +8633,9 @@ export declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * + * **Important**: To ensure that multiple locations resolve correctly in Outlook, separate them with a semicolon and a space. For example, + * "Conference Room 1; Conference Room 2". + * * **Errors**: * * - DataExceedsMaximumSize: The location parameter is longer than 255 characters. diff --git a/generate-docs/api-extractor-inputs-outlook/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-outlook/tsdoc-metadata.json index d95757eac5..018ab4c3f2 100644 --- a/generate-docs/api-extractor-inputs-outlook/tsdoc-metadata.json +++ b/generate-docs/api-extractor-inputs-outlook/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.52.13" + "packageVersion": "7.52.15" } ] } diff --git a/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_8/powerpoint.d.ts b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_8/powerpoint.d.ts index 341156d16e..1d95e2cadf 100644 --- a/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_8/powerpoint.d.ts +++ b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_8/powerpoint.d.ts @@ -4499,10 +4499,10 @@ export declare namespace PowerPoint { /** * Exports the slide to its own presentation file, returned as Base64-encoded data. * + * Note: This method is optimized to export a single slide. Exporting multiple slides can impact performance. + * * @remarks * [Api set: PowerPointApi 1.8] - * - * This method is optimized to export a single slide. Exporting multiple slides can impact performance. */ exportAsBase64(): OfficeExtension.ClientResult; /** @@ -5126,7 +5126,7 @@ export declare namespace PowerPoint { */ delete(): void; /** - * Returns the shape represented by the binding. Will throw an error if the binding isn't of the correct type. + * Returns the shape represented by the binding. Throws an error if the binding isn't of the correct type. * * @remarks * [Api set: PowerPointApi 1.8] diff --git a/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_9/powerpoint.d.ts b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_9/powerpoint.d.ts index 05b524a20b..5fb7ae2ee1 100644 --- a/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_9/powerpoint.d.ts +++ b/generate-docs/api-extractor-inputs-powerpoint-release/PowerPoint_1_9/powerpoint.d.ts @@ -5641,10 +5641,10 @@ export declare namespace PowerPoint { /** * Exports the slide to its own presentation file, returned as Base64-encoded data. * + * Note: This method is optimized to export a single slide. Exporting multiple slides can impact performance. + * * @remarks * [Api set: PowerPointApi 1.8] - * - * This method is optimized to export a single slide. Exporting multiple slides can impact performance. */ exportAsBase64(): OfficeExtension.ClientResult; /** @@ -6268,7 +6268,7 @@ export declare namespace PowerPoint { */ delete(): void; /** - * Returns the shape represented by the binding. Will throw an error if the binding isn't of the correct type. + * Returns the shape represented by the binding. Throws an error if the binding isn't of the correct type. * * @remarks * [Api set: PowerPointApi 1.8] diff --git a/generate-docs/api-extractor-inputs-powerpoint/powerpoint.d.ts b/generate-docs/api-extractor-inputs-powerpoint/powerpoint.d.ts index 0576c7c523..56faf20c72 100644 --- a/generate-docs/api-extractor-inputs-powerpoint/powerpoint.d.ts +++ b/generate-docs/api-extractor-inputs-powerpoint/powerpoint.d.ts @@ -7605,10 +7605,10 @@ export declare namespace PowerPoint { /** * Exports the slide to its own presentation file, returned as Base64-encoded data. * + * Note: This method is optimized to export a single slide. Exporting multiple slides can impact performance. + * * @remarks * [Api set: PowerPointApi 1.8] - * - * This method is optimized to export a single slide. Exporting multiple slides can impact performance. */ exportAsBase64(): OfficeExtension.ClientResult; /** @@ -8358,7 +8358,7 @@ export declare namespace PowerPoint { */ delete(): void; /** - * Returns the shape represented by the binding. Will throw an error if the binding isn't of the correct type. + * Returns the shape represented by the binding. Throws an error if the binding isn't of the correct type. * * @remarks * [Api set: PowerPointApi 1.8] diff --git a/generate-docs/api-extractor-inputs-visio/tsdoc-metadata.json b/generate-docs/api-extractor-inputs-visio/tsdoc-metadata.json index d95757eac5..018ab4c3f2 100644 --- a/generate-docs/api-extractor-inputs-visio/tsdoc-metadata.json +++ b/generate-docs/api-extractor-inputs-visio/tsdoc-metadata.json @@ -5,7 +5,7 @@ "toolPackages": [ { "packageName": "@microsoft/api-extractor", - "packageVersion": "7.52.13" + "packageVersion": "7.52.15" } ] } diff --git a/generate-docs/api-extractor-inputs-word-release/word_1_1/word.d.ts b/generate-docs/api-extractor-inputs-word-release/word_1_1/word.d.ts index 73472806c5..dc3a93162b 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_1_1/word.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_1_1/word.d.ts @@ -38,7 +38,7 @@ export declare namespace Word { /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. * * @remarks * [Api set: WordApi 1.1] diff --git a/generate-docs/api-extractor-inputs-word-release/word_1_2/word.d.ts b/generate-docs/api-extractor-inputs-word-release/word_1_2/word.d.ts index 9a8ebde396..5ad90bee54 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_1_2/word.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_1_2/word.d.ts @@ -38,7 +38,7 @@ export declare namespace Word { /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. * * @remarks * [Api set: WordApi 1.1] diff --git a/generate-docs/api-extractor-inputs-word-release/word_1_3/word.d.ts b/generate-docs/api-extractor-inputs-word-release/word_1_3/word.d.ts index cb893cf6e1..552d713db2 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_1_3/word.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_1_3/word.d.ts @@ -100,7 +100,7 @@ export declare namespace Word { /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. * * @remarks * [Api set: WordApi 1.1] diff --git a/generate-docs/api-extractor-inputs-word-release/word_1_3_hidden_document/word-desktop1.d.ts b/generate-docs/api-extractor-inputs-word-release/word_1_3_hidden_document/word-desktop1.d.ts index 0b3e0861a3..d56d87306d 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_1_3_hidden_document/word-desktop1.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_1_3_hidden_document/word-desktop1.d.ts @@ -106,7 +106,7 @@ export declare namespace Word { */ readonly fields: Word.FieldCollection; /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. * * @remarks * [Api set: WordApi 1.1] diff --git a/generate-docs/api-extractor-inputs-word-release/word_1_3_hidden_document/word.d.ts b/generate-docs/api-extractor-inputs-word-release/word_1_3_hidden_document/word.d.ts index b36df812cd..c618898611 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_1_3_hidden_document/word.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_1_3_hidden_document/word.d.ts @@ -100,7 +100,7 @@ export declare namespace Word { /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. * * @remarks * [Api set: WordApi 1.1] diff --git a/generate-docs/api-extractor-inputs-word-release/word_1_4/word.d.ts b/generate-docs/api-extractor-inputs-word-release/word_1_4/word.d.ts index d0a7c16d91..58474d24e1 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_1_4/word.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_1_4/word.d.ts @@ -106,7 +106,7 @@ export declare namespace Word { */ readonly fields: Word.FieldCollection; /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. * * @remarks * [Api set: WordApi 1.1] diff --git a/generate-docs/api-extractor-inputs-word-release/word_1_4_hidden_document/word-desktop1.d.ts b/generate-docs/api-extractor-inputs-word-release/word_1_4_hidden_document/word-desktop1.d.ts index 5a61f6bdf7..4e4daa70df 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_1_4_hidden_document/word-desktop1.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_1_4_hidden_document/word-desktop1.d.ts @@ -120,7 +120,7 @@ export declare namespace Word { */ readonly fields: Word.FieldCollection; /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. * * @remarks * [Api set: WordApi 1.1] diff --git a/generate-docs/api-extractor-inputs-word-release/word_1_4_hidden_document/word.d.ts b/generate-docs/api-extractor-inputs-word-release/word_1_4_hidden_document/word.d.ts index 6101d91515..2f2f2592ec 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_1_4_hidden_document/word.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_1_4_hidden_document/word.d.ts @@ -106,7 +106,7 @@ export declare namespace Word { */ readonly fields: Word.FieldCollection; /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. * * @remarks * [Api set: WordApi 1.1] diff --git a/generate-docs/api-extractor-inputs-word-release/word_1_5/word.d.ts b/generate-docs/api-extractor-inputs-word-release/word_1_5/word.d.ts index 3a6ada99f6..43b9ff4e9a 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_1_5/word.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_1_5/word.d.ts @@ -120,7 +120,7 @@ export declare namespace Word { */ readonly fields: Word.FieldCollection; /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. * * @remarks * [Api set: WordApi 1.1] diff --git a/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop1.d.ts b/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop1.d.ts index 101c0c19fc..ef6d9a6f5a 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop1.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop1.d.ts @@ -565,7 +565,7 @@ export declare namespace Word { */ readonly fields: Word.FieldCollection; /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. * * @remarks * [Api set: WordApi 1.1] diff --git a/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop2.d.ts b/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop2.d.ts index 9289eab1f5..b6eb55cc61 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop2.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop2.d.ts @@ -565,7 +565,7 @@ export declare namespace Word { */ readonly fields: Word.FieldCollection; /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. * * @remarks * [Api set: WordApi 1.1] diff --git a/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop3.d.ts b/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop3.d.ts index f10761f0ac..8d98851750 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop3.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop3.d.ts @@ -496,7 +496,7 @@ export declare namespace Word { */ readonly fields: Word.FieldCollection; /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. * * @remarks * [Api set: WordApi 1.1] diff --git a/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop4.d.ts b/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop4.d.ts index b894045e7e..6f2bc08eee 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop4.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word-desktop4.d.ts @@ -135,7 +135,7 @@ export declare namespace Word { */ readonly fields: Word.FieldCollection; /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. * * @remarks * [Api set: WordApi 1.1] diff --git a/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word.d.ts b/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word.d.ts index 4fd60641f3..2ff60ec383 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_1_5_hidden_document/word.d.ts @@ -120,7 +120,7 @@ export declare namespace Word { */ readonly fields: Word.FieldCollection; /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. * * @remarks * [Api set: WordApi 1.1] diff --git a/generate-docs/api-extractor-inputs-word-release/word_1_6/word.d.ts b/generate-docs/api-extractor-inputs-word-release/word_1_6/word.d.ts index 5fa363f30d..32ccf85fac 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_1_6/word.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_1_6/word.d.ts @@ -135,7 +135,7 @@ export declare namespace Word { */ readonly fields: Word.FieldCollection; /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. * * @remarks * [Api set: WordApi 1.1] diff --git a/generate-docs/api-extractor-inputs-word-release/word_1_7/word.d.ts b/generate-docs/api-extractor-inputs-word-release/word_1_7/word.d.ts index accde2e61c..186f3e2150 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_1_7/word.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_1_7/word.d.ts @@ -496,7 +496,7 @@ export declare namespace Word { */ readonly fields: Word.FieldCollection; /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. * * @remarks * [Api set: WordApi 1.1] diff --git a/generate-docs/api-extractor-inputs-word-release/word_1_8/word.d.ts b/generate-docs/api-extractor-inputs-word-release/word_1_8/word.d.ts index f77fe7ec43..db5617bc69 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_1_8/word.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_1_8/word.d.ts @@ -565,7 +565,7 @@ export declare namespace Word { */ readonly fields: Word.FieldCollection; /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. * * @remarks * [Api set: WordApi 1.1] diff --git a/generate-docs/api-extractor-inputs-word-release/word_1_9/word.d.ts b/generate-docs/api-extractor-inputs-word-release/word_1_9/word.d.ts index 9c93091841..58dbb2b374 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_1_9/word.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_1_9/word.d.ts @@ -565,7 +565,7 @@ export declare namespace Word { */ readonly fields: Word.FieldCollection; /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. * * @remarks * [Api set: WordApi 1.1] diff --git a/generate-docs/api-extractor-inputs-word-release/word_desktop_1_1/word-desktop1.d.ts b/generate-docs/api-extractor-inputs-word-release/word_desktop_1_1/word-desktop1.d.ts index 5863af927b..a69ab1ca4f 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_desktop_1_1/word-desktop1.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_desktop_1_1/word-desktop1.d.ts @@ -565,7 +565,7 @@ export declare namespace Word { */ readonly fields: Word.FieldCollection; /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. * * @remarks * [Api set: WordApi 1.1] diff --git a/generate-docs/api-extractor-inputs-word-release/word_desktop_1_1/word.d.ts b/generate-docs/api-extractor-inputs-word-release/word_desktop_1_1/word.d.ts index 0fa8c44b88..539ca5ce4b 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_desktop_1_1/word.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_desktop_1_1/word.d.ts @@ -565,7 +565,7 @@ export declare namespace Word { */ readonly fields: Word.FieldCollection; /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. * * @remarks * [Api set: WordApi 1.1] diff --git a/generate-docs/api-extractor-inputs-word-release/word_desktop_1_2/word.d.ts b/generate-docs/api-extractor-inputs-word-release/word_desktop_1_2/word.d.ts index d095401bd1..813fd84be2 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_desktop_1_2/word.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_desktop_1_2/word.d.ts @@ -565,7 +565,7 @@ export declare namespace Word { */ readonly fields: Word.FieldCollection; /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. * * @remarks * [Api set: WordApi 1.1] diff --git a/generate-docs/api-extractor-inputs-word-release/word_desktop_1_3/word-desktop1.d.ts b/generate-docs/api-extractor-inputs-word-release/word_desktop_1_3/word-desktop1.d.ts index 781790e734..fc997effdb 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_desktop_1_3/word-desktop1.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_desktop_1_3/word-desktop1.d.ts @@ -589,7 +589,7 @@ export declare namespace Word { */ readonly fields: Word.FieldCollection; /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. * * @remarks * [Api set: WordApi 1.1] diff --git a/generate-docs/api-extractor-inputs-word-release/word_desktop_1_3/word-desktop2.d.ts b/generate-docs/api-extractor-inputs-word-release/word_desktop_1_3/word-desktop2.d.ts index 1b2a24d1d2..6ed2c3ab9c 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_desktop_1_3/word-desktop2.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_desktop_1_3/word-desktop2.d.ts @@ -589,7 +589,7 @@ export declare namespace Word { */ readonly fields: Word.FieldCollection; /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. * * @remarks * [Api set: WordApi 1.1] diff --git a/generate-docs/api-extractor-inputs-word-release/word_desktop_1_3/word-desktop3.d.ts b/generate-docs/api-extractor-inputs-word-release/word_desktop_1_3/word-desktop3.d.ts index 7bcd7d8e1a..fe20484734 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_desktop_1_3/word-desktop3.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_desktop_1_3/word-desktop3.d.ts @@ -589,7 +589,7 @@ export declare namespace Word { */ readonly fields: Word.FieldCollection; /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. * * @remarks * [Api set: WordApi 1.1] diff --git a/generate-docs/api-extractor-inputs-word-release/word_desktop_1_3/word.d.ts b/generate-docs/api-extractor-inputs-word-release/word_desktop_1_3/word.d.ts index 61cd94bf51..56c15c4ccd 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_desktop_1_3/word.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_desktop_1_3/word.d.ts @@ -589,7 +589,7 @@ export declare namespace Word { */ readonly fields: Word.FieldCollection; /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. * * @remarks * [Api set: WordApi 1.1] diff --git a/generate-docs/api-extractor-inputs-word-release/word_online/word-init.d.ts b/generate-docs/api-extractor-inputs-word-release/word_online/word-init.d.ts index 781790e734..fc997effdb 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_online/word-init.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_online/word-init.d.ts @@ -589,7 +589,7 @@ export declare namespace Word { */ readonly fields: Word.FieldCollection; /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. * * @remarks * [Api set: WordApi 1.1] diff --git a/generate-docs/api-extractor-inputs-word-release/word_online/word-online1.d.ts b/generate-docs/api-extractor-inputs-word-release/word_online/word-online1.d.ts index 4883631c12..63cfe5f02b 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_online/word-online1.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_online/word-online1.d.ts @@ -565,7 +565,7 @@ export declare namespace Word { */ readonly fields: Word.FieldCollection; /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. * * @remarks * [Api set: WordApi 1.1] diff --git a/generate-docs/api-extractor-inputs-word-release/word_online/word-online2.d.ts b/generate-docs/api-extractor-inputs-word-release/word_online/word-online2.d.ts index 8100acd2bb..2412c10479 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_online/word-online2.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_online/word-online2.d.ts @@ -565,7 +565,7 @@ export declare namespace Word { */ readonly fields: Word.FieldCollection; /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. * * @remarks * [Api set: WordApi 1.1] diff --git a/generate-docs/api-extractor-inputs-word-release/word_online/word-online3.d.ts b/generate-docs/api-extractor-inputs-word-release/word_online/word-online3.d.ts index 101c0c19fc..ef6d9a6f5a 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_online/word-online3.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_online/word-online3.d.ts @@ -565,7 +565,7 @@ export declare namespace Word { */ readonly fields: Word.FieldCollection; /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. * * @remarks * [Api set: WordApi 1.1] diff --git a/generate-docs/api-extractor-inputs-word-release/word_online/word-online4.d.ts b/generate-docs/api-extractor-inputs-word-release/word_online/word-online4.d.ts index 7e07c9233c..fadda6b971 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_online/word-online4.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_online/word-online4.d.ts @@ -565,7 +565,7 @@ export declare namespace Word { */ readonly fields: Word.FieldCollection; /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. * * @remarks * [Api set: WordApi 1.1] diff --git a/generate-docs/api-extractor-inputs-word-release/word_online/word-online5.d.ts b/generate-docs/api-extractor-inputs-word-release/word_online/word-online5.d.ts index 1ea1d1eeec..91a6aebe6f 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_online/word-online5.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_online/word-online5.d.ts @@ -565,7 +565,7 @@ export declare namespace Word { */ readonly fields: Word.FieldCollection; /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. * * @remarks * [Api set: WordApi 1.1] diff --git a/generate-docs/api-extractor-inputs-word-release/word_online/word.d.ts b/generate-docs/api-extractor-inputs-word-release/word_online/word.d.ts index 9c93091841..58dbb2b374 100644 --- a/generate-docs/api-extractor-inputs-word-release/word_online/word.d.ts +++ b/generate-docs/api-extractor-inputs-word-release/word_online/word.d.ts @@ -565,7 +565,7 @@ export declare namespace Word { */ readonly fields: Word.FieldCollection; /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. * * @remarks * [Api set: WordApi 1.1] diff --git a/generate-docs/api-extractor-inputs-word/word.d.ts b/generate-docs/api-extractor-inputs-word/word.d.ts index 13631ec1b0..f38f89f526 100644 --- a/generate-docs/api-extractor-inputs-word/word.d.ts +++ b/generate-docs/api-extractor-inputs-word/word.d.ts @@ -958,7 +958,7 @@ export declare namespace Word { */ readonly fields: Word.FieldCollection; /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. * * @remarks * [Api set: WordApi 1.1] @@ -4155,7 +4155,7 @@ export declare namespace Word { */ readonly errorCode: number; /** - * Gets the name of the error in the `CustomXmlValidationError` object. If no errors exist, the property returns `Nothing` + * Gets the name of the error in the `CustomXmlValidationError` object. If no errors exist, the property returns `"Nothing"`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -18704,8 +18704,8 @@ export declare namespace Word { addedStyles?: string; /** * If provided, specifies the label that identifies the items to include in a table of figures. - * Corresponds to the `\c` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. - * The default value is "Figure". + Corresponds to the `\c` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. + The default value is "Figure". * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -18714,7 +18714,7 @@ export declare namespace Word { captionLabel?: string; /** * If provided, specifies whether the page numbers in the table of figures should be hidden when publishing to the web. - * The default value is `true`. + The default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -18723,7 +18723,7 @@ export declare namespace Word { hidePageNumbersOnWeb?: boolean; /** * If provided, specifies whether to include the caption label and caption number in a table of figures. - * The default value is `true`. + The default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -18732,7 +18732,7 @@ export declare namespace Word { includeLabel?: boolean; /** * If provided, specifies whether page numbers are included in a table of figures. - * The default value is `true`. + The default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -18741,8 +18741,8 @@ export declare namespace Word { includePageNumbers?: boolean; /** * If provided, specifies the ending heading level for a table of figures when `useBuiltInHeadingStyles` is set to `true`. Should be a value from 1 to 9 and greater than `upperHeadingLevel`. - * Corresponds to the ending value used with the `\o` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. - * The default value is `9`. + Corresponds to the ending value used with the `\o` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. + The default value is `9`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -18751,7 +18751,7 @@ export declare namespace Word { lowerHeadingLevel?: number; /** * If provided, specifies whether to align page numbers with the right margin in a table of figures. - * The default value is `true`. + The default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -18760,7 +18760,7 @@ export declare namespace Word { rightAlignPageNumbers?: boolean; /** * If provided, specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for a table of figures. - * Corresponds to the `\f` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. For example, "T" indicates a table of figures includes TC fields that use the table identifier T. + Corresponds to the `\f` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. For example, "T" indicates a table of figures includes TC fields that use the table identifier T. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -18769,8 +18769,8 @@ export declare namespace Word { tableId?: string; /** * If provided, specifies the starting heading level for a table of figures when `useBuiltInHeadingStyles` is set to `true`. Should be a value from 1 to 9 and smaller than `lowerHeadingLevel`. - * Corresponds to the starting value used with the `\o` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. - * The default value is `1`. + Corresponds to the starting value used with the `\o` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. + The default value is `1`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -18779,7 +18779,7 @@ export declare namespace Word { upperHeadingLevel?: number; /** * If provided, specifies whether to use built-in heading styles to create a table of figures. - * The default value is `false`. + The default value is `false`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -18788,8 +18788,8 @@ export declare namespace Word { useBuiltInHeadingStyles?: boolean; /** * If provided, specifies whether to use {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} to create a table of figures. - * Use the {@link Word.TableOfFiguresCollection | TableOfFiguresCollection.markTocEntry} method to mark entries to include in a table of figures. - * The default value is `false`. + Use the {@link Word.TableOfFiguresCollection | TableOfFiguresCollection.markTocEntry} method to mark entries to include in a table of figures. + The default value is `false`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -18798,7 +18798,7 @@ export declare namespace Word { useFields?: boolean; /** * If provided, specifies whether entries in a table of figures should be formatted as hyperlinks when the document is published to the web. - * The default value is `true`. + The default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -44801,7 +44801,7 @@ export declare namespace Word { * @param xml - The XML string to insert. * @param transform - Optional. XSL transform to apply. */ - insertXML(xml: string, transform?: string): void; + insertXml(xml: string, transform?: string): void; /** * Returns whether the selection is equal to the specified range. * @@ -56979,7 +56979,7 @@ export declare namespace Word { */ errorCode?: number; /** - * Gets the name of the error in the `CustomXmlValidationError` object. If no errors exist, the property returns `Nothing` + * Gets the name of the error in the `CustomXmlValidationError` object. If no errors exist, the property returns `"Nothing"`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -66549,7 +66549,7 @@ export declare namespace Word { */ errorCode?: boolean; /** - * For EACH ITEM in the collection: Gets the name of the error in the `CustomXmlValidationError` object. If no errors exist, the property returns `Nothing` + * For EACH ITEM in the collection: Gets the name of the error in the `CustomXmlValidationError` object. If no errors exist, the property returns `"Nothing"`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -66602,7 +66602,7 @@ export declare namespace Word { */ errorCode?: boolean; /** - * Gets the name of the error in the `CustomXmlValidationError` object. If no errors exist, the property returns `Nothing` + * Gets the name of the error in the `CustomXmlValidationError` object. If no errors exist, the property returns `"Nothing"`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] diff --git a/generate-docs/script-inputs/office.d.ts b/generate-docs/script-inputs/office.d.ts index 982f7396de..677cb07ba4 100644 --- a/generate-docs/script-inputs/office.d.ts +++ b/generate-docs/script-inputs/office.d.ts @@ -10457,6 +10457,10 @@ declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer + * + * **Important**: To manage the locations of an appointment in Outlook clients that don't support Mailbox requirement set 1.8, use the `location` property instead. + * For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ enhancedLocation: EnhancedLocation; /** @@ -10477,9 +10481,15 @@ declare namespace Office { * * @remarks * + * [Api set: Mailbox 1.1] + * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer + * + * **Important**: The `enhancedLocation` property was introduced in Mailbox requirement set 1.8. Use the `enhancedLocation` property to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ location: Location; /** @@ -11982,6 +11992,10 @@ declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee + * + * **Important**: To manage the locations of an appointment in Outlook clients that don't support Mailbox requirement set 1.8, use the `location` property instead. + * For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ enhancedLocation: EnhancedLocation; /** @@ -12037,9 +12051,15 @@ declare namespace Office { * * @remarks * + * [Api set: Mailbox 1.1] + * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee + * + * **Important**: The `enhancedLocation` property was introduced in Mailbox requirement set 1.8. Use the `enhancedLocation` property to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ location: string; /** @@ -14612,6 +14632,10 @@ declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * + * **Important**: To manage the locations of an appointment in Outlook clients that don't support Mailbox requirement set 1.8, use the Office.Location API instead. + * For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ export interface EnhancedLocation { /** @@ -14657,9 +14681,6 @@ declare namespace Office { /** * Gets the set of locations associated with the appointment. * - * **Note**: {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | Personal contact groups} - * added as appointment locations aren't returned by this method. - * * @remarks * [Api set: Mailbox 1.8] * @@ -14667,18 +14688,23 @@ declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * + * **Important**: + * + * - The `getAsync` method doesn't return {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | personal contact groups} that + * were added to the **Location** field of an appointment. + * + * - If a location was added using `Office.context.mailbox.item.location.setAsync`, its location type is `Office.MailboxEnums.LocationType.Custom`. + * * @param options An object literal that contains one or more of the following properties:- * `asyncContext`: Developers can provide any object they wish to access in the callback function. * @param callback Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, - * `asyncResult`, which is an `Office.AsyncResult` object. + * `asyncResult`, which is an `Office.AsyncResult` object. An array of `Office.LocationDetails` objects representing the locations of the + * appointment is returned in the `asyncResult.value` property. */ getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Gets the set of locations associated with the appointment. * - * **Note**: {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | Personal contact groups} - * added as appointment locations aren't returned by this method. - * * @remarks * [Api set: Mailbox 1.8] * @@ -14686,8 +14712,16 @@ declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * + * **Important**: + * + * - The `getAsync` method doesn't return {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | personal contact groups} that + * were added to the **Location** field of an appointment. + * + * - If a location was added using `Office.context.mailbox.item.location.setAsync`, its location type is `Office.MailboxEnums.LocationType.Custom`. + * * @param callback Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, - * `asyncResult`, which is an `Office.AsyncResult` object. + * `asyncResult`, which is an `Office.AsyncResult` object. An array of `Office.LocationDetails` objects representing the locations of the + * appointment is returned in the `asyncResult.value` property. */ getAsync(callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -17125,6 +17159,10 @@ declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose + * + * **Important**: The Office.EnhancedLocation API was introduced in Mailbox requirement set 1.8. Use the EnhancedLocation API to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ interface Location { /** @@ -17176,6 +17214,9 @@ declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * + * **Important**: To ensure that multiple locations resolve correctly in Outlook, separate them with a semicolon and a space. For example, + * "Conference Room 1; Conference Room 2". + * * **Errors**: * * - DataExceedsMaximumSize: The location parameter is longer than 255 characters. @@ -17200,6 +17241,9 @@ declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * + * **Important**: To ensure that multiple locations resolve correctly in Outlook, separate them with a semicolon and a space. For example, + * "Conference Room 1; Conference Room 2". + * * **Errors**: * * - DataExceedsMaximumSize: The location parameter is longer than 255 characters. @@ -91801,7 +91845,7 @@ declare namespace Word { */ readonly fields: Word.FieldCollection; /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. * * @remarks * [Api set: WordApi 1.1] @@ -156711,10 +156755,10 @@ declare namespace PowerPoint { /** * Exports the slide to its own presentation file, returned as Base64-encoded data. * + * Note: This method is optimized to export a single slide. Exporting multiple slides can impact performance. + * * @remarks * [Api set: PowerPointApi 1.8] - * - * This method is optimized to export a single slide. Exporting multiple slides can impact performance. */ exportAsBase64(): OfficeExtension.ClientResult; /** @@ -157338,7 +157382,7 @@ declare namespace PowerPoint { */ delete(): void; /** - * Returns the shape represented by the binding. Will throw an error if the binding isn't of the correct type. + * Returns the shape represented by the binding. Throws an error if the binding isn't of the correct type. * * @remarks * [Api set: PowerPointApi 1.8] diff --git a/generate-docs/script-inputs/office_preview.d.ts b/generate-docs/script-inputs/office_preview.d.ts index 6186508c67..88ff58e4a3 100644 --- a/generate-docs/script-inputs/office_preview.d.ts +++ b/generate-docs/script-inputs/office_preview.d.ts @@ -10467,6 +10467,10 @@ declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer + * + * **Important**: To manage the locations of an appointment in Outlook clients that don't support Mailbox requirement set 1.8, use the `location` property instead. + * For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ enhancedLocation: EnhancedLocation; /** @@ -10500,9 +10504,15 @@ declare namespace Office { * * @remarks * + * [Api set: Mailbox 1.1] + * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Organizer + * + * **Important**: The `enhancedLocation` property was introduced in Mailbox requirement set 1.8. Use the `enhancedLocation` property to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ location: Location; /** @@ -12001,6 +12011,10 @@ declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee + * + * **Important**: To manage the locations of an appointment in Outlook clients that don't support Mailbox requirement set 1.8, use the `location` property instead. + * For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ enhancedLocation: EnhancedLocation; /** @@ -12069,9 +12083,15 @@ declare namespace Office { * * @remarks * + * [Api set: Mailbox 1.1] + * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Appointment Attendee + * + * **Important**: The `enhancedLocation` property was introduced in Mailbox requirement set 1.8. Use the `enhancedLocation` property to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ location: string; /** @@ -14832,6 +14852,10 @@ declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read + * + * **Important**: To manage the locations of an appointment in Outlook clients that don't support Mailbox requirement set 1.8, use the Office.Location API instead. + * For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ export interface EnhancedLocation { /** @@ -14876,9 +14900,6 @@ declare namespace Office { addAsync(locationIdentifiers: LocationIdentifier[], callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Gets the set of locations associated with the appointment. - * - * **Note**: {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | Personal contact groups} - * added as appointment locations aren't returned by this method. * * @remarks * [Api set: Mailbox 1.8] @@ -14887,18 +14908,23 @@ declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * + * **Important**: + * + * - The `getAsync` method doesn't return {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | personal contact groups} that + * were added to the **Location** field of an appointment. + * + * - If a location was added using `Office.context.mailbox.item.location.setAsync`, its location type is `Office.MailboxEnums.LocationType.Custom`. + * * @param options An object literal that contains one or more of the following properties:- * `asyncContext`: Developers can provide any object they wish to access in the callback function. * @param callback Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, - * `asyncResult`, which is an `Office.AsyncResult` object. + * `asyncResult`, which is an `Office.AsyncResult` object. An array of `Office.LocationDetails` objects representing the locations of the + * appointment is returned in the `asyncResult.value` property. */ getAsync(options: Office.AsyncContextOptions, callback?: (asyncResult: Office.AsyncResult) => void): void; /** * Gets the set of locations associated with the appointment. * - * **Note**: {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | Personal contact groups} - * added as appointment locations aren't returned by this method. - * * @remarks * [Api set: Mailbox 1.8] * @@ -14906,8 +14932,16 @@ declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose or Read * + * **Important**: + * + * - The `getAsync` method doesn't return {@link https://support.microsoft.com/office/88ff6c60-0a1d-4b54-8c9d-9e1a71bc3023 | personal contact groups} that + * were added to the **Location** field of an appointment. + * + * - If a location was added using `Office.context.mailbox.item.location.setAsync`, its location type is `Office.MailboxEnums.LocationType.Custom`. + * * @param callback Optional. When the method completes, the function passed in the `callback` parameter is called with a single parameter, - * `asyncResult`, which is an `Office.AsyncResult` object. + * `asyncResult`, which is an `Office.AsyncResult` object. An array of `Office.LocationDetails` objects representing the locations of the + * appointment is returned in the `asyncResult.value` property. */ getAsync(callback?: (asyncResult: Office.AsyncResult) => void): void; /** @@ -17380,6 +17414,10 @@ declare namespace Office { * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/understanding-outlook-add-in-permissions | Minimum permission level}**: **read item** * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose + * + * **Important**: The Office.EnhancedLocation API was introduced in Mailbox requirement set 1.8. Use the EnhancedLocation API to better identify and manage + * appointment locations, especially if you need to determine the location type. For guidance on selecting the right location API for your scenario, see + * {@link https://learn.microsoft.com/office/dev/add-ins/outlook/get-or-set-the-location-of-an-appointment | Get or set the location when composing an appointmnt in Outlook}. */ interface Location { /** @@ -17431,6 +17469,9 @@ declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * + * **Important**: To ensure that multiple locations resolve correctly in Outlook, separate them with a semicolon and a space. For example, + * "Conference Room 1; Conference Room 2". + * * **Errors**: * * - DataExceedsMaximumSize: The location parameter is longer than 255 characters. @@ -17455,6 +17496,9 @@ declare namespace Office { * * **{@link https://learn.microsoft.com/office/dev/add-ins/outlook/outlook-add-ins-overview#extension-points | Applicable Outlook mode}**: Compose * + * **Important**: To ensure that multiple locations resolve correctly in Outlook, separate them with a semicolon and a space. For example, + * "Conference Room 1; Conference Room 2". + * * **Errors**: * * - DataExceedsMaximumSize: The location parameter is longer than 255 characters. @@ -101287,7 +101331,7 @@ declare namespace Word { */ readonly fields: Word.FieldCollection; /** - * Gets the text format of the body. Use this to get and set font name, size, color and other properties. + * Gets the text format of the body. Use this to get and set font name, size, color, and other properties. * * @remarks * [Api set: WordApi 1.1] @@ -104484,7 +104528,7 @@ declare namespace Word { */ readonly errorCode: number; /** - * Gets the name of the error in the `CustomXmlValidationError` object. If no errors exist, the property returns `Nothing` + * Gets the name of the error in the `CustomXmlValidationError` object. If no errors exist, the property returns `"Nothing"`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -119033,8 +119077,8 @@ declare namespace Word { addedStyles?: string; /** * If provided, specifies the label that identifies the items to include in a table of figures. - * Corresponds to the `\c` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. - * The default value is "Figure". + Corresponds to the `\c` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. + The default value is "Figure". * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -119043,7 +119087,7 @@ declare namespace Word { captionLabel?: string; /** * If provided, specifies whether the page numbers in the table of figures should be hidden when publishing to the web. - * The default value is `true`. + The default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -119052,7 +119096,7 @@ declare namespace Word { hidePageNumbersOnWeb?: boolean; /** * If provided, specifies whether to include the caption label and caption number in a table of figures. - * The default value is `true`. + The default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -119061,7 +119105,7 @@ declare namespace Word { includeLabel?: boolean; /** * If provided, specifies whether page numbers are included in a table of figures. - * The default value is `true`. + The default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -119070,8 +119114,8 @@ declare namespace Word { includePageNumbers?: boolean; /** * If provided, specifies the ending heading level for a table of figures when `useBuiltInHeadingStyles` is set to `true`. Should be a value from 1 to 9 and greater than `upperHeadingLevel`. - * Corresponds to the ending value used with the `\o` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. - * The default value is `9`. + Corresponds to the ending value used with the `\o` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. + The default value is `9`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -119080,7 +119124,7 @@ declare namespace Word { lowerHeadingLevel?: number; /** * If provided, specifies whether to align page numbers with the right margin in a table of figures. - * The default value is `true`. + The default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -119089,7 +119133,7 @@ declare namespace Word { rightAlignPageNumbers?: boolean; /** * If provided, specifies a one-letter identifier from {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | TC fields} that's used for a table of figures. - * Corresponds to the `\f` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. For example, "T" indicates a table of figures includes TC fields that use the table identifier T. + Corresponds to the `\f` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. For example, "T" indicates a table of figures includes TC fields that use the table identifier T. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -119098,8 +119142,8 @@ declare namespace Word { tableId?: string; /** * If provided, specifies the starting heading level for a table of figures when `useBuiltInHeadingStyles` is set to `true`. Should be a value from 1 to 9 and smaller than `lowerHeadingLevel`. - * Corresponds to the starting value used with the `\o` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. - * The default value is `1`. + Corresponds to the starting value used with the `\o` switch for a {@link https://support.microsoft.com/office/1f538bc4-60e6-4854-9f64-67754d78d05c | Table of Contents (TOC) field}. + The default value is `1`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -119108,7 +119152,7 @@ declare namespace Word { upperHeadingLevel?: number; /** * If provided, specifies whether to use built-in heading styles to create a table of figures. - * The default value is `false`. + The default value is `false`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -119117,8 +119161,8 @@ declare namespace Word { useBuiltInHeadingStyles?: boolean; /** * If provided, specifies whether to use {@link https://support.microsoft.com/office/01e5dd8a-4730-4bc2-8594-23d7329e25c3 | Table of Contents Entry (TC) fields} to create a table of figures. - * Use the {@link Word.TableOfFiguresCollection | TableOfFiguresCollection.markTocEntry} method to mark entries to include in a table of figures. - * The default value is `false`. + Use the {@link Word.TableOfFiguresCollection | TableOfFiguresCollection.markTocEntry} method to mark entries to include in a table of figures. + The default value is `false`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -119127,7 +119171,7 @@ declare namespace Word { useFields?: boolean; /** * If provided, specifies whether entries in a table of figures should be formatted as hyperlinks when the document is published to the web. - * The default value is `true`. + The default value is `true`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -145130,7 +145174,7 @@ declare namespace Word { * @param xml The XML string to insert. * @param transform Optional. XSL transform to apply. */ - insertXML(xml: string, transform?: string): void; + insertXml(xml: string, transform?: string): void; /** * Returns whether the selection is equal to the specified range. * @@ -157308,7 +157352,7 @@ declare namespace Word { */ errorCode?: number; /** - * Gets the name of the error in the `CustomXmlValidationError` object. If no errors exist, the property returns `Nothing` + * Gets the name of the error in the `CustomXmlValidationError` object. If no errors exist, the property returns `"Nothing"`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -166878,7 +166922,7 @@ declare namespace Word { */ errorCode?: boolean; /** - * For EACH ITEM in the collection: Gets the name of the error in the `CustomXmlValidationError` object. If no errors exist, the property returns `Nothing` + * For EACH ITEM in the collection: Gets the name of the error in the `CustomXmlValidationError` object. If no errors exist, the property returns `"Nothing"`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -166931,7 +166975,7 @@ declare namespace Word { */ errorCode?: boolean; /** - * Gets the name of the error in the `CustomXmlValidationError` object. If no errors exist, the property returns `Nothing` + * Gets the name of the error in the `CustomXmlValidationError` object. If no errors exist, the property returns `"Nothing"`. * * @remarks * [Api set: WordApi BETA (PREVIEW ONLY)] @@ -198120,10 +198164,10 @@ declare namespace PowerPoint { /** * Exports the slide to its own presentation file, returned as Base64-encoded data. * + * Note: This method is optimized to export a single slide. Exporting multiple slides can impact performance. + * * @remarks * [Api set: PowerPointApi 1.8] - * - * This method is optimized to export a single slide. Exporting multiple slides can impact performance. */ exportAsBase64(): OfficeExtension.ClientResult; /** @@ -198873,7 +198917,7 @@ declare namespace PowerPoint { */ delete(): void; /** - * Returns the shape represented by the binding. Will throw an error if the binding isn't of the correct type. + * Returns the shape represented by the binding. Throws an error if the binding isn't of the correct type. * * @remarks * [Api set: PowerPointApi 1.8] diff --git a/generate-docs/script-inputs/script-lab-snippets.yaml b/generate-docs/script-inputs/script-lab-snippets.yaml index e4de5bfb1a..33f3fdacd7 100644 --- a/generate-docs/script-inputs/script-lab-snippets.yaml +++ b/generate-docs/script-inputs/script-lab-snippets.yaml @@ -445,6 +445,141 @@ Excel.CalculationType:enum: context.application.calculate(Excel.CalculationType.recalculate); await context.sync(); }); +Excel.CardLayoutSection:type: + - >- + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-entity-attribution.yaml + + + function makeProductEntity(productID: number, productName: string, product?: + any) { + const entity: Excel.EntityCellValue = { + type: Excel.CellValueType.entity, + text: productName, + properties: { /* Excel.EntityPropertyType */ + "Product ID": { + type: Excel.CellValueType.string, + basicValue: productID.toString() || "" + }, + "Product Name": { + type: Excel.CellValueType.string, + basicValue: productName || "" + }, + "Quantity Per Unit": { + type: Excel.CellValueType.string, + basicValue: product.quantityPerUnit || "" + }, + // Add Unit Price as a formatted number. + "Unit Price": { + type: Excel.CellValueType.formattedNumber, + basicValue: product.unitPrice, + numberFormat: "$* #,##0.00" + } + }, + layouts: { /* Excel.EntityViewLayouts */ + card: { /* Excel.EntityCardLayout */ + title: { property: "Product Name" }, + sections: [ /* Excel.CardLayoutSection */ + { + layout: "List", + properties: ["Product ID"] + }, + { + layout: "List", + title: "Quantity and price", + collapsible: true, + collapsed: false, + properties: ["Quantity Per Unit", "Unit Price"] + } + ] + } + }, + provider: { + description: product.providerName, // Name of the data provider. Displays as a tooltip when hovering over the logo. Also displays as a fallback if the source address for the image is broken. + logoSourceAddress: product.sourceAddress, // Source URL of the logo to display. + logoTargetAddress: product.targetAddress // Destination URL that the logo navigates to when clicked. + } + }; + + return entity; + } +Excel.CellBorder:interface: + - >- + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/cell-properties.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getActiveWorksheet(); + + // Creating the SettableCellProperties objects to use for the range. + // In your add-in, these should be created once, outside the function. + const topHeaderProps: Excel.SettableCellProperties = { + // The style property takes a string matching the name of an Excel style. + // Built-in style names are listed in the `BuiltInStyle` enum. + // Note that a style will overwrite any formatting, + // so do not use the format property with the style property. + style: "Heading1" + }; + + const headerProps: Excel.SettableCellProperties = { + // Any subproperties of format that are not set will not be changed when these cell properties are set. + format: { + fill: { + color: "Blue" + }, + font: { + color: "White", + bold: true + } + } + }; + + const nonApplicableProps: Excel.SettableCellProperties = { + format: { + fill: { + pattern: Excel.FillPattern.gray25 + }, + font: { + color: "Gray", + italic: true + } + } + }; + + const matchupScoreProps: Excel.SettableCellProperties = { + format: { + borders: { + bottom: { + style: Excel.BorderLineStyle.continuous + }, + left: { + style: Excel.BorderLineStyle.continuous + }, + right: { + style: Excel.BorderLineStyle.continuous + }, + top: { + style: Excel.BorderLineStyle.continuous + } + } + } + }; + + const range = sheet.getRange("A1:E5"); + + // You can use empty JSON objects to avoid changing a cell's properties. + range.setCellProperties([ + [topHeaderProps, {}, {}, {}, {}], + [{}, {}, headerProps, headerProps, headerProps], + [{}, headerProps, nonApplicableProps, matchupScoreProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, nonApplicableProps, matchupScoreProps], + [{}, headerProps, matchupScoreProps, matchupScoreProps, nonApplicableProps] + ]); + + sheet.getUsedRange().format.autofitColumns(); + await context.sync(); + }); Excel.CellControl:type: - >- // Link to full sample: @@ -3490,6 +3625,43 @@ Excel.DataPivotHierarchy#name:member: dataHierarchies.items[0].name = "Farm Sales"; dataHierarchies.items[1].name = "Wholesale"; + await context.sync(); + }); +Excel.DataValidationErrorAlert:interface: + - >- + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/22-data-validation/data-validation.yaml + + + await Excel.run(async (context) => { + const sheet = context.workbook.worksheets.getItem("Decision"); + const rankingRange = sheet.tables.getItem("NameOptionsTable").columns.getItem("Ranking").getDataBodyRange(); + + // When you are developing, it is a good practice to + // clear the dataValidation object with each run of your code. + rankingRange.dataValidation.clear(); + + let greaterThanZeroRule = { + wholeNumber: { + formula1: 0, + operator: Excel.DataValidationOperator.greaterThan + } + }; + rankingRange.dataValidation.rule = greaterThanZeroRule; + + rankingRange.dataValidation.prompt = { + message: "Please enter a positive number.", + showPrompt: true, + title: "Positive numbers only." + }; + + rankingRange.dataValidation.errorAlert = { + message: "Sorry, only positive numbers are allowed", + showAlert: true, + style: "Stop", + title: "Negative Number Entered" + }; + await context.sync(); }); Excel.DataValidation#errorAlert:member: @@ -3835,6 +4007,64 @@ Excel.DynamicFilterCriteria:enum: await context.sync(); }); +Excel.EntityCardLayout:interface: + - >- + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-entity-attribution.yaml + + + function makeProductEntity(productID: number, productName: string, product?: + any) { + const entity: Excel.EntityCellValue = { + type: Excel.CellValueType.entity, + text: productName, + properties: { /* Excel.EntityPropertyType */ + "Product ID": { + type: Excel.CellValueType.string, + basicValue: productID.toString() || "" + }, + "Product Name": { + type: Excel.CellValueType.string, + basicValue: productName || "" + }, + "Quantity Per Unit": { + type: Excel.CellValueType.string, + basicValue: product.quantityPerUnit || "" + }, + // Add Unit Price as a formatted number. + "Unit Price": { + type: Excel.CellValueType.formattedNumber, + basicValue: product.unitPrice, + numberFormat: "$* #,##0.00" + } + }, + layouts: { /* Excel.EntityViewLayouts */ + card: { /* Excel.EntityCardLayout */ + title: { property: "Product Name" }, + sections: [ /* Excel.CardLayoutSection */ + { + layout: "List", + properties: ["Product ID"] + }, + { + layout: "List", + title: "Quantity and price", + collapsible: true, + collapsed: false, + properties: ["Quantity Per Unit", "Unit Price"] + } + ] + } + }, + provider: { + description: product.providerName, // Name of the data provider. Displays as a tooltip when hovering over the logo. Also displays as a fallback if the source address for the image is broken. + logoSourceAddress: product.sourceAddress, // Source URL of the logo to display. + logoTargetAddress: product.targetAddress // Destination URL that the logo navigates to when clicked. + } + }; + + return entity; + } Excel.EntityCompactLayoutIcons:enum: - >- // Link to full sample: @@ -3864,6 +4094,122 @@ Excel.EntityCompactLayoutIcons:enum: }); return entities; } +Excel.EntityPropertyType:type: + - >- + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-entity-attribution.yaml + + + function makeProductEntity(productID: number, productName: string, product?: + any) { + const entity: Excel.EntityCellValue = { + type: Excel.CellValueType.entity, + text: productName, + properties: { /* Excel.EntityPropertyType */ + "Product ID": { + type: Excel.CellValueType.string, + basicValue: productID.toString() || "" + }, + "Product Name": { + type: Excel.CellValueType.string, + basicValue: productName || "" + }, + "Quantity Per Unit": { + type: Excel.CellValueType.string, + basicValue: product.quantityPerUnit || "" + }, + // Add Unit Price as a formatted number. + "Unit Price": { + type: Excel.CellValueType.formattedNumber, + basicValue: product.unitPrice, + numberFormat: "$* #,##0.00" + } + }, + layouts: { /* Excel.EntityViewLayouts */ + card: { /* Excel.EntityCardLayout */ + title: { property: "Product Name" }, + sections: [ /* Excel.CardLayoutSection */ + { + layout: "List", + properties: ["Product ID"] + }, + { + layout: "List", + title: "Quantity and price", + collapsible: true, + collapsed: false, + properties: ["Quantity Per Unit", "Unit Price"] + } + ] + } + }, + provider: { + description: product.providerName, // Name of the data provider. Displays as a tooltip when hovering over the logo. Also displays as a fallback if the source address for the image is broken. + logoSourceAddress: product.sourceAddress, // Source URL of the logo to display. + logoTargetAddress: product.targetAddress // Destination URL that the logo navigates to when clicked. + } + }; + + return entity; + } +Excel.EntityViewLayouts:interface: + - >- + // Link to full sample: + https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-entity-attribution.yaml + + + function makeProductEntity(productID: number, productName: string, product?: + any) { + const entity: Excel.EntityCellValue = { + type: Excel.CellValueType.entity, + text: productName, + properties: { /* Excel.EntityPropertyType */ + "Product ID": { + type: Excel.CellValueType.string, + basicValue: productID.toString() || "" + }, + "Product Name": { + type: Excel.CellValueType.string, + basicValue: productName || "" + }, + "Quantity Per Unit": { + type: Excel.CellValueType.string, + basicValue: product.quantityPerUnit || "" + }, + // Add Unit Price as a formatted number. + "Unit Price": { + type: Excel.CellValueType.formattedNumber, + basicValue: product.unitPrice, + numberFormat: "$* #,##0.00" + } + }, + layouts: { /* Excel.EntityViewLayouts */ + card: { /* Excel.EntityCardLayout */ + title: { property: "Product Name" }, + sections: [ /* Excel.CardLayoutSection */ + { + layout: "List", + properties: ["Product ID"] + }, + { + layout: "List", + title: "Quantity and price", + collapsible: true, + collapsed: false, + properties: ["Quantity Per Unit", "Unit Price"] + } + ] + } + }, + provider: { + description: product.providerName, // Name of the data provider. Displays as a tooltip when hovering over the logo. Also displays as a fallback if the source address for the image is broken. + logoSourceAddress: product.sourceAddress, // Source URL of the logo to display. + logoTargetAddress: product.targetAddress // Destination URL that the logo navigates to when clicked. + } + }; + + return entity; + } Excel.ErrorCellValue:type: - >- // Link to full sample: