Echelon LNS Plug-in User Manual

Page 25

Advertising
background image

Field Description

Prelaunch

Indicates to a director whether the director may launch the
plug-in in the background before the plug-in is needed.
Supporting this property can improve the perceived startup
performance of your plug-in, as the plug-in can open the
specified network and perform any required initialization before
receiving the information from the director when the director
decides to invoke a command that the plug-in supports. The
plug-in should remain running in the background until a
command to that plug-in is sent, at which point the plug-in
should become visible (when the director sets the Visible
property to True) and behave normally.

The Prelaunch field can be set to Feature.Supported (1), which
indicates that Prelaunch functionality is supported.

The Prelaunch field can also be set to Feature.Disabled (0),
which indicates that this feature is disabled at the present time
although the plug-in does include pre-launch support.

The Prelaunch field can also be set to Feature.Unsupported (–
1), which indicates that this feature is unsupported by the plug-in.

Optional (defaults to Feature.Unsupported)

PluginFactoryType

For advanced use only.

Optional

6. Add a PluginCommands public (instance) property that returns a reference to an array of

PluginCommand objects that describes your plug-in’s commands. For efficiency, you should
return a reference to a previously created read-only object (for example, using a statically
initialized field) instead of creating a new instance each time. The following table lists the fields
of the PluginCommand class (see How Plug-ins Implement the Registration Command, in
Chapter 3, for usage considerations):

Field Description

Name

Name of the plug-in command displayed by directors. For
example, this may be “Configure” or “Browse”.

Description

Description of the plug-in command, which may be displayed
by directors (for example, as a tooltip).

CommandId An

EnumCommandIds or ConstCommandIds value

identifying the command. See How Plug-ins are Installed and
Made Visible to LNS
in Chapter 3 for more information.

ComponentClassId An

EnumClassIds or ConstClassIds value identifying the

LNS objects to which this command can be applied. See How
Directors Launch And Manipulate Plug-ins
in
Chapter 3 for
more information.

DefaultAppFlag

Whether this command should be the default command for this
type of LNS object.

Advertising