Get Started

API Reference

Class

ExcelRangeDataValidationBuilder

Edit on GitHub
Namespace OfficeIMO.Excel
Assembly OfficeIMO.Excel
Source OfficeIMO.Excel/ExcelRangeDataValidationBuilder.cs:18
Modifiers sealed

Fluent data validation builder for an ExcelRange.

Inheritance

  • Object
  • ExcelRangeDataValidationBuilder

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Methods

public ExcelRange Clear() #
OfficeIMO.Excel/ExcelRangeDataValidationBuilder.cs:126
Returns: ExcelRange

Removes data validations that overlap the range.

public ExcelRange CustomFormula(String formula, Boolean allowBlank = true, String errorTitle = null, String errorMessage = null) #
OfficeIMO.Excel/ExcelRangeDataValidationBuilder.cs:110
Returns: ExcelRange

Applies custom formula validation.

Parameters

formula System.String requiredposition: 0
allowBlank System.Boolean = true optionalposition: 1
errorTitle System.String = null optionalposition: 2
errorMessage System.String = null optionalposition: 3
public ExcelRange Date(DataValidationOperatorValues operator, DateTime formula1, Nullable<DateTime> formula2 = null, Boolean allowBlank = true, String errorTitle = null, String errorMessage = null) #
OfficeIMO.Excel/ExcelRangeDataValidationBuilder.cs:79
Returns: ExcelRange

Applies date validation.

Parameters

operator DocumentFormat.OpenXml.Spreadsheet.DataValidationOperatorValues requiredposition: 0
formula1 System.DateTime requiredposition: 1
formula2 System.Nullable{System.DateTime} = null optionalposition: 2
allowBlank System.Boolean = true optionalposition: 3
errorTitle System.String = null optionalposition: 4
errorMessage System.String = null optionalposition: 5
public ExcelRange DateBetween(DateTime minimum, DateTime maximum, Boolean allowBlank = true, String errorTitle = null, String errorMessage = null) #
OfficeIMO.Excel/ExcelRangeDataValidationBuilder.cs:87
Returns: ExcelRange

Applies date validation between two dates.

Parameters

minimum System.DateTime requiredposition: 0
maximum System.DateTime requiredposition: 1
allowBlank System.Boolean = true optionalposition: 2
errorTitle System.String = null optionalposition: 3
errorMessage System.String = null optionalposition: 4
public ExcelRange Decimal(DataValidationOperatorValues operator, Double formula1, Nullable<Double> formula2 = null, Boolean allowBlank = true, String errorTitle = null, String errorMessage = null) #
OfficeIMO.Excel/ExcelRangeDataValidationBuilder.cs:64
Returns: ExcelRange

Applies decimal-number validation.

Parameters

operator DocumentFormat.OpenXml.Spreadsheet.DataValidationOperatorValues requiredposition: 0
formula1 System.Double requiredposition: 1
formula2 System.Nullable{System.Double} = null optionalposition: 2
allowBlank System.Boolean = true optionalposition: 3
errorTitle System.String = null optionalposition: 4
errorMessage System.String = null optionalposition: 5
public ExcelRange DecimalBetween(Double minimum, Double maximum, Boolean allowBlank = true, String errorTitle = null, String errorMessage = null) #
OfficeIMO.Excel/ExcelRangeDataValidationBuilder.cs:72
Returns: ExcelRange

Applies decimal-number validation between two values.

Parameters

minimum System.Double requiredposition: 0
maximum System.Double requiredposition: 1
allowBlank System.Boolean = true optionalposition: 2
errorTitle System.String = null optionalposition: 3
errorMessage System.String = null optionalposition: 4
List 2 overloads
public ExcelRange List(params String[] items) #
OfficeIMO.Excel/ExcelRangeDataValidationBuilder.cs:18
Returns: ExcelRange

Applies list validation from inline items.

Parameters

items System.String[] requiredposition: 0
public ExcelRange List(IEnumerable<String> items, Boolean allowBlank = true) #
OfficeIMO.Excel/ExcelRangeDataValidationBuilder.cs:25
Returns: ExcelRange

Applies list validation from inline items.

Parameters

items System.Collections.Generic.IEnumerable{System.String} requiredposition: 0
allowBlank System.Boolean = true optionalposition: 1
public ExcelRange ListNamedRange(String namedRange, Boolean allowBlank = true) #
OfficeIMO.Excel/ExcelRangeDataValidationBuilder.cs:33
Returns: ExcelRange

Applies list validation using a workbook or sheet-local named range.

Parameters

namedRange System.String requiredposition: 0
allowBlank System.Boolean = true optionalposition: 1
public ExcelRange ListRange(String sourceA1Range, String sourceSheetName = null, Boolean allowBlank = true) #
OfficeIMO.Excel/ExcelRangeDataValidationBuilder.cs:41
Returns: ExcelRange

Applies list validation using a worksheet range.

Parameters

sourceA1Range System.String requiredposition: 0
sourceSheetName System.String = null optionalposition: 1
allowBlank System.Boolean = true optionalposition: 2
public ExcelRange Messages(ExcelDataValidationMessageOptions options) #
OfficeIMO.Excel/ExcelRangeDataValidationBuilder.cs:118
Returns: ExcelRange

Applies prompt and error message metadata to validations that overlap the range.

Parameters

options OfficeIMO.Excel.ExcelDataValidationMessageOptions requiredposition: 0
public ExcelRange TextLength(DataValidationOperatorValues operator, Int32 formula1, Nullable<Int32> formula2 = null, Boolean allowBlank = true, String errorTitle = null, String errorMessage = null) #
OfficeIMO.Excel/ExcelRangeDataValidationBuilder.cs:102
Returns: ExcelRange

Applies text-length validation.

Parameters

operator DocumentFormat.OpenXml.Spreadsheet.DataValidationOperatorValues requiredposition: 0
formula1 System.Int32 requiredposition: 1
formula2 System.Nullable{System.Int32} = null optionalposition: 2
allowBlank System.Boolean = true optionalposition: 3
errorTitle System.String = null optionalposition: 4
errorMessage System.String = null optionalposition: 5
public ExcelRange Time(DataValidationOperatorValues operator, TimeSpan formula1, Nullable<TimeSpan> formula2 = null, Boolean allowBlank = true, String errorTitle = null, String errorMessage = null) #
OfficeIMO.Excel/ExcelRangeDataValidationBuilder.cs:94
Returns: ExcelRange

Applies time validation.

Parameters

operator DocumentFormat.OpenXml.Spreadsheet.DataValidationOperatorValues requiredposition: 0
formula1 System.TimeSpan requiredposition: 1
formula2 System.Nullable{System.TimeSpan} = null optionalposition: 2
allowBlank System.Boolean = true optionalposition: 3
errorTitle System.String = null optionalposition: 4
errorMessage System.String = null optionalposition: 5
public ExcelRange WholeNumber(DataValidationOperatorValues operator, Int32 formula1, Nullable<Int32> formula2 = null, Boolean allowBlank = true, String errorTitle = null, String errorMessage = null) #
OfficeIMO.Excel/ExcelRangeDataValidationBuilder.cs:49
Returns: ExcelRange

Applies whole-number validation.

Parameters

operator DocumentFormat.OpenXml.Spreadsheet.DataValidationOperatorValues requiredposition: 0
formula1 System.Int32 requiredposition: 1
formula2 System.Nullable{System.Int32} = null optionalposition: 2
allowBlank System.Boolean = true optionalposition: 3
errorTitle System.String = null optionalposition: 4
errorMessage System.String = null optionalposition: 5
public ExcelRange WholeNumberBetween(Int32 minimum, Int32 maximum, Boolean allowBlank = true, String errorTitle = null, String errorMessage = null) #
OfficeIMO.Excel/ExcelRangeDataValidationBuilder.cs:57
Returns: ExcelRange

Applies whole-number validation between two values.

Parameters

minimum System.Int32 requiredposition: 0
maximum System.Int32 requiredposition: 1
allowBlank System.Boolean = true optionalposition: 2
errorTitle System.String = null optionalposition: 3
errorMessage System.String = null optionalposition: 4