Consultingwerk.Windows.Framework.Repository.Plugins.SmartRepositorySupportPlugin

Namespace:

Consultingwerk.Windows.Framework.Repository.Plugins

Class

SmartRepositorySupportPlugin

Parent classes:

Progress.Lang.Object

Consultingwerk.Windows.Framework.Repository.Plugins.SmartRepositorySupportPlugin

Inherits:

Progress.Lang.Object

Implements:

Consultingwerk.BusinessEntityDesigner.IBusinessEntityDesignerPlugin, Consultingwerk.SmartFramework.IOverwritePromptCallback

File:	SmartRepositorySupportPlugin
Purpose:	Business Entity Designer Plugin that with various wizards
	supporting the SmartFramework repository
Description:	Provides functionality to
	- Import fields as data fields
Author(s):	Mike Fechner / Consultingwerk Ltd.
Created:	Sat Dec 10 08:27:49 CEST 2017

Top Method Summary

Options	Name	Purpose
#	Authenticate ()	Performs SmartFramework Authentication
#	CreateDataFields ()	Wizard to create Data Fields
#	CreateDataSource ()	Invokes the wizard to create a Data Source for the table
#	CreateLookup ()	Invokes the wizard to create a Lookup for the table
#	CreateMetaForm ()	Invokes the wizard to create a Form for the table
#	CreateMetaGrid ()	Invokes the wizard to create a Data Grid for the table
#	CreateMetaViewer ()	Invokes the wizard to create a Data Viewer for the table
+	CHARACTER GetSettings (character)	Gets a setting in the registry
+	LOGICAL PromptForOverwrite (character)	Prompts the user if a resource should be overwritten
+	Shutdown ()	Shuts down the plugin
+	Startup (dataset, BusinessEntityDatasetController, BusinessEntityDesignerForm, UltraToolbarsManager)	Initializes the plugin
+	StoreSetting (character, character)	Stores a setting in the registry
#	ToolClickHandler (Object, ToolClickEventArgs)	Handles the ToolClick event of the Business Entity Designer's UltraToolbarsManager

Top Constructor Summary

	Options	Name	Purpose
	+	SmartRepositorySupportPlugin ()	Constructor for the SmartDataObjectImporterPlugin class

Top Property Summary

	Options	Name	Purpose
	+	Consultingwerk.BusinessEntityDesigner.Services.BusinessEntityDatasetController Controller
	+	Consultingwerk.BusinessEntityDesigner.UI.BusinessEntityDesignerForm Form

Method Detail

Top

PROTECTED Authenticate ()

Purpose:	Performs SmartFramework Authentication
Notes:

Top

PROTECTED CreateDataFields ()

Purpose:	Wizard to create Data Fields
Notes:

Top

PROTECTED CreateDataSource ()

Purpose:	Invokes the wizard to create a Data Source for the table
Notes:

Top

PROTECTED CreateLookup ()

Purpose:	Invokes the wizard to create a Lookup for the table
Notes:

Top

PROTECTED CreateMetaForm ()

Purpose:	Invokes the wizard to create a Form for the table
Notes:

Top

PROTECTED CreateMetaGrid ()

Purpose:	Invokes the wizard to create a Data Grid for the table
Notes:

Top

PROTECTED CreateMetaViewer ()

Purpose:	Invokes the wizard to create a Data Viewer for the table
Notes:

Top

PUBLIC CHARACTER GetSettings (character)

Purpose:	Gets a setting in the registry
Notes:

Parameters:
pcSettingsKey	CHARACTER
	The settings key
Returns	CHARACTER
	The settings value

Top

PUBLIC LOGICAL PromptForOverwrite (character)

Purpose:	Prompts the user if a resource should be overwritten
Notes:

Parameters:
pcObjectName	CHARACTER
	The name of the resources that
Returns	LOGICAL
	Logical value indicating if an existing object should be overwritten

Top

PUBLIC Shutdown ()

Purpose:	Shuts down the plugin
Notes:

Top

PUBLIC Startup (dataset, BusinessEntityDatasetController, BusinessEntityDesignerForm, UltraToolbarsManager)

Purpose:	Initializes the plugin
Notes:

Parameters:
dsBusinessEntity	DATASET dsBusinessEntity
	Business Entity with the Design dataset, called with the BIND keyword
poController	Consultingwerk.BusinessEntityDesigner.Services.BusinessEntityDatasetController
	The BusinessEntityDatasetController
poForm	Consultingwerk.BusinessEntityDesigner.UI.BusinessEntityDesignerForm
	The main Form of the BusinessEntityDesigner
poToolbar	Infragistics.Win.UltraWinToolbars.UltraToolbarsManager
	The reference to the UltraToolbarsManager used by the BusinessEntityDesigner

Top

PUBLIC StoreSetting (character, character)

Purpose:	Stores a setting in the registry
Notes:

Parameters:
pcSettingsKey	CHARACTER
	The settings key
pcSetting	CHARACTER
	The settings value

Top

PROTECTED ToolClickHandler (Object, ToolClickEventArgs)

Purpose:	Handles the ToolClick event of the Business Entity Designer's
	UltraToolbarsManager
Notes:

Parameters:
sender	System.Object
	The reference to the object that raised the event
e	Infragistics.Win.UltraWinToolbars.ToolClickEventArgs
	The ToolClickEventArgs with the data for this event