Namespace: Consultingwerk.BusinessEntityDesigner.Plugins
Class 
TableAndFieldConstantsGeneratorPlugin Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.BusinessEntityDesigner.Plugins.TableAndFieldConstantsGeneratorPlugin

Inherits: Progress.Lang.Object
Implements: Consultingwerk.BusinessEntityDesigner.IBusinessEntityDesignerPlugin

File:TableAndFieldConstantsGeneratorPlugin
Purpose:Business Entity Designer Plugin that supports the
generation of include files with Constants for ProDataset
Buffer and Field Names
Description:Creates an include file with the name <dataset name>_Constants.i
This include contains GLOBAL-DEFINE compile time variables
that can be used in dynamic code to avoid typos when building
dynamic queries. Generates the include file whenever the
Business Entity is generated of regenerated.
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Mon Oct 21 22:26:40 CEST 2014

Navigate to: Methods | Constructors | Events | Properties



Top Method Summary
Options Name Purpose
# AfterGenerateSourceHandler (Object, EventArgs) Event handler for the AfterGenerateSource event of the BusinessEntityDatasetController
# CHARACTER CheckTemplatePath (character) Verifies the path to a template file
# CHARACTER FindOutputFolder () Returns the output folder (source code folder for business logic)
# GenerateConstantsInclude () Generates the Model Classes
+ GenerateConstantsInclude (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.


Method Detail
Top

PROTECTED AfterGenerateSourceHandler (Object, EventArgs)
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

PROTECTED CHARACTER CheckTemplatePath (character)
Purpose: Verifies the path to a template file
Notes: Throws an error, when the template file cannot be found

Parameters:
pcFileName CHARACTER
The relative template file name
Returns CHARACTER
The absolute path to the template file
Top

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

Returns CHARACTER
The output folder
Top

PROTECTED GenerateConstantsInclude ()
Purpose: Generates the Model Classes
Notes:

Top

PUBLIC GenerateConstantsInclude (dataset)
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
Business Entity with the Design dataset, called with the BY-REFERENCE keyword
Top

PUBLIC Shutdown ()
Purpose: Method called when the Business Entity Designer will get closed
Notes:

Top

PUBLIC Startup (dataset, BusinessEntityDatasetController, BusinessEntityDesignerForm, UltraToolbarsManager)
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
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


©2006-2016 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       26.08.2016 08:26:26