Interface IExcelDataValidation

A generic interface for all data validations. Specialized implementation interfaces should inherit this interface.

Namespace: OfficeOpenXml.DataValidation.Contracts

Assembly: EPPlus.dll

Syntax

public interface IExcelDataValidation

Properties

Address

Address of data validation

Declaration

ExcelAddress Address { get; }

Property Value

Type	Description
ExcelAddress

AllowBlank

True if input message should be shown

Declaration

bool? AllowBlank { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

AllowsOperator

True if the current validation type allows operator.

Declaration

bool AllowsOperator { get; }

Property Value

Type	Description
System.Boolean

As

Use this property to cast an instance of IExcelDataValidation to its subtype, see ExcelDataValidationAsType.

Declaration

ExcelDataValidationAsType As { get; }

Property Value

Type	Description
ExcelDataValidationAsType

Error

Error message box text (see property ShowErrorMessage)

Declaration

string Error { get; set; }

Property Value

Type	Description
System.String

ErrorStyle

Controls how Excel will handle invalid values.

Declaration

ExcelDataValidationWarningStyle ErrorStyle { get; set; }

Property Value

Type	Description
ExcelDataValidationWarningStyle

ErrorTitle

Title of error message box (see property ShowErrorMessage)

Declaration

string ErrorTitle { get; set; }

Property Value

Type	Description
System.String

ImeMode

Defines mode for Input Method Editor used in east-asian languages

Declaration

ExcelDataValidationImeMode ImeMode { get; set; }

Property Value

Type	Description
ExcelDataValidationImeMode

IsStale

Indicates whether this instance is stale, see https://github.com/EPPlusSoftware/EPPlus/wiki/Data-validation-Exceptions

Declaration

bool IsStale { get; }

Property Value

Type	Description
System.Boolean

Prompt

Info message text (see property ShowErrorMessage)

Declaration

string Prompt { get; set; }

Property Value

Type	Description
System.String

PromptTitle

Title of info box if input message should be shown (see property ShowInputMessage)

Declaration

string PromptTitle { get; set; }

Property Value

Type	Description
System.String

ShowErrorMessage

True if error message should be shown.

Declaration

bool? ShowErrorMessage { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

ShowInputMessage

True if input message should be shown

Declaration

bool? ShowInputMessage { get; set; }

Property Value

Type	Description
System.Nullable<System.Boolean>

Uid

Unique id of the data validation

Declaration

string Uid { get; }

Property Value

Type	Description
System.String

ValidationType

Validation type

Declaration

ExcelDataValidationType ValidationType { get; }

Property Value

Type	Description
ExcelDataValidationType

Methods

Validate()

Validates the state of the validation.

Declaration

void Validate()