RuleAlertProperties

View as Markdown

Properties for rule-based alerts (presentation plus grid behaviours)

TypeScript
export interface RuleAlertProperties extends
Extends

AlertPresentationProperties

Properties

PropertyTypeDescriptionDefault
HighlightCellboolean |AdaptableStyleColours the cell that triggered the alert. true uses the colour for MessageType. An is applied instead of that colour.
HighlightRowboolean |AdaptableStyleColours the row that triggered the alert. true uses the colour for MessageType. An is applied instead of that colour.
JumpToCellbooleanGrid will 'jump' to the changed cell which triggered the Alert
JumpToRowbooleanGrid will 'jump' to the newly added row which triggered the Alert
PreventEditbooleanAutomatically prevent any cell edit which triggered the Alert (i.e. validation)false

Property Details

HighlightCell

Colours the cell that triggered the alert. true uses the colour for MessageType. An is applied instead of that colour.

TypeScript
HighlightCell?: boolean | AdaptableStyle;
Property Value

boolean |AdaptableStyle

HighlightRow

Colours the row that triggered the alert. true uses the colour for MessageType. An is applied instead of that colour.

TypeScript
HighlightRow?: boolean | AdaptableStyle;
Property Value

boolean |AdaptableStyle

JumpToCell

Grid will 'jump' to the changed cell which triggered the Alert

TypeScript
JumpToCell?: boolean;
Property Value

boolean

JumpToRow

Grid will 'jump' to the newly added row which triggered the Alert

TypeScript
JumpToRow?: boolean;
Property Value

boolean

PreventEdit

Automatically prevent any cell edit which triggered the Alert (i.e. validation)

TypeScript
PreventEdit?: boolean;
Default Value

false

Property Value

boolean