Consultingwerk.BusinessEntityDesigner.Plugins.SwaggerGenerator.SwaggerGeneratorWizard

Namespace:

Consultingwerk.BusinessEntityDesigner.Plugins.SwaggerGenerator

Class

SwaggerGeneratorWizard

Parent classes:

Progress.Windows.Form

Consultingwerk.Forms.BaseForm

Consultingwerk.BusinessEntityDesigner.Plugins.SwaggerGenerator.SwaggerGeneratorWizard

Inherits:

Consultingwerk.Forms.BaseForm

Implements:

Consultingwerk.Forms.IBaseForm, ICustomTypeDescriptor, IHasDesignerVerbs, IHasSecurityKey

File:	SwaggerGeneratorWizard
Purpose:	Wizard for generating Swagger JSON Catalog files
Author(s):	Martyn Kemp / Consultingwerk Ltd.
Created:	Thu May 18 10:00:03 BST 2017

Top Method Summary

	Options	Name	Purpose
		btnOk_Click (Object, EventArgs)	Event handler for the Click event of the btnOk
		GetDatasetHandle (dataset)	Binds to the Business Entity Designer Dataset
		InitializeComponent ()
		LookupKeyDownHandler (Object, KeyEventArgs)	Event handler for the KeyDown handler of the Text boxes with an EditorButton (Lookup)
		OnShown (EventArgs)	Raises the Shown event
		RestoreWindowPosition ()	Restortes the Form Settings
		StoreWindowPosition ()	Stores Form settings in the Registry
		tbCatalogFolder_EditorButtonClick (Object, EditorButtonEventArgs)	Event handler for the EditorButtonClick event of the tbCatalogFolder and tbAppServerFolder

Top Constructor Summary

	Options	Name	Purpose
		SwaggerGeneratorWizard ()	Constructor for the SwaggerGeneratorWizard class

Top Property Summary

	Options	Name	Purpose
		CHARACTER BusinessEntityName
		CHARACTER BusinessEntityPackage

Method Detail

Top

btnOk_Click (Object, EventArgs)

Purpose:	Event handler for the Click event of the btnOk
Notes:

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

Top

GetDatasetHandle (dataset)

Purpose:	Binds to the Business Entity Designer Dataset
Notes:

Parameters:
dsBusinessEntity	DATASET dsBusinessEntity
	The dataset to bind to

Top

InitializeComponent ()

Top

LookupKeyDownHandler (Object, KeyEventArgs)

Purpose:	Event handler for the KeyDown handler of the Text boxes with an
	EditorButton (Lookup)
Notes:	Maps F3 to EditorButtonClick

Parameters:
sender	System.Object
	The reference to the object that raised the event
e	System.Windows.Forms.KeyEventArgs
	The KeyEventArgs with the data for this event

Top

OnShown (EventArgs)

Purpose:	Raises the Shown event
Notes:

Parameters:
e	System.EventArgs
	The System.EventArgs with the data for the Shown event

Top

RestoreWindowPosition ()

Purpose:	Restortes the Form Settings
Notes:

Top

StoreWindowPosition ()

Purpose:	Stores Form settings in the Registry
Notes:

Top

tbCatalogFolder_EditorButtonClick (Object, EditorButtonEventArgs)

Purpose:	Event handler for the EditorButtonClick event of the tbCatalogFolder
	and tbAppServerFolder
Notes:

Parameters:
sender	System.Object
	The reference to the control that raised the event
e	Infragistics.Win.UltraWinEditors.EditorButtonEventArgs
	The EditorButtonEventArgs with the data for this event

Constructor Detail

Top

SwaggerGeneratorWizard ()

Purpose:	Constructor for the SwaggerGeneratorWizard class
Notes:

Property Detail

Top

CHARACTER BusinessEntityName

Returns	CHARACTER

Top

CHARACTER BusinessEntityPackage

Returns	CHARACTER

ProDataset Detail

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