Options
All
  • Public
  • Public/Protected
  • All
Menu

The Adaptable Blotter publishes 5 events that users can subscribe to as required.

Each event contains the Adaptable Blotter and an EventArgs object that contains relevant information for the event.

The way to subscribe to the events is as follows:

adaptableblotter.api.eventApi
   .onActionColumnClicked()
   .Subscribe((sender, actionColumnEventArgs) =>
       onActionColumnClicked(actionColumnEventArgs)
 );

Hierarchy

  • IEventApi

Implemented by

Index

Properties

_onActionColumnClicked

_onActionColumnClicked: EventDispatcher<IAdaptableBlotter, ActionColumnClickedEventArgs>

_onAlertFired

_onAlertFired: EventDispatcher<IAdaptableBlotter, AlertFiredEventArgs>

_onColumnStateChanged

_onColumnStateChanged: EventDispatcher<IAdaptableBlotter, ColumnStateChangedEventArgs>

_onSearchChanged

_onSearchChanged: EventDispatcher<IAdaptableBlotter, SearchChangedEventArgs>

_onSelectionChanged

_onSelectionChanged: EventDispatcher<IAdaptableBlotter, SelectionChangedEventArgs>

_onThemeChanged

_onThemeChanged: EventDispatcher<IAdaptableBlotter, ThemeChangedEventArgs>

Methods

onActionColumnClicked

  • Event fired whenever the Button in an Action Column is clicked.

    The EventArgs contain the column that has been clicked and the rowData for that row.

    Returns IEvent<IAdaptableBlotter, ActionColumnClickedEventArgs>

    IEvent<IAdaptableBlotter, ActionColumnClickedEventArgs>

onAlertFired

  • Event fired whenever an Alert is raised.

    Contains the full Alert itself.

    Returns IEvent<IAdaptableBlotter, AlertFiredEventArgs>

    IEvent<IAdaptableBlotter, IAlertFiredEventArgs>

onColumnStateChanged

  • Event fired whenever column order, visibility and sorts are changed in the Blotter.

    The event only fires when in a user (as opposed to the default) layout.

    Returns IEvent<IAdaptableBlotter, ColumnStateChangedEventArgs>

    Column State Changed args - which at present just return the name of the current layout.

onSearchChanged

  • Event fired whenever search criteria in the Blotter changes, providing full coverage of what triggered the change and the current Search and Filter state.

    Used in association with server searching.

    Returns IEvent<IAdaptableBlotter, SearchChangedEventArgs>

    IEvent<IAdaptableBlotter, SearchChangedEventArgs>

onSelectionChanged

  • Event fired whenever the Selection in the Adaptable Blotter changes.

    The EventArgs contain both cell and row selection information.

    Returns IEvent<IAdaptableBlotter, SelectionChangedEventArgs>

    IEvent<IAdaptableBlotter, SelectionChangedEventArgs>

onThemeChanged

  • Event fired whenever the theme of the Blotter has been changed

    Returns IEvent<IAdaptableBlotter, ThemeChangedEventArgs>

    IEvent<IAdaptableBlotter, ThemeChangedEventArgs>

Generated using TypeDoc