RelaxISPlugin_DataManipulation Class

This class is kept for backwards compatibility. Please use RelaxISPlugin_DataManipulation2 for new developments.

This plugin type allows the direct manipulation of every aspect of the spectrum, including the data values, the fit parameters, metadata and so on. The plugin is accessed using a ribbon button that can be registered. You can add setup routines for the change in the PerformSetup(IEnumerableImpedanceSpectrum_Fitted, Boolean) method, which is called once for each button click.

Inheritance Hierarchy

SystemObject
  RelaxIS_SDK.PluginsRelaxISPlugin
    RelaxIS_SDK.PluginsRelaxISOnlyPlugin
      RelaxIS_SDK.PluginsRelaxISPlugin_DataManipulation

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

Syntax

Copy

[ObsoleteAttribute("This class is kept for backwards compatibility. Please use RelaxISPlugin_DataManipulation2 for new developments.")]
public abstract class RelaxISPlugin_DataManipulation : RelaxISOnlyPlugin

<ObsoleteAttribute("This class is kept for backwards compatibility. Please use RelaxISPlugin_DataManipulation2 for new developments.")>
Public MustInherit Class RelaxISPlugin_DataManipulation
	Inherits RelaxISOnlyPlugin

Dim instance As RelaxISPlugin_DataManipulation

The RelaxISPlugin_DataManipulation type exposes the following members.

Constructors

	Name	Description
	RelaxISPlugin_DataManipulation	Initializes a new instance of the RelaxISPlugin_DataManipulation class

Top

Properties

	Name	Description
	ActivateNewSpectra	Gets a value indicating whether newly added spectra should be activated after the plugin was executed.
	AlwaysUseSelectedSpectra	If false, the spectra selection dialog will be shown when the plugin is called, if true, the selection dialog will be skipped and the currently selected spectra will be used.
	ButtonImage	The image that will be displayed on the ribbon button. If the value is null, a default image will be displayed.
	ButtonTitle	The title that is displayed on the ribbon button. If null, the plugin's title will be used.
	Description	A short description of what the plugin does. Displayed on various occasions for clarification (Inherited from RelaxISPlugin)
	DoesChangeData	If this property returns false, the "Fit up-to-date" status of the selected spectra is not set to false, because it is indicated that no data of the spectrum is changed
	Name	The plugins's internal name, that is used to reference it on various occasions (Inherited from RelaxISPlugin)
	NewSpectra	Gets a list of new spectra that will be added after the data manipulation plugin was completely executed.
	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. (Inherited from RelaxISOnlyPlugin)
	RelaxISWCFInterface	Gets an instance of the WCF interface for the RelaxIS instance that the plugin is loaded in. (Inherited from RelaxISOnlyPlugin)
	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)

Top

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. (Inherited from RelaxISOnlyPlugin)
	InternalSetWCFInstance	Set the internal wcf instance to a new value. (Inherited from RelaxISOnlyPlugin)
	ManipulateSpectra	Calls the ManipulateSpectrum(Int32, ImpedanceSpectrum_Fitted) method for each spectrum.
	ManipulateSpectrum	This method is called for each selected spectrum. You can change the contents of the Spectrum object to your liking.
	PerformSetup	This method is called once before the the manipulation of the spectra is started. Use this method to perform initializations or for user interaction.
	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)

Top

Remarks

Caution: Using this plugin will loose the per-datapoint active indication of spectra! It is recommended to use the RelaxISPlugin_DataManipulation2 plugin instead.

Reference

RelaxIS_SDK.Plugins Namespace

Other Resources

Data Manipulation Example

Data Manipulation 2 Example

RelaxISPlugin General Example

RelaxISOnlyPlugin General Example