API Reference

Class

LegacyXlsDataValidation

Namespace OfficeIMO.Excel.LegacyXls.Model
Assembly OfficeIMO.Excel
Modifiers sealed

Represents a data validation rule parsed from a legacy BIFF worksheet.

Inheritance

  • Object
  • LegacyXlsDataValidation

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

Constructors

public LegacyXlsDataValidation(LegacyXlsDataValidationType type, LegacyXlsDataValidationOperator operator, String formula1, String formula2, Boolean allowBlank, Boolean showInputMessage, Boolean showErrorMessage, String promptTitle, String prompt, String errorTitle, String error, IReadOnlyList<String> ranges, IReadOnlyList<String> listItems = null, String listSourceRange = null, String listSourceName = null, String listSourceSheetName = null, LegacyXlsDataValidationErrorStyle errorStyle = Stop, Boolean suppressDropDown = false) #

Creates a parsed legacy XLS data validation rule.

Parameters

type OfficeIMO.Excel.LegacyXls.Model.LegacyXlsDataValidationType requiredposition: 0
operator OfficeIMO.Excel.LegacyXls.Model.LegacyXlsDataValidationOperator requiredposition: 1
formula1 System.String requiredposition: 2
formula2 System.String requiredposition: 3
allowBlank System.Boolean requiredposition: 4
showInputMessage System.Boolean requiredposition: 5
showErrorMessage System.Boolean requiredposition: 6
promptTitle System.String requiredposition: 7
prompt System.String requiredposition: 8
errorTitle System.String requiredposition: 9
error System.String requiredposition: 10
ranges System.Collections.Generic.IReadOnlyList{System.String} requiredposition: 11
listItems System.Collections.Generic.IReadOnlyList{System.String} = null optionalposition: 12
listSourceRange System.String = null optionalposition: 13
listSourceName System.String = null optionalposition: 14
listSourceSheetName System.String = null optionalposition: 15
errorStyle OfficeIMO.Excel.LegacyXls.Model.LegacyXlsDataValidationErrorStyle = Stop optionalposition: 16
suppressDropDown System.Boolean = false optionalposition: 17

Properties

public LegacyXlsDataValidationType Type { get; } #

Gets the legacy validation type.

public LegacyXlsDataValidationOperator Operator { get; } #

Gets the validation comparison operator.

public String Formula1 { get; } #

Gets the first validation formula, normalized for Open XML projection.

public String Formula2 { get; } #

Gets the second validation formula, when required by the operator.

public Boolean AllowBlank { get; } #

Gets whether blank values are accepted by the validation.

public Boolean ShowInputMessage { get; } #

Gets whether Excel should show an input prompt for the validation.

public Boolean ShowErrorMessage { get; } #

Gets whether Excel should show an error prompt for invalid entries.

public LegacyXlsDataValidationErrorStyle ErrorStyle { get; } #

Gets the error alert style shown when invalid entries are rejected.

public Boolean SuppressDropDown { get; } #

Gets whether list validations suppress Excel's in-cell dropdown.

public String PromptTitle { get; } #

Gets the input prompt title.

public String Prompt { get; } #

Gets the input prompt body.

public String ErrorTitle { get; } #

Gets the error prompt title.

public String Error { get; } #

Gets the error prompt body.

public IReadOnlyList<String> Ranges { get; } #

Gets the A1 ranges covered by this validation rule.

public Int32 RangeCount { get; } #

Gets the number of A1 ranges covered by this validation rule.

public IReadOnlyList<String> ListItems { get; } #

Gets inline list items for list validation rules.

public String ListSourceRange { get; } #

Gets the same-sheet A1 source range for range-backed list validation rules.

public String ListSourceSheetName { get; } #

Gets the source sheet for sheet-qualified range-backed list validation rules.

public String ListSourceName { get; } #

Gets the defined name source for named-range-backed list validation rules.

public LegacyXlsDataValidationListSourceKind ListSourceKind { get; } #

Gets the source shape used by list validation rules.