ValidationCatView.getClearButton

Syntax

getClearButton();

Description

The getClearButton method returns the Clear button in the Validation tab of workbook ribbon.

Comments

This method returns an object of the PP.Ui.RibbonButton type.

Clicking this button clears all validation errors in the workbook.

Example

To execute the example, the HTML page must contain the WorkbookBox component named workbookBox (see Example of Creating the WorkbookBox Component), and a table must be loaded to workbook data area. A validation rule that finds at least one invalid value must be executed:

Clear all validation errors:

// Get workbook tool ribbon
var ribbon = workbookBox.getRibbonView();
// Get the Validation tab
var validationCategory = ribbon.getValidationCategory();
// Display and open the tab
validationCategory.setIsHiddenActive(True)
ribbon.refreshAll();
// Get the Clear button
var clearButton = validationCategory.getClearButton();
// Fire the button click event
clearButton.Click.fire(this);

After executing the example all validation errors are removed:

See also:

ValidationCatView