Click or drag to resize

RelaxISPlugin_Generic Class

The generic plugin type does not contain any inherent functionality. It is intended for the plugin to use the RelaxISProgramInterface and RelaxISWCFInterface properties to implement functionality. Use the AfterStartupInitialization function to register e.g. ribbon buttons to allow the user to call plugin functionality.
Inheritance Hierarchy
SystemObject
  RelaxIS_SDK.PluginsRelaxISPlugin
    RelaxIS_SDK.PluginsRelaxISOnlyPlugin
      RelaxIS_SDK.PluginsRelaxISPlugin_Generic

Namespace: RelaxIS_SDK.Plugins
Assembly: RelaxIS SDK (in RelaxIS SDK.dll) Version: 3.0.23.63
Syntax
Copy
public abstract class RelaxISPlugin_Generic : RelaxISOnlyPlugin

The RelaxISPlugin_Generic type exposes the following members.

Constructors
 NameDescription
Protected methodRelaxISPlugin_GenericInitializes a new instance of the RelaxISPlugin_Generic class
Top
Properties
 NameDescription
Public propertyDescription A short description of what the plugin does. Displayed on various occasions for clarification
(Inherited from RelaxISPlugin)
Public propertyName The plugins's internal name, that is used to reference it on various occasions
(Inherited from RelaxISPlugin)
Public propertyPluginSourcePath Gets or sets the full path of the file that the plugin was loaded from.
(Inherited from RelaxISPlugin)
Protected propertyRelaxISProgramInterface Gets an instance of the RelaxIS Program interface for the RelaxIS instance that the plugin is loaded in.
(Inherited from RelaxISOnlyPlugin)
Protected propertyRelaxISWCFInterface Gets an instance of the WCF interface for the RelaxIS instance that the plugin is loaded in.
(Inherited from RelaxISOnlyPlugin)
Public propertySortIndex By default the plugins are sorted based on the value of this property. That means, that they appear in lists in the order dictated by this value.
(Inherited from RelaxISPlugin)
Public propertyUserDataDirectory Gets or sets the path to the RelaxIS user data directory.
(Inherited from RelaxISPlugin)
Top
Methods
 NameDescription
Protected methodAddLogMessage(Exception) Advises RelaxIS to add information about the given exception to the log. Will not work in the object's constructor.
(Inherited from RelaxISPlugin)
Protected methodAddLogMessage(String) Advises RelaxIS to add a new message to the log. Will not work in the object's constructor.
(Inherited from RelaxISPlugin)
Public methodAfterStartupInitialization Is called once after the plugin is initialized with all internal information during program start.
(Inherited from RelaxISPlugin)
Public methodCompareTo Compares the plugin to another based on the SortIndex property
(Inherited from RelaxISPlugin)
Public methodGetAdditionalInformation Provides additional information about this plugin, like e.g. the unit of a transfer function.
(Inherited from RelaxISPlugin)
Public methodInternalSetProgramInstance Set the internal program instance to a new value.
(Inherited from RelaxISOnlyPlugin)
Public methodInternalSetWCFInstance Set the internal wcf instance to a new value.
(Inherited from RelaxISOnlyPlugin)
Public methodShouldDiscardPlugin Called once after the plugin is initialized and after AfterStartupInitialization and signals to RelaxIS if the plugin should be used or discarded.
(Inherited from RelaxISPlugin)
Top
See Also