@univerjs/sheets-data-validation v0.5.4


Class: FDataValidationEvent

Defined in: sheets-data-validation/src/facade/f-event.ts:271

Implements

  • IDataValidationEvent

Constructors

new FDataValidationEvent()

new FDataValidationEvent(): FDataValidationEvent

Returns

FDataValidationEvent

Accessors

BeforeSheetDataValidationAdd

Get Signature

get BeforeSheetDataValidationAdd(): "BeforeSheetDataValidationAdd"

Defined in: sheets-data-validation/src/facade/f-event.ts:280

Event fired before a rule is added

See

IBeforeSheetDataValidationAddEvent

Example
univerAPI.on(univerAPI.Event.BeforeSheetDataValidationAdd, (event) => {
     const { worksheet, workbook, rule } = event;
    console.log(event);
});
Returns

"BeforeSheetDataValidationAdd"

Implementation of

IDataValidationEvent.BeforeSheetDataValidationAdd

BeforeSheetDataValidationCriteriaUpdate

Get Signature

get BeforeSheetDataValidationCriteriaUpdate(): "BeforeSheetDataValidationCriteriaUpdate"

Defined in: sheets-data-validation/src/facade/f-event.ts:292

Event fired before the criteria of a rule are updated

See

IBeforeSheetDataValidationCriteriaUpdateEvent

Example
univerAPI.on(univerAPI.Event.BeforeSheetDataValidationCriteriaUpdate, (event) => {
    const { worksheet, workbook, rule, newCriteria } = event;
    console.log(event);
});
Returns

"BeforeSheetDataValidationCriteriaUpdate"

Implementation of

IDataValidationEvent.BeforeSheetDataValidationCriteriaUpdate

BeforeSheetDataValidationDelete

Get Signature

get BeforeSheetDataValidationDelete(): "BeforeSheetDataValidationDelete"

Defined in: sheets-data-validation/src/facade/f-event.ts:284

Event fired before a rule is deleted

See

IBeforeSheetDataValidationDeleteEvent

Example
univerAPI.on(univerAPI.Event.BeforeSheetDataValidationDelete, (event) => {
    const { worksheet, workbook, rule } = event;
    console.log(event);
});
Returns

"BeforeSheetDataValidationDelete"

Implementation of

IDataValidationEvent.BeforeSheetDataValidationDelete

BeforeSheetDataValidationDeleteAll

Get Signature

get BeforeSheetDataValidationDeleteAll(): "BeforeSheetDataValidationDeleteAll"

Defined in: sheets-data-validation/src/facade/f-event.ts:288

Event fired before all rules are deleted

See

IBeforeSheetDataValidationDeleteAllEvent

Example
univerAPI.on(univerAPI.Event.BeforeSheetDataValidationDeleteAll, (event) => {
    const { worksheet, workbook, rules } = event;
    console.log(event);
});
Returns

"BeforeSheetDataValidationDeleteAll"

Implementation of

IDataValidationEvent.BeforeSheetDataValidationDeleteAll

BeforeSheetDataValidationOptionsUpdate

Get Signature

get BeforeSheetDataValidationOptionsUpdate(): "BeforeSheetDataValidationOptionsUpdate"

Defined in: sheets-data-validation/src/facade/f-event.ts:300

Event fired before the options of a rule are updated

See

IBeforeSheetDataValidationOptionsUpdateEvent

Example
univerAPI.on(univerAPI.Event.BeforeSheetDataValidationOptionsUpdate, (event) => {
    const { worksheet, workbook, rule, newOptions } = event;
    console.log(event);
});
Returns

"BeforeSheetDataValidationOptionsUpdate"

Implementation of

IDataValidationEvent.BeforeSheetDataValidationOptionsUpdate

BeforeSheetDataValidationRangeUpdate

Get Signature

get BeforeSheetDataValidationRangeUpdate(): "BeforeSheetDataValidationRangeUpdate"

Defined in: sheets-data-validation/src/facade/f-event.ts:296

Event fired before the range of a rule is updated

See

IBeforeSheetDataValidationRangeUpdateEvent

Example
univerAPI.on(univerAPI.Event.BeforeSheetDataValidationRangeUpdate, (event) => {
    const { worksheet, workbook, rule, newRanges } = event;
    console.log(event);
});
Returns

"BeforeSheetDataValidationRangeUpdate"

Implementation of

IDataValidationEvent.BeforeSheetDataValidationRangeUpdate

SheetDataValidationChanged

Get Signature

get SheetDataValidationChanged(): "SheetDataValidationChanged"

Defined in: sheets-data-validation/src/facade/f-event.ts:272

Event fired when a rule is added, deleted, or modified

See

ISheetDataValidationChangedEvent

Example
univerAPI.on(univerAPI.Event.SheetDataValidationChanged, (event) => {
    const { worksheet, workbook, changeType, oldRule, rule } = event;
    console.log(event);
});
Returns

"SheetDataValidationChanged"

Implementation of

IDataValidationEvent.SheetDataValidationChanged

SheetDataValidatorStatusChanged

Get Signature

get SheetDataValidatorStatusChanged(): "SheetDataValidatorStatusChanged"

Defined in: sheets-data-validation/src/facade/f-event.ts:276

Event fired when a cell validator status is changed

See

ISheetDataValidatorStatusChangedEvent

Example
univerAPI.on(univerAPI.Event.SheetDataValidatorStatusChanged, (event) => {
    const { worksheet, workbook, row, column, status, rule } = event;
    console.log(event);
});
Returns

"SheetDataValidatorStatusChanged"

Implementation of

IDataValidationEvent.SheetDataValidatorStatusChanged