Skip to content

Methods_T_Aml_Editor_Plugin_Base_PluginBase

AutomationML edited this page Jun 24, 2019 · 1 revision

PluginBase Methods

AutomationML Editor

The PluginBase type exposes the following members.

Methods

 

Name Description
Protected method ActivateCommandCanExecute Test, if the ActivatePlugin can execute.
Protected method ActivateCommandExecute The ActivatePlugin Execution Action. The IsActive Property is set to true and the PluginActivated Event is raised.
Public method ChangeAMLFilePath Changes the current amlFilePath. The Host Application will call this method when the PlugIns IsReactive Property is set to true and the Currently opened AutomationML File changes in the AMLEditor Host Application.
Public method ChangeSelectedObject Changes the selected object. The Host Application will call this method when the PlugIns IsReactive Property is set to true and the Current Selection changes in the AMLEditor Host Application.
Public methodCode example ExecuteCommand This Method enables the AutomationML Editor to execute a command. Only those commands are executable, which are identifiable via the PluginCommandsEnum.
Public methodCode example PublishAutomationMLFileAndObject PublishAutomationMLFileAndObject after the PlugIn is activated. This Method is called by the AutomationML Editor when the PluginActivated Event is handled. The AutomationML Editor will send the actual Path of the AutomationML File and the actual selected Object to the PlugIn, when an AutomationML File is currently open. If the Activation happened, when no AutomationML File was opened so far, the PlugIn will be informed as soon as this will happen, but only if the IsReactive Flag is set to true.
Protected method RaisePluginActivated Raises the PlugIn activated.
Protected method RaisePluginTerminated Raises the PlugIn terminated.
Protected method TerminateCommandCanExecute Test, if the TerminatePlugin can execute.
Protected method TerminateCommandExecute The TerminatePlugin Execution Action. The IsActive Property is set to false and the PluginTerminated Event is raised.
  Back to Top

See Also

Reference

PluginBase Class
Aml.Editor.Plugin.Base Namespace

Clone this wiki locally