Consultingwerk.Windows.Framework.Repository.BusinessEntities.MetaEntityTable.MetaDataFieldViewerLogic

Namespace:

Consultingwerk.Windows.Framework.Repository.BusinessEntities.MetaEntityTable

Class

MetaDataFieldViewerLogic

Parent classes:

Progress.Lang.Object

Consultingwerk.SmartComponents.Base.SmartViewerLogic

Consultingwerk.Windows.Framework.Repository.BusinessEntities.MetaEntityTable.MetaDataFieldViewerLogic

Inherits:

Consultingwerk.SmartComponents.Base.SmartViewerLogic

Implements:

ISmartViewerLogicWithEvents

File:	MetaDataFieldViewerLogic
Purpose:	Viewer Logic for the MetaDataFieldViewer
Author(s):	Mike Fechner / Consultingwerk Ltd.
Created:	Sun Oct 11 21:50:09 CEST 2020
	Purpose: Event handler for the AfterAddRecord event of the viewer
	Notes:

Top Method Summary

Options	Name	Purpose
#	AfterAddRecordHandler (Object, EventArgs)	Event handler for the AfterAddRecord event of the viewer
+	System.Windows.Forms.Control GetBoundControl (character)	Returns the reference to the first Control that is bound to the named field of the binding source Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic
+	System.Collections.Generic.List <System.Windows.Forms.Control> GetBoundControls (character)	Returns the list of references of the Controls that are bound to the named field of the binding source Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic
#	HANDLE GetScreenValuesDataset ()	Returns a ProDataset with the current screen values Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic
+	System.Windows.Forms.Control GetViewerField (character)	Returns the reference to a Control in the Viewer identified by the Controls Name. This Method starts a recursive search for the Control. Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic
#	HandleUiControl (UiControl, handle)	Returns a ProDataset with the current screen values Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic
+	LOGICAL HasBoundControl (character)	Returns logical value indicating if the Viewer contains a Control that is bound to the named field Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic
+	Initialize ()	Initializes the SmartViewerLogic instance Overrides Consultingwerk.SmartComponents.Base.SmartViewerLogic:Initialize ()
+	InitializeViewerUiControlHandler ()	Initializes the SmartViewerUiControlHandler class Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic
#	RaiseGenericEvent (EventArgs)	Raises the Generic Event Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic
+	RegisterSmartViewerControl (SmartViewerControl)	Handshake method for SmartViewerControl instances Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic
#	ResetViewerState ()	Resets the state of the Viewer Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic
+	SetControlEnabled (character, character)	Sets the Enable Mode for the given Controls inside the SmartViewerControl Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic
+	SetControlEnabled (Control, character)	Sets the Enable Mode for a given Control inside the SmartViewerControl. Called by the Method InitializeControlEventHandler () of a SmartViewerControl derived Class. Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic
+	SetControlEnabled (Control, Control, character)	Sets the Enable Mode for two given Controls inside the SmartViewerControl. Called by the Method InitializeControlEventHandler () of a SmartViewerControl derived Class. Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic
+	SetControlEnabled (Control, Control, Control, character)	Sets the Enable Mode for three given Controls inside the SmartViewerControl. Called by the Method InitializeControlEventHandler () of a SmartViewerControl derived Class. Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic
+	SetControlEnabled (Control, Control, Control, Control, character)	Sets the Enable Mode for four given Controls inside the SmartViewerControl. Called by the Method InitializeControlEventHandler () of a SmartViewerControl derived Class. Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic
+	SetControlEnabled (Control, Control, Control, Control, Control, character)	Sets the Enable Mode for five given Controls inside the SmartViewerControl. Called by the Method InitializeControlEventHandler () of a SmartViewerControl derived Class. Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic
+	SetControlEnabled (Control[], character)	Sets the Enable Mode for the given Controls inside the SmartViewerControl Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic
+	SetModifyingState ()	Sets the TableIOState to ModifyingData Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic
+	Shutdown ()	Shuts down the SmartViewerLogic instance Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic
+	SubscribeControlEventHandler (Control, character, character)	Subscribes a Control to an Event Handler in the Viewer Logic Class Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic
+	SubscribeEvents ()	Subscribes the events for an attached viewer instance Overrides Consultingwerk.SmartComponents.Base.SmartViewerLogic:SubscribeEvents ()
+	UnsubscribeEvents ()	Unsubscribes the events for an attached viewer instance Overrides Consultingwerk.SmartComponents.Base.SmartViewerLogic:UnsubscribeEvents ()

Top Property Summary

Options	Name	Purpose
+	DynamicForm DynamicForm	Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic
+	Consultingwerk.SmartComponents.Base.SmartViewerControl Owner	Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic
+	ISmartDataSource SmartDataSource	Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic
+	ISmartGroupAssignSource SmartGroupAssignSource	Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic
+	ISmartTableIOSource SmartTableIOSource	Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic
+	Consultingwerk.SmartComponents.Base.ListSmartViewerControl SmartViewerControls	Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic
+	Consultingwerk.SmartComponents.Base.SmartWindowForm SmartWindowForm	Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic

Method Detail

Top

PROTECTED AfterAddRecordHandler (Object, EventArgs)

Purpose:	Event handler for the AfterAddRecord event of the viewer
Notes:

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

Top

PUBLIC System.Windows.Forms.Control GetBoundControl (character)

Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic

Purpose:	Returns the reference to the first Control that is bound to the named
	field of the binding source
Notes:	Searches all Controls in the owning viewer and also GroupAssignLinked viewers

Parameters:
pcBindingPropertyName	CHARACTER
	The name of the field in the ProBindingSource
Returns	System.Windows.Forms.Control
	The bound Control of ? when no Control is bound

Top

PUBLIC System.Collections.Generic.List <System.Windows.Forms.Control> GetBoundControls (character)

Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic

Purpose:	Returns the list of references of the Controls that are bound to the
	named field of the binding source
Notes:	Returns all Controls in the owning viewer and also GroupAssignLinked viewers

Parameters:
pcBindingPropertyName	CHARACTER
	The name of the field in the ProBindingSource
Returns	System.Collections.Generic.List <System.Windows.Forms.Control>
	The List of bound Controls

Top

PROTECTED HANDLE GetScreenValuesDataset ()

Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic

Purpose:	Returns a ProDataset with the current screen values
Notes:

Returns	HANDLE
	The handle of the ProDataset

Top

PUBLIC System.Windows.Forms.Control GetViewerField (character)

Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic

Purpose:	Returns the reference to a Control in the Viewer identified by the Controls
	Name. This Method starts a recursive search for the Control.
Notes:	The Method is called by the SmartLookupControls to set values to
	the Controls after the Lookup Dialog has been closed.

Parameters:
pcControlName	CHARACTER
	Name of the Control to search
Returns	System.Windows.Forms.Control
	The reference to the Control or the unknown value

Top

PROTECTED HandleUiControl (UiControl, handle)

Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic

Purpose:	Returns a ProDataset with the current screen values
Notes:

Parameters:
poUiControl	UiControl
	The reference to the UiControl instance to process
phDataset	HANDLE
	The handle of the ProDataset with the screen values

Top

PUBLIC LOGICAL HasBoundControl (character)

Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic

Purpose:	Returns logical value indicating if the Viewer contains a Control
	that is bound to the named field
Notes:	Includes Group Assigned viewers

Parameters:
pcBindingPropertyName	CHARACTER
	The name of the field in the ProBindingSource
Returns	LOGICAL
	Logical value indicating if a bound control exists

Top

PUBLIC Initialize ()

Overrides Consultingwerk.SmartComponents.Base.SmartViewerLogic:Initialize ()

Purpose:	Initializes the SmartViewerLogic instance
Notes:

Top

PUBLIC InitializeViewerUiControlHandler ()

Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic

Purpose:	Initializes the SmartViewerUiControlHandler class
Notes:	The SmartViewerUiControlHandler is initialized when calling into
	GetScreenValuesDataset, HandleUiControl and ResetViewerState
	This method allows to initialize the instance earlier, especially to
	store the EnabledStatus of fields earlier

Top

PROTECTED RaiseGenericEvent (EventArgs)

Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic

Purpose:	Raises the Generic Event
Notes:	Supports raising events from the Viewer Logic Class - it's recommended
	to use a derived event arg to distinguish events

Parameters:
e	Consultingwerk.EventArgs
	The Consultingwerk.EventArgs

Top

PUBLIC RegisterSmartViewerControl (SmartViewerControl)

Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic

Purpose:	Handshake method for SmartViewerControl instances
Notes:	You may override this method to perform initialization for a
	specific viewer

Parameters:
poSmartViewerControl	Consultingwerk.SmartComponents.Base.SmartViewerControl
	The SmartViewerControl instance this logic class will provide logic for

Top

PROTECTED ResetViewerState ()

Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic

Purpose:	Resets the state of the Viewer
Notes:	SetControlEnabled, StyleSetName

Top

PUBLIC SetControlEnabled (character, character)

Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic

Purpose:	Sets the Enable Mode for the given Controls inside the SmartViewerControl
Notes:	Possible Values for pcEnabled (ControlEnabledEnum):
	Add, Always, Never, Update, UpdateOnly

Parameters:
pcControlNames	CHARACTER
	The comma delimited list of Control Name
pcEnabled	CHARACTER
	Mode to be set as defined in ControlEnabledEnum

Top

PUBLIC SetControlEnabled (Control, character)

Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic

Purpose:	Sets the Enable Mode for a given Control inside the SmartViewerControl.
	Called by the Method InitializeControlEventHandler () of a
	SmartViewerControl derived Class.
Notes:	Possible Values for pcEnabled (ControlEnabledEnum):
	Add, Always, Never, Update, UpdateOnly

Parameters:
poControl	Control
	The Control which shall be set to the passed in Mode
pcEnabled	CHARACTER
	Mode to be set as defined in ControlEnabledEnum

Top

PUBLIC SetControlEnabled (Control, Control, character)

Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic

Purpose:	Sets the Enable Mode for two given Controls inside the SmartViewerControl.
	Called by the Method InitializeControlEventHandler () of a
	SmartViewerControl derived Class.
Notes:	Possible Values for pcEnabled (ControlEnabledEnum):
	Add, Always, Never, Update, UpdateOnly

Parameters:
poControl1	Control
	The first Control which shall be set to the passed in Mode
poControl2	Control
	The second Control which shall be set to the passed in Mode
pcEnabled	CHARACTER
	Mode to be set as defined in ControlEnabledEnum

Top

PUBLIC SetControlEnabled (Control, Control, Control, character)

Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic

Purpose:	Sets the Enable Mode for three given Controls inside the SmartViewerControl.
	Called by the Method InitializeControlEventHandler () of a
	SmartViewerControl derived Class.
Notes:	Possible Values for pcEnabled (ControlEnabledEnum):
	Add, Always, Never, Update, UpdateOnly

Parameters:
poControl1	Control
	The first Control which shall be set to the passed in Mode
poControl2	Control
	The second Control which shall be set to the passed in Mode
poControl3	Control
	The third Control which shall be set to the passed in Mode
pcEnabled	CHARACTER
	Mode to be set as defined in ControlEnabledEnum

Top

PUBLIC SetControlEnabled (Control, Control, Control, Control, character)

Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic

Purpose:	Sets the Enable Mode for four given Controls inside the SmartViewerControl.
	Called by the Method InitializeControlEventHandler () of a
	SmartViewerControl derived Class.
Notes:	Possible Values for pcEnabled (ControlEnabledEnum):
	Add, Always, Never, Update, UpdateOnly

Parameters:
poControl1	Control
	The first Control which shall be set to the passed in Mode
poControl2	Control
	The second Control which shall be set to the passed in Mode
poControl3	Control
	The third Control which shall be set to the passed in Mode
poControl4	Control
	The forth Control which shall be set to the passed in Mode
pcEnabled	CHARACTER
	Mode to be set as defined in ControlEnabledEnum

Top

PUBLIC SetControlEnabled (Control, Control, Control, Control, Control, character)

Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic

Purpose:	Sets the Enable Mode for five given Controls inside the SmartViewerControl.
	Called by the Method InitializeControlEventHandler () of a
	SmartViewerControl derived Class.
Notes:	Possible Values for pcEnabled (ControlEnabledEnum):
	Add, Always, Never, Update, UpdateOnly

Parameters:
poControl1	Control
	The first Control which shall be set to the passed in Mode
poControl2	Control
	The second Control which shall be set to the passed in Mode
poControl3	Control
	The third Control which shall be set to the passed in Mode
poControl4	Control
	The forth Control which shall be set to the passed in Mode
poControl5	Control
	The fifth Control which shall be set to the passed in Mode
pcEnabled	CHARACTER
	Mode to be set as defined in ControlEnabledEnum

Top

PUBLIC SetControlEnabled (Control[], character)

Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic

Purpose:	Sets the Enable Mode for the given Controls inside the SmartViewerControl
Notes:	Possible Values for pcEnabled (ControlEnabledEnum):
	Add, Always, Never, Update, UpdateOnly

Parameters:
poControls	Control
	The array of Control which shall be set to the passed in Mode
pcEnabled	CHARACTER
	Mode to be set as defined in ControlEnabledEnum

Top

PUBLIC SetModifyingState ()

Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic

Purpose:	Sets the TableIOState to ModifyingData
Notes:	Useful when modifying Viewer values through custom event handlers

Top

PUBLIC Shutdown ()

Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic

Purpose:	Shuts down the SmartViewerLogic instance
Notes:

Top

PUBLIC SubscribeControlEventHandler (Control, character, character)

Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic

Purpose:	Subscribes a Control to an Event Handler in the Viewer Logic Class
Notes:	The event handler method needs to be PROTECTED in the Viewer Logic Class

Parameters:
poControl	System.Windows.Forms.Control
	The Control contained in the Viewer
pcEventName	CHARACTER
	The name of the event to subscribe
pcHandlerName	CHARACTER
	The name of the control event handler method

Top

PUBLIC SubscribeEvents ()

Overrides Consultingwerk.SmartComponents.Base.SmartViewerLogic:SubscribeEvents ()

Purpose:	Subscribes the events for an attached viewer instance
Notes:	This method needs to be implemented by the Viewer Logic class and
	is supposed to subscribe to control events

Top

PUBLIC UnsubscribeEvents ()

Overrides Consultingwerk.SmartComponents.Base.SmartViewerLogic:UnsubscribeEvents ()

Purpose:	Unsubscribes the events for an attached viewer instance
Notes:	This method needs to be implemented by the Viewer Logic class and
	is supposed to unsubscribe from control events

Property Detail

Top

PUBLIC DynamicForm DynamicForm

Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic

Returns	DynamicForm

Top

PUBLIC Consultingwerk.SmartComponents.Base.SmartViewerControl Owner

Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic

Returns	Consultingwerk.SmartComponents.Base.SmartViewerControl

Top

PUBLIC ISmartDataSource SmartDataSource

Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic

Returns	ISmartDataSource

Top

PUBLIC ISmartGroupAssignSource SmartGroupAssignSource

Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic

Returns	ISmartGroupAssignSource

Top

PUBLIC ISmartTableIOSource SmartTableIOSource

Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic

Returns	ISmartTableIOSource

Top

PUBLIC Consultingwerk.SmartComponents.Base.ListSmartViewerControl SmartViewerControls

Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic

Returns	Consultingwerk.SmartComponents.Base.ListSmartViewerControl

Top

PUBLIC Consultingwerk.SmartComponents.Base.SmartWindowForm SmartWindowForm

Inherited from Consultingwerk.SmartComponents.Base.SmartViewerLogic

Returns	Consultingwerk.SmartComponents.Base.SmartWindowForm

info@consultingwerk.de http://www.consultingwerk.de 09.11.2024 19:07:16