API Docs for:
Show:

flexiciousNmsp.PreferencePersistenceEvent Class

Extends BaseEvent

Dispatched when the grids' preferencePersistenceMode='server' and: 1) The Grid needs to retrieve the preference data from the server 2) The Grid needs to persist the preference data to the server 3) The Grid needs to clear out its preference data.

Constructor

flexiciousNmsp.PreferencePersistenceEvent

(
  • type
  • preferenceKey
  • preferenceXml
  • [bubbles]
  • [cancelable]
)

Parameters:

  • type Object
  • preferenceKey Object
  • preferenceXml Object
  • [bubbles] Object optional
  • [cancelable] Object optional

Properties

customData

String

If you want to save any custom data into the preferences string, populate this property in the savePreferences event. (This event will be dispatched JUST before saving the preferences. And it will be available to you in the loadPreferences event. (This event is called right after the preferences are applied to the IPersistable)

Default: null

isDefault

Boolean

Whether the preference to add is the default. Added in 2.9 to support multiple preferences

Default: null

preferenceKey

String

A key that uniquely identifies the grid whose preference data needs to be persisted on the server

Default: null

preferenceName

String

Name of the preference to persist. Added in 2.9 to support multiple preferences

Default: null

preferenceXml

String

An xml string that contains all the preference data for this grid.

Default: null