Represents a desktop plugin. More...

Inheritance diagram for Ix4Trace.Desktop.Plugins.DesktopPlugin:

Public Member Functions
	DesktopPlugin ()
	Constructor.

virtual void	Initialize (Ix4Trace.Engine.Controller controller, DesktopPluginManager pluginManager)
	Initializes the plugin.

void	SetPluginToIControls ()
	Initializes the controls of plugin.

void	SetPluginToIControls (ControlCollection controlCollection)
	Initializes the controls of plugin.

void	ShowMessage (string message)
	Show message on plugin.

ProgressBar.ProgressBar	ShowProgressBar (string message, int max)
	Shows the progress bar with text.

virtual void	SetParameters (object[] parameters)
	Sets the parameters of the plugin.

virtual void	ExecuteMessages ()
	Executes messages in parameters.

virtual void	OnLoadPlugin ()
	Runs when plugin loads.

virtual void	OnAfterPluginShown ()
	Runs when plugin was shown.

virtual void	OnClosePlugin ()
	Runs when plugin closed. Fires plugin closed event.

virtual void	OnPluginInitialized ()
	Fires plugin initialised event.

virtual void	OnPluginLoaded ()
	Fires plugin loaded event.

virtual void	ClosePlugin ()
	Closes the plugin.

virtual void	HideNavigation ()
	Hides the navigation bar.

virtual void	ShowNavigation ()
	Shows the navigation bar.

void	Invoke (Action method)
	Invoke the method.

virtual void	SetToFront ()
	Sets the controls Z-index to front.

Protected Member Functions
virtual void	SetLanguage ()
	Sets the labguage of plugin.

void	SetLanguage (Control c)
	Sets the language of controls.

virtual void	Initialize ()
	Initializes the plugin.

void	ShowMessagesFromParameters (object[] parameters)
	Shows messages when the parameters conains any messages.

void	CopyControlProperties (Control cOriginal, Control cCopy)
	Copies the properties of the control.

override void	Dispose (bool disposing)
	Clean up any resources being used.

Protected Attributes
FormStyle	formStyle
	Style of from.

FormAdjustment	formAdjustment
	Adjustment of form.

Ix4Trace.Engine.Controller	controller
	The controller.

DesktopPluginManager	pluginManager
	Desktop plugin manager.

string	pluginName = ""
	Name of plugin.

string	pluginText = ""
	Text of plugin.

string	pluginFolder = ""
	Folder of plugin on main control.

string	backPageName = ""
	Previous plugin name.

int	userRight = 0
	Right of user. Plugin will be listed whe the user has the right.

int	autoLoadRight = 0
	Plugin will be automatically loaded when the user has the right.

bool	isVisibleInMenu = true
	Plugin is visible in the menu.

bool	isVisibleInTaskBar = true
	Plugin is visible in the taskbar.

Image	treeViewImage
	Image of plugin in the treeview.

Image	taskBarImage
	Image of plugin in the taskbar.

Image	folderImage
	Image of folder.

int	menuIndex = 0
	Index of the plugin in the treeview.

object[]	parameters
	Current parameters of the plugin. Plugins get parameters when they shown.

Properties
Ix4Trace.GraphicsController.Controls.GraphicsController	GraphicsController `[get, set]`
	The graphics corntroller of plugin.

Ix4Trace.Engine.Controller	Controller `[get]`
	The controller.

string	PluginName `[get]`
	Name of the plugin.

string	PluginFolder `[get]`
	Folder of plugin on main control.

string	BackPageName `[get, set]`
	Previous plugin name.

DesktopPluginManager	PageManager `[get]`
	Desktop plugin manager.

string	PluginText `[get]`
	Text of plugin.

int	UserRight `[get]`
	Right of user. Plugin will be listed whe the user has the right.

bool	IsVisibleInMenu `[get]`
	Plugin is visible in the menu.

bool	IsVisibleInTaskBar `[get]`
	Plugin is visible in the taskbar.

Image	TreeViewImage `[get, set]`
	Image of plugin in the treeview.

Image	TaskBarImage `[get, set]`
	Image of plugin in the taskbar.

Image	FolderImage `[get, set]`
	Image of folder.

int	MenuIndex `[get]`
	Index of the plugin in the treeview.

FormStyle	FormStyle `[get, set]`
	Style of from.

FormAdjustment	FormAdjustment `[get, set]`
	Adjustment of form.

int	AutoLoadRight `[get]`
	Plugin will be automatically loaded when the user has the right.

Events
PluginClosed	PluginClosed = null
	Event of plugin closed.

PluginInitialized	PluginInitialized = null
	Event of plugin initialized.

PluginLoaded	PluginLoaded = null
	Event of plugin loaded.

Private Member Functions
void	DesktopPlugin_MouseDown (object sender, MouseEventArgs e)
	Mouse down of plugin.

void	DesktopPlugin_ExceptionEVT (Exception ex)
	Exception was thrown on the plugin.

void	RunAction (Action method)
	Runs action. Shows exceptions in messagebox.

void	GraphicsController_ShowYesNoDialogEVT (string message, out bool result)
	Event of yes no dialog request of graphics controller.

void	GraphicsController_InvokeMethod (Action action)
	Event of invoke request of graphics controller.

void	GraphicsController_CloseEvent (GraphicsController.Controls.GraphicsController gc)
	Event of close request of graphics controller.

void	InitializeComponent ()
	Required method for Designer support - do not modify the contents of this method with the code editor.

Private Attributes
Ix4Trace.GraphicsController.Controls.GraphicsController	graphicsController
	The graphics controller of plugin.

System.ComponentModel.IContainer	components = null
	Required designer variable.

System.Windows.Forms.ToolTip	toolTip

Detailed Description

Represents a desktop plugin.

Member Function Documentation

◆ CopyControlProperties()

void Ix4Trace.Desktop.Plugins.DesktopPlugin.CopyControlProperties	(	Control	cOriginal,
		Control	cCopy )

protected

Copies the properties of the control.

Parameters

cOriginal	Original control.
cCopy	Copied control.

◆ DesktopPlugin_ExceptionEVT()

void Ix4Trace.Desktop.Plugins.DesktopPlugin.DesktopPlugin_ExceptionEVT ( Exception ex )

private

Exception was thrown on the plugin.

Parameters

ex	Throwed exception.

◆ DesktopPlugin_MouseDown()

void Ix4Trace.Desktop.Plugins.DesktopPlugin.DesktopPlugin_MouseDown	(	object	sender,
		MouseEventArgs	e )

private

Mouse down of plugin.

Parameters

sender	The control.
e	Event arguments.

◆ Dispose()

override void Ix4Trace.Desktop.Plugins.DesktopPlugin.Dispose ( bool disposing )

protected

Clean up any resources being used.

Parameters

disposing true if managed resources should be disposed; otherwise, false.

◆ GraphicsController_CloseEvent()

void Ix4Trace.Desktop.Plugins.DesktopPlugin.GraphicsController_CloseEvent ( GraphicsController.Controls.GraphicsController gc )

private

Event of close request of graphics controller.

Parameters

gc	The graphics controller.

◆ GraphicsController_InvokeMethod()

void Ix4Trace.Desktop.Plugins.DesktopPlugin.GraphicsController_InvokeMethod ( Action action )

private

Event of invoke request of graphics controller.

Parameters

action The action to invoke.

◆ GraphicsController_ShowYesNoDialogEVT()

void Ix4Trace.Desktop.Plugins.DesktopPlugin.GraphicsController_ShowYesNoDialogEVT	(	string	message,
		out bool	result )

private

Event of yes no dialog request of graphics controller.

Parameters

message	Message to show.
result	Result of dialog.

◆ HideNavigation()

virtual void Ix4Trace.Desktop.Plugins.DesktopPlugin.HideNavigation ( )

virtual

Hides the navigation bar.

Reimplemented in Ix4Trace.Desktop.Plugins.ExtendedPlugin.

◆ Initialize()

virtual void Ix4Trace.Desktop.Plugins.DesktopPlugin.Initialize	(	Ix4Trace.Engine.Controller	controller,
		DesktopPluginManager	pluginManager )

virtual

Initializes the plugin.

Parameters

controller	The controller.
pluginManager	The plugin manager.

◆ Invoke()

void Ix4Trace.Desktop.Plugins.DesktopPlugin.Invoke ( Action method )

Invoke the method.

Parameters

method The method to invoke.

◆ OnClosePlugin()

virtual void Ix4Trace.Desktop.Plugins.DesktopPlugin.OnClosePlugin ( )

virtual

Runs when plugin closed. Fires plugin closed event.

Reimplemented in Ix4Trace.Desktop.Plugins.ExtendedPlugin.

◆ RunAction()

void Ix4Trace.Desktop.Plugins.DesktopPlugin.RunAction ( Action method )

private

Runs action. Shows exceptions in messagebox.

Parameters

method Method to run.

◆ SetLanguage()

void Ix4Trace.Desktop.Plugins.DesktopPlugin.SetLanguage ( Control c )

protected

Sets the language of controls.

Parameters

c	The control to set.

◆ SetParameters()

virtual void Ix4Trace.Desktop.Plugins.DesktopPlugin.SetParameters ( object[] parameters )

virtual

Sets the parameters of the plugin.

Parameters

parameters Array of parameters.

◆ SetPluginToIControls()

void Ix4Trace.Desktop.Plugins.DesktopPlugin.SetPluginToIControls ( ControlCollection controlCollection )

Initializes the controls of plugin.

Parameters

controlCollection Collection of controls.

◆ ShowMessage()

void Ix4Trace.Desktop.Plugins.DesktopPlugin.ShowMessage ( string message )

Show message on plugin.

Parameters

message The message.

◆ ShowMessagesFromParameters()

void Ix4Trace.Desktop.Plugins.DesktopPlugin.ShowMessagesFromParameters ( object[] parameters )

protected

Shows messages when the parameters conains any messages.

Parameters

parameters

◆ ShowNavigation()

virtual void Ix4Trace.Desktop.Plugins.DesktopPlugin.ShowNavigation ( )

virtual

Shows the navigation bar.

Reimplemented in Ix4Trace.Desktop.Plugins.ExtendedPlugin.

◆ ShowProgressBar()

ProgressBar.ProgressBar Ix4Trace.Desktop.Plugins.DesktopPlugin.ShowProgressBar	(	string	message,
		int	max )

Shows the progress bar with text.

Parameters

message	Text of message.
max	Maximum steps of progress bar.

Returns: The progressbar.

The documentation for this class was generated from the following files:

Z:/x4t/src/Ix4Trace.Desktop/Ix4Trace.Desktop/Plugins/DesktopPlugin.cs
Z:/x4t/src/Ix4Trace.Desktop/Ix4Trace.Desktop/Plugins/DesktopPlugin.Designer.cs

Public Member Functions

Protected Member Functions

Protected Attributes

Properties

Events

Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ CopyControlProperties()

◆ DesktopPlugin_ExceptionEVT()

◆ DesktopPlugin_MouseDown()

◆ Dispose()

◆ GraphicsController_CloseEvent()

◆ GraphicsController_InvokeMethod()

◆ GraphicsController_ShowYesNoDialogEVT()

◆ HideNavigation()

◆ Initialize()

◆ Invoke()

◆ OnClosePlugin()

◆ RunAction()

◆ SetLanguage()

◆ SetParameters()

◆ SetPluginToIControls()

◆ ShowMessage()

◆ ShowMessagesFromParameters()

◆ ShowNavigation()

◆ ShowProgressBar()