JVCL Help:TJvPlugIn.SendPluginMessage

 JVCL Help: TJvPlugIn.SendPluginMessage Method

TJvPlugIn

► TJvPlugIn Events

[+] TJvPlugIn Events

► TJvPlugIn Methods

[+] TJvPlugIn Methods

► TJvPlugIn Properties

[+] TJvPlugIn Properties

JEDI Visual Component Library Help

• Packages
• Files
  • Classes
  • Interfaces
  • Functions
  • Variables
  • Constants
  • Types
  • Records
• Project summary
• License

Search in JVCL Help

 

Search in all projects

 

Summary

Sends a message to this plugin.

Pascal

 procedureSendPluginMessage(APluginMessage: Longint; AMessageText: string);

Parameters

Parameters	Description
APluginMessage: Longint	ID of the message. See the host application's documentation of available messages.
AMessageText: string	Additional parameters for the message. See the host application's documentation for the meaning of this string for the message.

Description

SendPluginMessage is called by the host application to send a message to the plugin.
As a plugin developer you should respond to the OnPluginMessage, rather than overriding this method. The meaning of the various message IDs are specified by the host application (check its documentation to see which message you could receive and what the meaning of the second parameter is).
As a host application developer you can either call this method for a specific plugin or you could broadcast the message to all loaded plugins. You are responsible of defining and documenting the meaning of the various message IDs you support.

See Also

TJvPlugIn.OnPluginMessage

About

Contribute to this help topic

This documentation wiki is based on the collaborative effort of Project JEDI users. Your edits are welcome in order to improve documentation quality: edit this page

The JEDI Visual Component Library source is hosted at : link to view the current source code, link to the subversion repository