Consultingwerk.BusinessEntityDesigner.Plugins.SwaggerGeneratorPlugin

Namespace:

Class

SwaggerGeneratorPlugin

Parent classes:

Progress.Lang.Object

Consultingwerk.BusinessEntityDesigner.Plugins.SwaggerGeneratorPlugin

Inherits:

Progress.Lang.Object

Implements:

Consultingwerk.BusinessEntityDesigner.IBusinessEntityDesignerPlugin

File:	SwaggerGeneratorPlugin
Purpose:	Business Entity Designer Plugin to create Swagger
	JSON Schema for the current Business Entity
Description:	Creates a "Generate Swagger Schema" button in the
	Business Entity Designer.
Author(s):	Martyn Kemp / Consultingwerk Ltd.
Created:	Wed May 17 19:20:33 BST 2017

Top Method Summary

Options	Name	Purpose
#	GenerateSwaggerSchema ()	Shows the Wizzard to create an C# Classes
+	Shutdown ()	Shuts down the plugin
+	Startup (dataset, BusinessEntityDatasetController, BusinessEntityDesignerForm, UltraToolbarsManager)	Initializes the plugin
#	ToolClickHandler (Object, ToolClickEventArgs)	Handles the ToolClick event of the Business Entity Designer's UltraToolbarsManager

Top Constructor Summary

	Options	Name	Purpose
	+	SwaggerGeneratorPlugin ()	Constructor for the ClassAnnotationGeneratorPlugin class

Method Detail

Top

Purpose:	Shows the Wizzard to create an C# Classes
Notes:

Top

Purpose:	Shuts down the plugin
Notes:

Top

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

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

Constructor Detail

Top

Purpose:	Constructor for the ClassAnnotationGeneratorPlugin class
Notes:

ProDataset Detail

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