API Reference

Class

OdsValidation

Edit on GitHub

Namespace OfficeIMO.OpenDocument

Assembly OfficeIMO.OpenDocument

Source revision 804a7612eee4 with working tree changes

Source OdsNamedRange.cs:98

Modifiers sealed

An XML-backed spreadsheet content validation rule.

Inheritance

Object
OdsValidation

Usage

Explore 2 API references to this type

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

Returned or exposed by 2

Method OdsDocument.AddValidation
Property OdsDocument.Validations

Methods

public Void EnsureErrorMessage(OdsValidationMessageType messageType = Stop, Boolean display = true) #

OdsNamedRange.cs:119

Returns: Void

Ensures an error-message element exists even when it has no title or body.

Parameters

messageType OfficeIMO.OpenDocument.OdsValidationMessageType = Stop optionalposition: 0
display System.Boolean = true optionalposition: 1

public Void EnsureHelpMessage(Boolean display = true) #

OdsNamedRange.cs:103

Returns: Void

Ensures an input-help element exists even when it has no title or body.

Parameters

display System.Boolean = true optionalposition: 0

public Void SetErrorMessage(String? title, String? text, OdsValidationMessageType messageType = Stop, Boolean display = true)

OdsNamedRange.cs:112

Returns: Void

Sets the optional error shown when the entered value fails validation.

Parameters

title System.String? requiredposition: 0
text System.String? requiredposition: 1
messageType OfficeIMO.OpenDocument.OdsValidationMessageType = Stop optionalposition: 2
display System.Boolean = true optionalposition: 3

public Void SetHelpMessage(String? title, String? text, Boolean display = true) #

OdsNamedRange.cs:98

Returns: Void

Sets the optional input help shown when a validated cell is selected.

Parameters

title System.String? requiredposition: 0
text System.String? requiredposition: 1
display System.Boolean = true optionalposition: 2

Inherited Methods

Properties

public String Name { get; } #

OdsNamedRange.cs:54

Validation name.

public String Condition { get; set; } #

OdsNamedRange.cs:57

Preserved ODF validation condition.

public String? BaseCellAddress { get; set; } #

OdsNamedRange.cs:62

Absolute sheet-qualified base cell used to evaluate relative references in the condition.

public OdsValidationConditionSyntax? ParsedCondition { get; set; } #

OdsNamedRange.cs:67

Typed interoperable condition, or null when the preserved expression is implementation-specific.

public Boolean AllowEmptyCell { get; set; } #

OdsNamedRange.cs:72

Whether empty cells satisfy the rule.

public OdsValidationDisplayList DisplayList { get; set; } #

OdsNamedRange.cs:79

How list-validation values are displayed. ODF defaults to OdsValidationDisplayList.Unsorted.

public String? HelpTitle { get; } #

OdsNamedRange.cs:124

Input-help title, if present.

public Boolean HasHelpMessage { get; } #

OdsNamedRange.cs:127

Whether an input-help element is present.

public String? HelpText { get; } #

OdsNamedRange.cs:129

Input-help text, if present.

public Boolean ShowHelpMessage { get; } #

OdsNamedRange.cs:131

Whether input help is displayed.

public String? ErrorTitle { get; } #

OdsNamedRange.cs:133

Validation-error title, if present.

public Boolean HasErrorMessage { get; } #

OdsNamedRange.cs:136

Whether a validation-error element is present.

public String? ErrorText { get; } #

OdsNamedRange.cs:138

Validation-error text, if present.

public Boolean ShowErrorMessage { get; } #

OdsNamedRange.cs:140

Whether validation errors are displayed.

public OdsValidationMessageType ErrorMessageType { get; } #

OdsNamedRange.cs:144

Validation-error severity.