To Load a Widget Synchronously or Asynchronously

To load a widget synchronously along with the page, override the AsyncLoading() method, as the following code shows.

using PX.Web.UI;
using PX.Dashboards.Widgets;

public override AsyncLoadMode AsyncLoading
{
    get { return AsyncLoadMode.False; }
}

To load a widget asynchronously after the page has been loaded, you do not need to perform any actions, because the following implementation of the AsyncLoading() method is used by default.

using PX.Web.UI;
using PX.Dashboards.Widgets;

public override AsyncLoadMode AsyncLoading
{
    get { return AsyncLoadMode.True; }
}

If a widget performs a long-running operation during loading, such as reading data that takes a long time, use the following approach to load this widget:

1. Override the AsyncLoading() method, as the following code shows. In this case, for processing the data of the widget, the system starts the long-running operation in a separate thread.

   using PX.Web.UI;
   using PX.Dashboards.Widgets;
   
   public override AsyncLoadMode AsyncLoading
   {
       get { return AsyncLoadMode.LongRun; }
   }

2. Override the ProcessData() method of the widget class so that it implements all the logic for the widget that consumes significant time while loading.
3. Override the SetProcessResult() method of the widget class so that it retrieves the result of the processing of the widget data.