Skip to main content

Global Event: OnSetUserPreferences

  • Updated

Global Event: OnSetUserPreferences

The OnSetUserPreferences Event is used to store user preferences when setting startup reports, saving interactive Report Viewer modifications as user reports or color chooser user colors. The event will only be called if the Admin Console > General > User Settings > User Preference Storage Method is set to Server Events.

Signature

For custom code the args array is structured as follows:

args[] contains two objects:

  1. a string with the user preference’s id
  2. a string with the user preference’s value

For .NET Assemblies the method signature is as follows:

void EventHandlerName(SessionInfo sessionInfo, string id, string value)

Expected Return

The event has no return value.

Additional Resources