Consultingwerk.BusinessEntityDesigner.Plugins.TableAndFieldStaticClassGeneratorPlugin

Namespace:

Class

TableAndFieldStaticClassGeneratorPlugin

Parent classes:

Progress.Lang.Object

Consultingwerk.BusinessEntityDesigner.Plugins.TableAndFieldStaticClassGeneratorPlugin

Inherits:

Progress.Lang.Object

Implements:

Consultingwerk.BusinessEntityDesigner.IBusinessEntityDesignerPlugin

File:	TableAndFieldStaticClassGeneratorPlugin
Purpose:	Business Entity Designer Plugin that supports the
	generation of static classes with Constants for ProDataset
	Buffer and Field Names
Description:	Creates a class named like the temp-table buffer
	(excluding the e prefix) but a configurable pre- and
	suffix for the class name
Author(s):	Mike Fechner / Consultingwerk Ltd.
Created:	Mon May 16 09:07:21 CEST 2021
Notes:	Generates the classes whenever the Business Entity is
	generated of regenerated.

Top Method Summary

	Options	Name	Purpose
		AfterGenerateSourceHandler (Object, EventArgs)	Event handler for the AfterGenerateSource event of the BusinessEntityDatasetController
		CHARACTER FindOutputFolder ()	Returns the output folder (source code folder for business logic)
		GenerateFieldNamesStaticClass ()	Generates the Model Classes
		GenerateFieldNamesStaticClass (dataset)	Generates the Constants include file
		Shutdown ()	Method called when the Business Entity Designer will get closed
		Startup (dataset, BusinessEntityDatasetController, BusinessEntityDesignerForm, UltraToolbarsManager)	Method called when the Business Entity Designer is starting and has loaded the plugin.

Top Property Summary

	Options	Name	Purpose
		CHARACTER ClassNamePrefix
		CHARACTER ClassNameSuffix

Method Detail

Top

Purpose:	Event handler for the AfterGenerateSource event of the
	BusinessEntityDatasetController
Notes:

Parameters:
sender	Progress.Lang.Object
	The reference to the object that raised the event
e	Consultingwerk.EventArgs
	The Consultingwerk.EventArgs with the data for this event

Top

Purpose:	Returns the output folder (source code folder for business logic)
Notes:

Returns	CHARACTER
	The output folder

Top

Purpose:	Generates the Model Classes
Notes:

Top

Purpose:	Generates the Constants include file
Notes:	This routine is intended to be used from outside of the Business Entity
	designer (automatic source code generation, unit testing)

Parameters:
dsBusinessEntity	DATASET dsBusinessEntity
	Business Entity with the Design dataset, called with the BY-REFERENCE keyword

Top

Purpose:	Method called when the Business Entity Designer will get closed
Notes:

Top

Purpose:	Method called when the Business Entity Designer is starting and
	has loaded the plugin.
Notes:	Passes references to some key components of the Designer to
	the plugin, use this to initialize the plugin, subscribe to events

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

Property Detail

Top

Returns	CHARACTER

Top

Returns	CHARACTER

ProDataset Detail

ProDataset dsBusinessEntity Member tables: eBusinessEntity, eDataRelation, eDataRelationProperties, eTable, eField, eFieldProperties, eIndex, eIndexProperties, eTableProperties, eBusinessEntityProperties