RelaxISPlugin Class

This is the base type for all plugin types. The individual types of plugins inherit from this class.

Inheritance Hierarchy

SystemObject
RelaxIS_SDK.PluginsRelaxISPlugin
More

Namespace: RelaxIS_SDK.Plugins
Assembly: RelaxIS SDK (in RelaxIS SDK.dll) Version: 3.0.23.63

Syntax

public abstract class RelaxISPlugin : IComparable<RelaxISPlugin>, 
	ITool, IOrdered

Public MustInherit Class RelaxISPlugin
	Implements IComparable(Of RelaxISPlugin), ITool, 
	IOrdered

Dim instance As RelaxISPlugin

The RelaxISPlugin type exposes the following members.

Constructors

	Name	Description
	RelaxISPlugin	Initializes a new RelaxISPlugin object

Properties

	Name	Description
	Description	A short description of what the plugin does. Displayed on various occasions for clarification
	Name	The plugins's internal name, that is used to reference it on various occasions
	PluginSourcePath	Gets or sets the full path of the file that the plugin was loaded from.
	SortIndex	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.
	UserDataDirectory	Gets or sets the path to the RelaxIS user data directory.

Methods

	Name	Description
	AddLogMessage(Exception)	Advises RelaxIS to add information about the given exception to the log. Will not work in the object's constructor.
	AddLogMessage(String)	Advises RelaxIS to add a new message to the log. Will not work in the object's constructor.
	AfterStartupInitialization	Is called once after the plugin is initialized with all internal information during program start.
	CompareTo	Compares the plugin to another based on the SortIndex property
	GetAdditionalInformation	Provides additional information about this plugin, like e.g. the unit of a transfer function.
	ShouldDiscardPlugin	Called once after the plugin is initialized and after AfterStartupInitialization and signals to RelaxIS if the plugin should be used or discarded.

Inheritance Hierarchy