IObjectSpace.CustomRefresh Event

Replace the default processes of refreshing persistent objects with a custom one.

Namespace: DevExpress.ExpressApp

Assembly: DevExpress.ExpressApp.v18.2.dll

Declaration

event EventHandler<HandledEventArgs> CustomRefresh
Event CustomRefresh As EventHandler(Of HandledEventArgs)

The CustomRefresh event handler receives an argument of the HandledEventArgs type. The following properties provide information specific to this event.

Property Description
Handled Gets or sets a value that indicates whether the event handler has completely handled the event or whether the system should continue its own processing.

The CustomRefresh event is raised as a result of calling the IObjectSpace.Refresh method. Handle this event to provide a custom process for refreshing the current Object Space's persistent objects. Set the handler's CompletedEventArgs.Handled parameter to true to indicate that the refresh operation has been already performed. Set the handler's CompletedEventArgs.IsCompleted parameter to true in the case of a successful refresh; otherwise, set false. This value will be returned by the IObjectSpace.Refresh method.

If you implement the IObjectSpace interface in the BaseObjectSpace class' descendant, you should override the BaseObjectSpace.Reload method which is called by the BaseObjectSpace.Refresh method. In this instance, you won't have to raise the CustomRefresh event, since it is raised by the BaseObjectSpace.Refresh method.

See Also