Add CustomDataValidation sample (#342)

Author: AlexJerabek

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

@@ -4,7 +4,32 @@ uid: 'ExcelScript!ExcelScript.CustomDataValidation:interface'
 package: ExcelScript!
 fullName: ExcelScript.CustomDataValidation
 summary: Represents the custom data validation criteria.
-remarks: ''
+remarks: |-
+
+
+  #### Examples
+
+  ```TypeScript
+  /**
+   * This script adds data validation to a range.
+   * The validation prevents duplicate entries within that range.
+   */
+  function main(workbook: ExcelScript.Workbook) {
+    // Get the range "B2:B20".
+    const sheet = workbook.getActiveWorksheet();
+    const range = sheet.getRange("B2:B20");
+
+    // Set data validation on the range to prevent duplicate, non-blank entries.
+    const dataValidation = range.getDataValidation();
+    dataValidation.setIgnoreBlanks(true);
+    const duplicateRule : ExcelScript.CustomDataValidation = { 
+      formula: "=COUNTIF($B$2:$B$20, B2)=1"
+    };
+    dataValidation.setRule({
+      custom: duplicateRule
+    });
+  }
+  ```
 isPreview: false
 isDeprecated: false
 type: interface

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

@@ -23,6 +23,32 @@ properties:
       content: 'custom?: CustomDataValidation;'
       return:
         type: '<xref uid="ExcelScript!ExcelScript.CustomDataValidation:interface" />'
+        description: |-
+
+
+          #### Examples
+
+          ```TypeScript
+          /**
+           * This script adds data validation to a range.
+           * The validation prevents duplicate entries within that range.
+           */
+          function main(workbook: ExcelScript.Workbook) {
+            // Get the range "B2:B20".
+            const sheet = workbook.getActiveWorksheet();
+            const range = sheet.getRange("B2:B20");
+
+            // Set data validation on the range to prevent duplicate, non-blank entries.
+            const dataValidation = range.getDataValidation();
+            dataValidation.setIgnoreBlanks(true);
+            const duplicateRule : ExcelScript.CustomDataValidation = { 
+              formula: "=COUNTIF($B$2:$B$20, B2)=1"
+            };
+            dataValidation.setRule({
+              custom: duplicateRule
+            });
+          }
+          ```
   - name: date
     uid: 'ExcelScript!ExcelScript.DataValidationRule#date:member'
     package: ExcelScript!

docs/sample-scripts/excel-scripts.yaml

@@ -1632,6 +1632,27 @@
       noChange.getCustom().getFormat().getFill().setColor("lightyellow");
       noChange.getCustom().getRule().setFormula(`=${selectedRange.getCell(0, 0).getAddress()}=${selectedRange.getOffsetRange(0, -1).getCell(0, 0).getAddress()}`);
     }
+'ExcelScript.CustomDataValidation:interface':
+  - |-
+    /**
+     * This script adds data validation to a range.
+     * The validation prevents duplicate entries within that range.
+     */
+    function main(workbook: ExcelScript.Workbook) {
+      // Get the range "B2:B20".
+      const sheet = workbook.getActiveWorksheet();
+      const range = sheet.getRange("B2:B20");
+
+      // Set data validation on the range to prevent duplicate, non-blank entries.
+      const dataValidation = range.getDataValidation();
+      dataValidation.setIgnoreBlanks(true);
+      const duplicateRule : ExcelScript.CustomDataValidation = { 
+        formula: "=COUNTIF($B$2:$B$20, B2)=1"
+      };
+      dataValidation.setRule({
+        custom: duplicateRule
+      });
+    }
 'ExcelScript.DataBarConditionalFormat:interface':
   - |-
     /**
@@ -1897,6 +1918,27 @@
         }
         dataValidation.setPrompt(prompt);
     }    
+'ExcelScript.DataValidationRule#custom:member':
+  - |-
+    /**
+     * This script adds data validation to a range.
+     * The validation prevents duplicate entries within that range.
+     */
+    function main(workbook: ExcelScript.Workbook) {
+      // Get the range "B2:B20".
+      const sheet = workbook.getActiveWorksheet();
+      const range = sheet.getRange("B2:B20");
+
+      // Set data validation on the range to prevent duplicate, non-blank entries.
+      const dataValidation = range.getDataValidation();
+      dataValidation.setIgnoreBlanks(true);
+      const duplicateRule : ExcelScript.CustomDataValidation = { 
+        formula: "=COUNTIF($B$2:$B$20, B2)=1"
+      };
+      dataValidation.setRule({
+        custom: duplicateRule
+      });
+    }
 'ExcelScript.DataValidationRule#list:member':
   - |-
     /**

generate-docs/API Coverage Report.csv

@@ -1328,7 +1328,7 @@ ExcelScript.CultureInfo,"getNumberFormat()",Method,Poor,false
 ExcelScript.CustomConditionalFormat,N/A,Class,Fine,true
 ExcelScript.CustomConditionalFormat,"getFormat()",Method,Poor,false
 ExcelScript.CustomConditionalFormat,"getRule()",Method,Poor,false
-ExcelScript.CustomDataValidation,N/A,Class,Fine,false
+ExcelScript.CustomDataValidation,N/A,Class,Fine,true
 ExcelScript.CustomDataValidation,"formula",Property,Good,false
 ExcelScript.CustomProperty,N/A,Class,Poor,false
 ExcelScript.CustomProperty,"delete()",Method,Poor,false
@@ -1407,7 +1407,7 @@ ExcelScript.DataValidationPrompt,"message",Property,Fine,false
 ExcelScript.DataValidationPrompt,"showPrompt",Property,Fine,false
 ExcelScript.DataValidationPrompt,"title",Property,Fine,false
 ExcelScript.DataValidationRule,N/A,Class,Good,false
-ExcelScript.DataValidationRule,"custom",Property,Poor,false
+ExcelScript.DataValidationRule,"custom",Property,Poor,true
 ExcelScript.DataValidationRule,"date",Property,Poor,false
 ExcelScript.DataValidationRule,"decimal",Property,Poor,false
 ExcelScript.DataValidationRule,"list",Property,Poor,true