INotificationHandler interface

The INotificationHandler interface handles notifications broadcasted in the Altium Designer system. The notifications could be a document loading notification, workspace being loaded, an object being navigated, and a server module being loaded.

public interface INotificationHandler

Namespace: DXP · Assembly: Altium.SDK.Interfaces

Remarks

Notifications as event messages can be broadcasted by the Client system, and any open server documents can receive them and act on them accordingly. The Broadcast Notification is a system wide notification, and the Dispatch Notification is a server specific notification.

To register a Notification handler in the server project (either in a server module object, panel view object or document view object)

1. When a object is created, the IClient.RegisterNotificationHandler method is invoked.

2. When a object is destroyed, the IClient.UnregisterNotificationHandler method is invoked.

3. To handle custom notifications, a object has a HandlerNotification method which checks if the custom notification code is intercepted then a call can be made to update for example the Panel's preferences controls.

The INotificationHandler is inherited in the TServerModule, TServerDocumentForm and TServerPanelForm classes and thus custom notifications can be registered and handled.

Methods

Method	Returns	Description
HandleNotification	void

HandleNotification

No description yet.

void HandleNotification(INotification argNotification);
void HandleNotification(object argNotification);

Parameter	Type	Passing
argNotification	INotification	value

Returns: nothing (void)

The first overload is an extension method of INotificationHandlerHelper (using DXP;) with typed parameters; the second is declared by the interface.

See also: IClient

Accepted by

IClient.RegisterFilteredNotificationHandler, IClient.RegisterNotificationHandler, IClient.RegisterServerNotificationHandler, IClient.UnregisterNotificationHandler, IClient.UnregisterServerNotificationHandler