T_Aml_Editor_Plugin_Contracts_IAMLEditorView

IAMLEditorView Interface

AutomationML Editor

The Interface IAMLEditorView is used for a PlugIn, which can be embedded in the AutomationML Editor's Window- and Docking-Manager. The PlugIn must implement the IFrameworkInputElement Interface (as an example, a WPF UserControl) and the IAMLEditorPlugin Interface. For windows, based on System.Windows.Forms , the view must have a WindowsFormsHost wrapper.

Namespace: Aml.Editor.Plugin.Contracts
Assembly: AML.Editor.PluginContracts (in AML.Editor.PluginContracts.dll) Version: 2.1

Syntax

C#

public interface IAMLEditorView : IFrameworkInputElement, 
	IInputElement, IAMLEditorPlugin

VB

Public Interface IAMLEditorView
	Inherits IFrameworkInputElement, IInputElement, IAMLEditorPlugin

C++

public interface class IAMLEditorView : IFrameworkInputElement, 
	IInputElement, IAMLEditorPlugin

The IAMLEditorView type exposes the following members.

Properties

 

	Name	Description
	ActivatePlugin	Gets the Activation command for the PlugIn. (Inherited from IAMLEditorPlugin.)
	CanClose	Gets a value indicating whether this PlugIn Instance can close. If set to true, the PlugIn may be closed from the AutomationML Docking Manger Window Menu or the Windows Close Button.
	Commands	Gets the List of commands, which are bound to the PlugIn Menu in the AutomationML Editor. The Command Names are shown in a sub-Menu in the PlugIn-Menu. (Inherited from IAMLEditorPlugin.)
	DisplayName	Gets the display name which is shown in the PlugIn Menu in the AutomationML Editor. (Inherited from IAMLEditorPlugin.)
	InitialDockPosition	Gets the initial dock position for the PlugIn window
	IsActive	Gets a value indicating whether this instance is active. (Inherited from IAMLEditorPlugin.)
	IsAutoActive	Gets or sets a value indicating whether this instance is automatic active when loaded. This value can be initially set and will be defined by the user. (Inherited from IAMLEditorPlugin.)
	IsReactive	Gets a value indicating whether this instance is reactive. Reactive PlugIn will be notified, when the actual CAEX-Object changes (Selection of any Tree view Item in an AutomationML TreeView) via the ChangeSelectedObject(CAEXBasicObject) Method or an AutomationML File is opened via the ChangeAMLFilePath(String) Method. (Inherited from IAMLEditorPlugin.)
	IsReadonly	Gets a value indicating whether this instance is read only. A Read only PlugIn should not change any CAEX Objects. (Inherited from IAMLEditorPlugin.)
	PackageName	Gets the package name which is used to download the PlugIn package from a NuGet feed. If a Package name is defined, the AMLEditor can update PlugIn packages independently from its own update cycle. (Inherited from IAMLEditorPlugin.)
	PaneImage	Gets the image which should be used in the Header of the PlugIn window. If no image is defined the editor uses a default image.
	TerminatePlugin	Gets the Terminate command for the PlugIn. (Inherited from IAMLEditorPlugin.)

  Back to Top

Methods

 

	Name	Description
	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. (Inherited from IAMLEditorPlugin.)
	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. (Inherited from IAMLEditorPlugin.)
	ExecuteCommand	This Method enables the AutomationML Editor to execute a command. Only those commands are executable, which are identifiable via the PluginCommandsEnum. (Inherited from IAMLEditorPlugin.)
	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. (Inherited from IAMLEditorPlugin.)

  Back to Top

Events

 

	Name	Description
	PluginActivated	The Event occurs when the PlugIn is Activated (for example via an Activation Command). This event is raised by the PlugIn and handled by the AutomationML Editor. If the PlugIn has a UI-Control, the AutomationML Editor will show the UI and dock the Control in a Container Window, used for external Views. (Inherited from IAMLEditorPlugin.)
	PluginTerminated	Occurs when the PlugIn is terminated (some UserInteraction inside the PlugIn, i. e. a Window is Closed, or via a Command). This event is raised by the PlugIn and handled by the AutomationML Editor. If the PlugIn is a UI-Control IAMLEditorView, the control is removed from the Container Window. The State of the currently open AutomationML Document is checked, and if it was modified, the User will be asked to reload it. (Inherited from IAMLEditorPlugin.)

  Back to Top

Examples

[ExportMetadata("Author", "...")]
[ExportMetadata("DisplayName", "HelloAml")]
[ExportMetadata("Description", "The 'HelloAml' is an AutomationML Editor plugin, which ....")]
[Export(typeof(IAMLEditorView))]
 public partial class HelloAml : System.Windows.Control.UserControl, IAMLEditorView
{
}

See Also

Reference

Aml.Editor.Plugin.Contracts Namespace