RelaxISOnlyPlugin Class

Defines a plugin that is only used in RelaxIS and can therefore use some additional functionality via a WCF interface.

Inheritance Hierarchy

SystemObject
  RelaxIS_SDK.PluginsRelaxISPlugin
    RelaxIS_SDK.PluginsRelaxISOnlyPlugin
      More

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

Syntax

public abstract class RelaxISOnlyPlugin : RelaxISPlugin

Public MustInherit Class RelaxISOnlyPlugin
	Inherits RelaxISPlugin

Dim instance As RelaxISOnlyPlugin

The RelaxISOnlyPlugin type exposes the following members.

Constructors

	Name	Description
	RelaxISOnlyPlugin	Initializes a new instance of the RelaxISOnlyPlugin class

Properties

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

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. (Inherited from RelaxISPlugin)
	AddLogMessage(String)	Advises RelaxIS to add a new message to the log. Will not work in the object's constructor. (Inherited from RelaxISPlugin)
	AfterStartupInitialization	Is called once after the plugin is initialized with all internal information during program start. (Inherited from RelaxISPlugin)
	CompareTo	Compares the plugin to another based on the SortIndex property (Inherited from RelaxISPlugin)
	GetAdditionalInformation	Provides additional information about this plugin, like e.g. the unit of a transfer function. (Inherited from RelaxISPlugin)
	InternalSetProgramInstance	Set the internal program instance to a new value.
	InternalSetWCFInstance	Set the internal wcf instance to a new value.
	ShouldDiscardPlugin	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)

Inheritance Hierarchy