BooleanChecker Class
Heirarchy
-
Selector
- BooleanChecker
Constructors
Properties
Methods
Events
Constructors
constructor
- new
Boolean Checker(column?: Column, options?: any): BooleanChecker
-
Initializes a new instance of the BooleanChecker class.
Parameters
-
Optional column: Column
The Column that this BooleanChecker should customize.
-
Optional options: any
An object containing initialization data for the object.
Returns BooleanChecker
-
Properties
ariaLabel
ariaLabel: string
Gets or sets the aria label property of selector.
The default value for this property is ''.
column
showCheckAll
showCheckAll: boolean
Gets or sets a value that determines whether to show a 'Check All' items checkbox on the column header.
The default value for this property is true.
Methods
onColumnChanging
- on
Column Changing(e: CancelEventArgs): boolean
-
Raises the columnChanging event.
Parameters
-
e: CancelEventArgs
CancelEventArgs that contains the event data.
Returns boolean
True if the event was not canceled.
-
onItemChecked
- on
Item Checked(e?: EventArgs): void
-
Raises the itemChecked event.
Parameters
-
Optional e: EventArgs
Returns void
-
Events
columnChanged
Occurs after the value of the column property changes.
columnChanging
columnChanging: Event<Selector, CancelEventArgs>
Occurs before the value of the column property changes.
itemChecked
Occurs when the user checks an item on this column.
Class that adds extra checkboxes to header and group cells of FlexGrid boolean columns to allow setting the values for all items or groups.
** Note **: When you attach a BooleanChecker to a Column, you may also want to set the column's Column.aggregate property to Aggregate.First, so the grid will create cells on group header rows to hold the checkboxes used to set the boolean values for the groups.