[excel] (Range, Table) Various small samples for Office Scripts (#344)

* Various small samples for Office Scripts

* Add missing comment

Author: AlexJerabek

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

@@ -2304,7 +2304,26 @@ methods:
           type: boolean
       return:
         type: '<xref uid="ExcelScript!ExcelScript.RemoveDuplicatesResult:interface" />'
-        description: ''
+        description: |-
+
+
+          #### Examples
+
+          ```TypeScript
+          /**
+           * This script removes duplicate rows from a range.
+           */
+          function main(workbook: ExcelScript.Workbook) {
+            // Get the used range of the active worksheet.
+            const usedRange = workbook.getActiveWorksheet().getUsedRange();
+
+            // Remove any row that has a same value in the 0-indexed column as a previous row.
+            const removedResults = usedRange.removeDuplicates([0], true);
+
+            // Log the count of removed rows.
+            console.log(`Rows removed: ${removedResults.getRemoved()}.`);
+          }
+          ```
   - name: 'replaceAll(text, replacement, criteria)'
     uid: 'ExcelScript!ExcelScript.Range#replaceAll:member(1)'
     package: ExcelScript!

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

@@ -4,7 +4,26 @@ uid: 'ExcelScript!ExcelScript.RemoveDuplicatesResult:interface'
 package: ExcelScript!
 fullName: ExcelScript.RemoveDuplicatesResult
 summary: Represents the results from `Range.removeDuplicates`<!-- -->.
-remarks: ''
+remarks: |-
+
+
+  #### Examples
+
+  ```TypeScript
+  /**
+   * This script removes duplicate rows from a range.
+   */
+  function main(workbook: ExcelScript.Workbook) {
+    // Get the used range of the active worksheet.
+    const usedRange = workbook.getActiveWorksheet().getUsedRange();
+
+    // Remove any row that has a same value in the 0-indexed column as a previous row.
+    const removedResults: ExcelScript.RemoveDuplicatesResult = usedRange.removeDuplicates([0], true);
+
+    // Log the count of removed rows.
+    console.log(`Rows removed: ${removedResults.getRemoved()}.`);
+  }
+  ```
 isPreview: false
 isDeprecated: false
 type: interface

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

@@ -856,7 +856,25 @@ methods:
           type: boolean
       return:
         type: void
-        description: ''
+        description: |-
+
+
+          #### Examples
+
+          ```TypeScript
+          /**
+           * This script sets all the tables in the workbook to have banded rows. 
+           */
+          function main(workbook: ExcelScript.Workbook) {
+            // Get all the tables.
+            const tables = workbook.getTables();
+
+            // For each table, set the banded row formatting to true.
+            tables.forEach((table) => {
+              table.setShowBandedRows(true);
+            });
+          }
+          ```
   - name: setShowFilterButton(showFilterButton)
     uid: 'ExcelScript!ExcelScript.Table#setShowFilterButton:member(1)'
     package: ExcelScript!

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

@@ -227,4 +227,21 @@ methods:
           type: string
       return:
         type: void
-        description: ''
+        description: |-
+
+
+          #### Examples
+
+          ```TypeScript
+          /**
+           * This script renames a column in an existing table.
+           */
+          function main(workbook: ExcelScript.Workbook) {
+            // Get the "Employee" table.
+            const employeeTable = workbook.getTable("Employee");
+
+            // Rename a column from "EmplID" to "Employee ID".
+            const idColumn = employeeTable.getColumnByName("EmplID");
+            idColumn.setName("Employee ID");
+          }
+          ```

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

@@ -123,4 +123,23 @@ methods:
       content: 'reapply(): void;'
       return:
         type: void
-        description: ''
+        description: |-
+
+
+          #### Examples
+
+          ```TypeScript
+          /**
+           * This script reapplies all the current sorting criteria to existing tables.
+           */
+          function main(workbook: ExcelScript.Workbook) {
+            // Get all the tables.
+            const tables = workbook.getTables();
+
+            // For each table, reapply that table's current sorting parameters.
+            tables.forEach((table) => {
+              const sort: ExcelScript.TableSort = table.getSort();
+              sort.reapply();
+            });
+          }
+          ```

docs/sample-scripts/excel-scripts.yaml

@@ -4283,6 +4283,21 @@
       const range = selectedSheet.getRange("A1:A4");
       range.merge();
     }
+'ExcelScript.Range#removeDuplicates:member(1)':
+  - |-
+    /**
+     * This script removes duplicate rows from a range.
+     */
+    function main(workbook: ExcelScript.Workbook) {
+      // Get the used range of the active worksheet.
+      const usedRange = workbook.getActiveWorksheet().getUsedRange();
+
+      // Remove any row that has a same value in the 0-indexed column as a previous row.
+      const removedResults = usedRange.removeDuplicates([0], true);
+
+      // Log the count of removed rows.
+      console.log(`Rows removed: ${removedResults.getRemoved()}.`);
+    }
 'ExcelScript.Range#replaceAll:member(1)':
   - |-
     /**
@@ -5048,6 +5063,21 @@
       const otherRangeCorner = otherSheet.getRange("A1");
       otherRangeCorner.copyFrom(source, ExcelScript.RangeCopyType.all);
     }
+'ExcelScript.RemoveDuplicatesResult:interface':
+  - |-
+    /**
+     * This script removes duplicate rows from a range.
+     */
+    function main(workbook: ExcelScript.Workbook) {
+      // Get the used range of the active worksheet.
+      const usedRange = workbook.getActiveWorksheet().getUsedRange();
+
+      // Remove any row that has a same value in the 0-indexed column as a previous row.
+      const removedResults: ExcelScript.RemoveDuplicatesResult = usedRange.removeDuplicates([0], true);
+
+      // Log the count of removed rows.
+      console.log(`Rows removed: ${removedResults.getRemoved()}.`);
+    }
 'ExcelScript.ReplaceCriteria#completeMatch:member':
   - |-
     /**
@@ -5814,6 +5844,20 @@
         table.reapplyFilters();
       });
     }
+'ExcelScript.Table#setShowBandedRows:member(1)':
+  - |-
+    /**
+     * This script sets all the tables in the workbook to have banded rows. 
+     */
+    function main(workbook: ExcelScript.Workbook) {
+      // Get all the tables.
+      const tables = workbook.getTables();
+
+      // For each table, set the banded row formatting to true.
+      tables.forEach((table) => {
+        table.setShowBandedRows(true);
+      });
+    }
 'ExcelScript.Table#setShowHeaders:member(1)':
   - |-
     /**
@@ -5908,6 +5952,19 @@
         `=[@[${productColumnName1}]]*[@[${productColumnName2}]]`
       );
     }
+'ExcelScript.TableColumn#setName:member(1)':
+  - |-
+    /**
+     * This script renames a column in an existing table.
+     */
+    function main(workbook: ExcelScript.Workbook) {
+      // Get the "Employee" table.
+      const employeeTable = workbook.getTable("Employee");
+
+      // Rename a column from "EmplID" to "Employee ID".
+      const idColumn = employeeTable.getColumnByName("EmplID");
+      idColumn.setName("Employee ID");
+    }
 'ExcelScript.TableSort#apply:member(1)':
   - |-
     /**
@@ -5924,6 +5981,21 @@
       // Sort the table using the first column.
       newTable.getSort().apply([{ key: 0, ascending: true }]);
     }
+'ExcelScript.TableSort#reapply:member(1)':
+  - |-
+    /**
+     * This script reapplies all the current sorting criteria to existing tables.
+     */
+    function main(workbook: ExcelScript.Workbook) {
+      // Get all the tables.
+      const tables = workbook.getTables();
+
+      // For each table, reapply that table's current sorting parameters.
+      tables.forEach((table) => {
+        const sort: ExcelScript.TableSort = table.getSort();
+        sort.reapply();
+      });
+    }
 'ExcelScript.TextConditionalFormat:interface':
   - |-
     /**

generate-docs/API Coverage Report.csv

@@ -2453,7 +2453,7 @@ ExcelScript.Range,"hideGroupDetails(groupOption)",Method,Poor,false
 ExcelScript.Range,"insert(shift)",Method,Fine,true
 ExcelScript.Range,"merge(across)",Method,Fine,true
 ExcelScript.Range,"moveTo(destinationRange)",Method,Poor,false
-ExcelScript.Range,"removeDuplicates(columns, includesHeader)",Method,Poor,false
+ExcelScript.Range,"removeDuplicates(columns, includesHeader)",Method,Fine,true
 ExcelScript.Range,"replaceAll(text, replacement, criteria)",Method,Poor,true
 ExcelScript.Range,"select()",Method,Poor,true
 ExcelScript.Range,"setColumnHidden(columnHidden)",Method,Poor,false
@@ -2635,7 +2635,7 @@ ExcelScript.ReadingOrder,N/A,Enum,Missing,false
 ExcelScript.ReadingOrder,"context",EnumField,Good,false
 ExcelScript.ReadingOrder,"leftToRight",EnumField,Poor,false
 ExcelScript.ReadingOrder,"rightToLeft",EnumField,Poor,false
-ExcelScript.RemoveDuplicatesResult,N/A,Class,Fine,false
+ExcelScript.RemoveDuplicatesResult,N/A,Class,Fine,true
 ExcelScript.RemoveDuplicatesResult,"getRemoved()",Method,Poor,false
 ExcelScript.RemoveDuplicatesResult,"getUniqueRemaining()",Method,Poor,false
 ExcelScript.ReplaceCriteria,N/A,Class,Fine,false
@@ -3016,7 +3016,7 @@ ExcelScript.Table,"setHighlightLastColumn(highlightLastColumn)",Method,Poor,fals
 ExcelScript.Table,"setName(name)",Method,Poor,false
 ExcelScript.Table,"setPredefinedTableStyle(predefinedTableStyle)",Method,Poor,false
 ExcelScript.Table,"setShowBandedColumns(showBandedColumns)",Method,Poor,false
-ExcelScript.Table,"setShowBandedRows(showBandedRows)",Method,Poor,false
+ExcelScript.Table,"setShowBandedRows(showBandedRows)",Method,Poor,true
 ExcelScript.Table,"setShowFilterButton(showFilterButton)",Method,Poor,false
 ExcelScript.Table,"setShowHeaders(showHeaders)",Method,Poor,true
 ExcelScript.Table,"setShowTotals(showTotals)",Method,Poor,true
@@ -3030,14 +3030,14 @@ ExcelScript.TableColumn,"getName()",Method,Poor,false
 ExcelScript.TableColumn,"getRange()",Method,Poor,false
 ExcelScript.TableColumn,"getRangeBetweenHeaderAndTotal()",Method,Fine,true
 ExcelScript.TableColumn,"getTotalRowRange()",Method,Poor,false
-ExcelScript.TableColumn,"setName(name)",Method,Poor,false
+ExcelScript.TableColumn,"setName(name)",Method,Poor,true
 ExcelScript.TableSort,N/A,Class,Fine,false
 ExcelScript.TableSort,"apply(fields, matchCase, method)",Method,Fine,true
 ExcelScript.TableSort,"clear()",Method,Poor,false
 ExcelScript.TableSort,"getFields()",Method,Poor,false
 ExcelScript.TableSort,"getMatchCase()",Method,Poor,false
 ExcelScript.TableSort,"getMethod()",Method,Poor,false
-ExcelScript.TableSort,"reapply()",Method,Poor,false
+ExcelScript.TableSort,"reapply()",Method,Poor,true
 ExcelScript.TableStyle,N/A,Class,Fine,false
 ExcelScript.TableStyle,"delete()",Method,Poor,false
 ExcelScript.TableStyle,"duplicate()",Method,Poor,false