Consultingwerk.BusinessEntityDesigner.Plugins.CsharpGenerator.CsharpGeneratorWizard

Namespace:

Consultingwerk.BusinessEntityDesigner.Plugins.CsharpGenerator

Class

CsharpGeneratorWizard

Parent classes:

Progress.Windows.Form

Consultingwerk.Forms.BaseForm

Consultingwerk.Windows.BaseForms.BaseDialogForm

Consultingwerk.BusinessEntityDesigner.Plugins.CsharpGenerator.CsharpGeneratorWizard

Inherits:

Consultingwerk.Windows.BaseForms.BaseDialogForm

Implements:

IBaseForm, ICustomTypeDescriptor, IHasDesignerVerbs, IHasSecurityKey

File:	CsharpGeneratorWizard
Purpose:	Wrapper wizard to the xsd.exe utility
Author(s):	Mike Fechner / Consultingwerk Ltd.
Created:	Sun Dec 21 14:50:56 CET 2014
Notes:	http://msdn.microsoft.com/en-us/library/x6c1kb0s(v=vs.100).aspx

Top Method Summary

	Options	Name	Purpose
		ButtonOk_Click (Object, EventArgs)	Event handler for the Click event of the ButtonOk
		CHARACTER GetAdditionalParameter ()	Returns the additional parameters
		GetDatasetHandle (dataset)	Binds to the Business Entity Designer Dataset
		CHARACTER GetGenerate ()	Returns if dataset or classes should be generated
		CHARACTER GetNamespace ()	Returns the namespace
		CHARACTER GetOutputFolder ()	Returns the output folder
		CHARACTER GetSetting (character)	Gets a setting for this wizard from either the Business Entity Model or the Windows Registry
		CHARACTER GetXsdExe ()	Returns the path to xsd.exe
		InitializeComponent ()
		linkLabel1_LinkClicked (Object, LinkLabelLinkClickedEventArgs)	Event handler for the LinkClicked event of the linkLabel1 Control
		LookupKeyDownHandler (Object, KeyEventArgs)	Event handler for the KeyDown handler of the Text boxes with an EditorButton (Lookup)
		OnLoad (EventArgs)	Raises the Load event
		SetDefaultSetting (character, character)	Sets a setting default in the Windows Registry
		SetSetting (character, character)	Sets a setting in the Business Entity Design
		tbOutputFolder_EditorButtonClick (Object, EditorButtonEventArgs)	Event handler for the EditorButtonClick event of the tbOutputFolder
		tbXsdPath_EditorButtonClick (Object, EditorButtonEventArgs)	Event handler for the EditorButtonClick event of the tbXsdPath
		tbXsdPath_ValueChanged (Object, EventArgs)	Event handler for the ValueChanged event of the controls
		ultraButton1_Click (Object, EventArgs)	Event handler for the Click event of the ultraButton1
		ultraButton2_Click (Object, EventArgs)	Event handler for the Click event of the ultraButton2
		ultraButton3_Click (Object, EventArgs)	Event handler for the Click event of the ultraButton3
		ultraButton4_Click (Object, EventArgs)	Event handler for the Click event of the ultraButton3

Top Constructor Summary

	Options	Name	Purpose
		CsharpGeneratorWizard ()	Destructor for the CsharpGeneratorWizard class

Top Property Summary

	Options	Name	Purpose
		Consultingwerk.BusinessEntityDesigner.Services.BusinessEntityDatasetController BusinessEntityDatasetController

Method Detail

Top

ButtonOk_Click (Object, EventArgs)

Purpose:	Event handler for the Click event of the ButtonOk
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

CHARACTER GetAdditionalParameter ()

Purpose:	Returns the additional parameters
Notes:

Returns	CHARACTER
	The additional parameters

Top

GetDatasetHandle (dataset)

Purpose:	Binds to the Business Entity Designer Dataset
Notes:

Parameters:
dsBusinessEntity	DATASET dsBusinessEntity
	The dataset to bind to

Top

CHARACTER GetGenerate ()

Purpose:	Returns if dataset or classes should be generated
Notes:

Returns	CHARACTER
	dataset/classes

Top

CHARACTER GetNamespace ()

Purpose:	Returns the namespace
Notes:

Returns	CHARACTER
	The namespace

Top

CHARACTER GetOutputFolder ()

Purpose:	Returns the output folder
Notes:

Returns	CHARACTER
	The output folder

Top

CHARACTER GetSetting (character)

Purpose:	Gets a setting for this wizard from either the Business Entity
	Model or the Windows Registry
Notes:

Parameters:
pcSetting	CHARACTER
	The key for the setting
Returns	CHARACTER
	The value for the setting

Top

CHARACTER GetXsdExe ()

Purpose:	Returns the path to xsd.exe
Notes:

Returns	CHARACTER
	The path to xsd.exe

Top

InitializeComponent ()

Top

linkLabel1_LinkClicked (Object, LinkLabelLinkClickedEventArgs)

Purpose:	Event handler for the LinkClicked event of the linkLabel1 Control
Notes:	Opens the MSDN Reference entry for the xsd.exe utility
	http://msdn.microsoft.com/en-us/library/x6c1kb0s(v=vs.100).aspx

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

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

OnLoad (EventArgs)

Purpose:	Raises the Load event
Notes:

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

Top

SetDefaultSetting (character, character)

Purpose:	Sets a setting default in the Windows Registry
Notes:

Parameters:
pcKey	CHARACTER
	The settings key to store
pcValue	CHARACTER
	The settings value to store

Top

SetSetting (character, character)

Purpose:	Sets a setting in the Business Entity Design
Notes:

Parameters:
pcKey	CHARACTER
	The settings key to store
pcValue	CHARACTER
	The settings value to store

Top

tbOutputFolder_EditorButtonClick (Object, EditorButtonEventArgs)

Purpose:	Event handler for the EditorButtonClick event of the tbOutputFolder
Notes:

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

Top

tbXsdPath_EditorButtonClick (Object, EditorButtonEventArgs)

Purpose:	Event handler for the EditorButtonClick event of the tbXsdPath
Notes:

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

Top

tbXsdPath_ValueChanged (Object, EventArgs)

Purpose:	Event handler for the ValueChanged event of the controls
Notes:	Validates input and enables/disables ButtonOk

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

ultraButton1_Click (Object, EventArgs)

Purpose:	Event handler for the Click event of the ultraButton1
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

ultraButton2_Click (Object, EventArgs)

Purpose:	Event handler for the Click event of the ultraButton2
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

ultraButton3_Click (Object, EventArgs)

Purpose:	Event handler for the Click event of the ultraButton3
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

ultraButton4_Click (Object, EventArgs)

Purpose:	Event handler for the Click event of the ultraButton3
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