API Reference
OdsValidation
An XML-backed spreadsheet content validation rule.
Inheritance
- Object
- OdsValidation
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
- Method OdsDocument.AddValidation
- Method OdsDocument.AddValidation
- Property OdsDocument.Validations
Methods
public Void EnsureErrorMessage(OdsValidationMessageType messageType = Stop, Boolean display = true) #VoidEnsures an error-message element exists even when it has no title or body.
Parameters
- messageType OfficeIMO.OpenDocument.OdsValidationMessageType = Stop
- display System.Boolean = true
public Void EnsureHelpMessage(Boolean display = true) #VoidEnsures an input-help element exists even when it has no title or body.
Parameters
- display System.Boolean = true
public Void SetErrorMessage(String title, String text, OdsValidationMessageType messageType = Stop, Boolean display = true) #VoidSets the optional error shown when the entered value fails validation.
Parameters
- title System.String
- text System.String
- messageType OfficeIMO.OpenDocument.OdsValidationMessageType = Stop
- display System.Boolean = true
public Void SetHelpMessage(String title, String text, Boolean display = true) #VoidSets the optional input help shown when a validated cell is selected.
Parameters
- title System.String
- text System.String
- display System.Boolean = true
Inherited Methods
public override Boolean Equals(Object obj) #BooleanParameters
- obj Object
Properties
public String Condition { get; set; } #Preserved ODF validation condition.
public OdsValidationConditionSyntax ParsedCondition { get; set; } #Typed interoperable condition, or null when the preserved expression is implementation-specific.
public Boolean AllowEmptyCell { get; set; } #Whether empty cells satisfy the rule.
public OdsValidationDisplayList DisplayList { get; set; } #How list-validation values are displayed. ODF defaults to Unsorted.
public String HelpTitle { get; } #Input-help title, if present.
public Boolean HasHelpMessage { get; } #Whether an input-help element is present.
public String HelpText { get; } #Input-help text, if present.
public Boolean ShowHelpMessage { get; } #Whether input help is displayed.
public String ErrorTitle { get; } #Validation-error title, if present.
public Boolean HasErrorMessage { get; } #Whether a validation-error element is present.
public String ErrorText { get; } #Validation-error text, if present.
public Boolean ShowErrorMessage { get; } #Whether validation errors are displayed.
public OdsValidationMessageType ErrorMessageType { get; } #Validation-error severity.