Consultingwerk.SmartComponents.Base.SmartViewerControl

Namespace:

Consultingwerk.SmartComponents.Base

Class

SmartViewerControl

Parent classes:

Progress.Windows.UserControl

Consultingwerk.SmartComponents.Base.SmartUserControl

Consultingwerk.SmartComponents.Base.SmartViewerControl

Inherits:

Consultingwerk.SmartComponents.Base.SmartUserControl

Implements:

Inherited by:

File:	SmartViewerControl
Purpose:	Base class for SmartComponent Library Viewer Controls
Author(s):	Mike Fechner / Consultingwerk Ltd.
Created:	Sat Jan 17 16:57:43 CET 2009
Notes:	This class is meant to be ABSTRACT but the .NET Visual
	Designer framework cannot design classes that inherit
	from abstract base classes.

Top Method Summary

Options	Name	Purpose
#	ActivateCurrentGridRow ()	Activates the current row in the linked Grid
+	ActivateEventHandler ()	Activates the Event Handlers for the contained controls
+	AddRecord ()	Add a new record to the SmartDataSource. The Method CreateRecord of SmartViewerControl gets called to Handle this Task. This Method is called by the Toolbar Classes SmartToolbarController or SmartToolStripContainer by pressing the AddRecord Tool. Enforced by Interface ISmartDataTarget.
+	AddSmartTableIOSource (ISmartTableIOSource)	Adds a(nother) SmartTableIOSource to the SmartViewerControl instance
#	System.Windows.Forms.Control ApplyFocusToErrorField (character)	Set's focus into a field that is related to an error
#	System.Windows.Forms.Control ApplyFocusToErrorField (IFieldValidationError)	Set's focus into a field that is related to an error
+	AttachBindingSource (BindingSource)	This Method attaches a new BindingSource given as the Parameter poBindingSource to the Objects of the current Class. The new BindingSource may have been created by a DataAdapter or reused from a SmartBrowserControl
+	BeginInit ()	Invoked at the beginning of a Containers InitializeComponents method
#	BeginUpdateStateHandler (Object, DataSourceUpdateStateEventArgs)	Event handler for the BeginUpdateState event of the data source
#	BindingSourcePositionChanged (Object, EventArgs)	Event handler for the PositionChanged event of the BindingSource this Viewer is attached to
+	CancelUpdate ()	Reverts the changes to the current record.
+	CleanupLookupControls ()	Destroys the Controls in the Viewer Control
#	LOGICAL ControlFocus (Control)	Calls the Focus() method for a .NET Control
+	CopyRecord ()	Copy the current record to a new one. The Method CreateRecord of SmartViewerControl gets called to Handle this Task. This Method is called by the Toolbar Classes SmartToolbarController or SmartToolStripContainer by pressing the corresponding Tool. Enforced by Interface ISmartDataTarget.
#	CreateRecord (logical)	Creates a new record in the viewer. This Method is called by AddRecord and CopyRecord from the current Class but may be overridden.
#	CreateVerbs ()	Creates Designer Verbs based on the DesignerVerbs property Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
#	CustomInitializeControlHandler (Control)	Overridable method that can be used to perform custom event subscriptions
+	DeactivateEventHandler ()	Deactivates the Event Handlers for the contained controls
+	DeleteRecord ()	Delete the current record.
+	DeregisterSmartGroupAssignTarget (ISmartGroupAssignTarget)	Deregister a SmartDataTarget with the SmartGroupAssignTarget Enforced by Interface ISmartGroupAssignSource.
+	DisableFields ()	Disable all enabled controls of the SmartViewerControl. This Method is called from inside the SmartViewerControl. Enforced by Interface ISmartDataTarget or ISmartGroupAssignTarget.
-	DisableFields (logical)	Disable all enabled controls of the SmartViewerControl. This Method is called from inside the SmartViewerControl. Enforced by Interface ISmartDataTarget or ISmartGroupAssignTarget.
#	DisplayError (Error)	Display ErrorMessages shows a predefined Error Dialog and is called from the Method SaveChanges () of the SmartViewerControl Class.
#	DisplayError (Error, logical)	Display ErrorMessages shows a predefined Error Dialog and is called from the Method SaveChanges () of the SmartViewerControl Class.
#	EditorDropDownAfterCloseUpHandler (Object, EventArgs)	Event handler for the AfterCloseUp event of an UltraDateTimeEditor. Clears the reference to the currently opened DataTime popup editor in the variable oEditorDropDownControl
#	EditorDropDownAfterDropDownHandler (Object, EventArgs)	Event handler for the AfterDropDown event of an UltraDateTimeEditor. Stores a reference to the currently opened DataTime popup editor in the variable oEditorDropDownControl Required to be able to start the update process in the method TextChangedHandler (in this class)
+	EnableFields (character)	Enables controls of the SmartViewerControl
+	EnableFields (character, logical)	Enables controls of the SmartViewerControl
+	EndInit ()	Invoked at the end of a Containers InitializeComponents method
#	EndUpdateStateHandler (Object, DataSourceUpdateStateEventArgs)	Event handler for the EndUpdateState event of the data source
+	EnsureVisible ()	Ensures that this SmartViewerControl is visible
-	EnterEditorControlHandler (Object, EventArgs)	Event handler for the Enter event of an EditorButtonControlBase derived Class. Selects all content from the Controls Text Property in the UI.
+	EvaluateTableIOState ()	This Method sets the Property SmartTableIOState to a value according to the SmartDataSources state of the current class. Possible values for SmartTableIOState are defined in the TableIOStateEnum.
#	FillBoundControlTable (Control)	Populates the ttViewerBoundControls temp-table
+	Progress.Data.BindingSource FindDesignTimeBindingSource ()	Attempts to locate the BindingSource that was used in a SmartViewerControl at Design Time
+	LOGICAL FocusFirstEnabledEditorControl (Control)	Focusses the first enabled EditorControl of the given Container Control
#	FormActivatedHandler (Object, EventArgs)	Event handler for the Activate event of the owning Form
#	FormClosedHandler (Object, EventArgs)	Handles the FormClosed event of the containing Form
-	FormClosedHandler2 (Object, EventArgs)	Handles the FormClosed event of the containing Form
#	FormDeactivatedHandler (Object, EventArgs)	Event handler for the Deactivate event of the owning Form
+	System.Collections.Generic.List <System.ComponentModel.Component> GetAllComponents ()	Returns a List of all Components in the Form Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+	System.Windows.Forms.Control GetBoundControl (character)	Returns the reference to the Control that is bound to the named field of the binding source
+	System.Collections.Generic.List <System.Windows.Forms.Control> GetBoundControls (character)	Returns the list of Controls that is bound to the named field of the binding source
+	GetBoundControlTable (table)	Populates a temp-table with information about all bound controls in the SmartViewerControl
+	CHARACTER GetControlEnabled (Control)	Returns the Enable mode for a Control from the list of Controls that will be enabled and disabled by the Viewer based on the current Viewer state @param poControl The Control for which the Enable mode should be returned @return The CHARACTER value representing the Control Enabled mode */
+	CHARACTER GetControlSecurityEnabled (Control)	Returns the security Enable mode for a Control from the list of Controls that will be enabled and disabled by the Viewer based on the current Viewer state @param poControl The Control for which the Enable mode should be returned @return The CHARACTER value representing the security Control Enabled mode */
+	HANDLE GetScreenValuesDataset ()	Returns a ProDataset with the current screen values
+	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.
#	System.Windows.Forms.Control GetViewerField (character, Control)	Recursively searches for the Control with the given name
#	Consultingwerk.SmartComponents.Interfaces.ISmartGroupAssignTarget GetViewerForBoundControl (character)	Returns the reference to the SmartGroupAssignTarget that contains a Control bound to the given field name
#	GroupAssignSmartTableIOStateChangedHandler (Object, SmartTableIOStateChangedEventArgs)	Event handler for the SmartTableIOStateChanged event of the Group assign Source
#	HandleServerEvent (Object, EventArgs, character)	Event handler for a server-side event
#	HandleServerEvent (Object, EventArgs, character, character)	Event handler for a server-side event
+	HandleUiControl (UiControl, handle)	Returns a ProDataset with the current screen values
+	HandleValidationError (Error)	Handles an error raised by validation routines
+	LOGICAL HasBoundControl (character, logical)	Returns logical value indicating if the Viewer contains a Control that is bound to the named field
#	InitializeControlEventHandler ()	Subscribe the EventHandler(s) to events of all controls added to the SmartViewerControl. The RecurseInitializeControlEventHandler is used to Handle this Task. This Method is called every Time a new Control is added to the SmartViewerControl.
#	InitializeViewerLogicObject ()	Initializes the Viewer Logic Object
+	InitializeViewerUiControlHandler ()	Initializes the SmartViewerUiControlHandler class
#	LOGICAL IsControlEnabled (character, character, logical)	Determines if a Control should be enabled based on the SecurityEnableMode and EnableMode
+	LOGICAL IsEditorControl (Control)	Returns TRUE is the Controls is recognized as an Editor Control
+	LOGICAL IsOkToClose (logical, CloseReason)	Check if it is ok to close the parent form. Returns TRUE when the form can be closed. Otherwise returns FALSE. Enforced by the Interface ICheckOkToClose.
#	LOGICAL IsValueChanged (Object)	Returns if the current (screen-value) of a Control in the SmartViewerControl derived class has changed in comparison to the underlying buffer value
#	LeaveHandler (Object, EventArgs)	Event handler for the Leave event
#	OnAddedRecordModifiedChanged (EventArgs)	Raises the AddedRecordModifiedChanged
#	OnAddingRecordChanged (EventArgs)	Raises the AddingRecordChanged event
#	OnAfterAddRecord (EventArgs)	Raises the AfterAddRecord event
#	OnAfterCancelledUpdate (AfterCancelledUpdateEventArgs)	Raises the AfterCancelledUpdate event
#	OnAfterCancelUpdate (EventArgs)	Raises the AfterCancelUpdate event
#	OnAfterCopyRecord (EventArgs)	Raises the AfterCopyRecord event
#	OnAfterDeleteRecord (EventArgs)	Raises the AfterDeleteRecord event
#	OnAfterFieldsEnabled (EventArgs)	Raises the AfterFieldsEnabled
#	OnAfterSaveChanges (EventArgs)	Raises the AfterSaveChanges event
#	OnBeforeAddRecord (CancelEventArgs)	Raises the BeforeAddRecord event
#	OnBeforeCancelUpdate (CancelEventArgs)	Raises the BeforeCancelUpdate event
#	OnBeforeCopyRecord (CancelEventArgs)	Raises the BeforeCopyRecord event
#	OnBeforeDeleteRecord (CancelEventArgs)	Raises the BeforeDeleteRecord event
#	OnBeforeEnableFields (CancelableEventArgs)	Raises the BeforeEnableFields
#	OnBeforeSaveChanges (CancelEventArgs)	Raises the BeforeSaveChanges event
#	OnCopyingRecordChanged (EventArgs)	Raises the CopyingRecordChanged event
#	OnCurrentChanged (EventArgs)	Raises the CurrentChanged event
#	OnEnter (EventArgs)	Raises the Enter event
#	OnFieldsDisabled (EventArgs)	Raises the FieldsDisabled event.
#	OnFieldsEnabled (EventArgs)	Raises the FieldsEnabled event.
#	OnFocusControlOnAddChanged (EventArgs)	Raises the FocusControlOnAddChanged event
#	OnFocusControlOnUpdateChanged (EventArgs)	Raises the FocusControlOnUpdateChanged event
#	OnGenericEvent (EventArgs)	Raises the GenericEvent
#	OnInitializingChanged (EventArgs)	Raises the InitializingChanged event
#	OnLoad (EventArgs)	Raises the Load event Overrides Consultingwerk.SmartComponents.Base.SmartUserControl:OnLoad (EventArgs)
#	OnSmartDataSourceChanged (EventArgs)	Publishes the SmartDataSourceChanged event
#	OnSmartGroupAssignSourceChanged (EventArgs)	Publishes the SmartGroupAssignSourceChanged event
#	OnSmartTableIOSourceChanged (EventArgs)	Publishes the SmartGroupAssignSourceChanged event
#	OnSmartTableIOStateChanged (SmartTableIOStateChangedEventArgs)	Publishes the SmartTableIOStateChanged event
+	OnVerbClicked (character)	Event Handler method for Designer Verbs Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
#	OnVisualValidating (EventArgs)	Raises the VisualValidating event
#	ParentChangedHandler (Object, EventArgs)	Event handler to the ParentChanged event Add EventHandlers to Child Controls inside the SmartViewerControl. This Method is Executed when the SmartViewerControl is added to a Form.
#	ParentFormDestroyedHandler (Object, EventArgs)	Event handler for the FormDestroyed event of the owning Form Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+	ProcessHiddenControls ()	Processes the registered hidden controls
+	RaiseGenericEvent (EventArgs)	Raises the Generic Event
+	LOGICAL RaiseToolbarAction (Object, ToolClickEventArgs, character)	Executes a Toolbar Action
#	RecurseInitializeControlEventHandler (Control)	Subscribe the EventHandler(s) to events of all controls added to the SmartViewerControl. This Method is called by the Method InitializeControlEventHandler () of the SmartViewerControl.
#	System.Windows.Forms.Control RecurseLocateBindingControl (Control, character)	Recurses through the Controls in this SmartViewerControl and nested controls searching for a Control that is bound to the named BindingProperty (a field attached to the ProBindingSource).
#	RecurseLocateBindingControls (Control, Control>, character)	Recurses through the Controls in this SmartViewerControl and nested controls searching for all Controls that are bound to the named BindingProperty (a field attached to the ProBindingSource).
#	RecurseLookupStopTimer (Control)	Stops the current timer of all Lookups
#	RecursePerformLookup (Control)	Performs the Lookup operation in all contained SmartLookup Controls
#	RecurseReplaceBindingSource (Control, BindingSource)	Internal method to replace the data bindings of all contained Controls with the actual binding source provided by a SmartDataSource.
#	RecurseRestoreCurrentValues (Control)	Recurse Restore the Current Values of the Controls on the Viewer after a new DataRow is created. This Method is called by the internal Method RestoreValuesForCopy (). Parameters:
#	RecurseStoreCurrentValues (Control)	Recurse Store the Current Values of the Controls on the Viewer before a new DataRow is created. This Method is called by the internal Method StoreValuesForCopy ().
+	RegisterHiddenControl (Control)	Register a hidden control
#	RegisterServerSideEventHandler (Control, character, character)	Subscribes a Control to a server-side event handler
+	RegisterSmartGroupAssignTarget (ISmartGroupAssignTarget)	Register a SmartDataTarget with the SmartGroupAssignTarget This Method is executed every time a new SmartGroupAssignSource is registered to the corresponding Property of a Class implementing the Interface ISmartGroupAssignSource. Enforced by Interface ISmartGroupAssignSource.
#	RemoveControlEnabled (Control)	Removes a Control from the list of Controls that will be enabled and disabled by the Viewer based on the current Viewer state @param poControl The Control which shall be removed from the list of managed Controls */
#	RemoveControlEnabled (Control, Control)	Removes multiple Controls from the list of Controls that will be enabled and disabled by the Viewer based on the current Viewer state @param poControl1 The first Control which shall be removed from the list of managed Controls @param poControl2 The second Control which shall be removed from the list of managed Controls */
#	RemoveControlEnabled (Control, Control, Control)	Removes multiple Controls from the list of Controls that will be enabled and disabled by the Viewer based on the current Viewer state @param poControl1 The first Control which shall be removed from the list of managed Controls @param poControl2 The second Control which shall be removed from the list of managed Controls @param poControl3 The third Control which shall be removed from the list of managed Controls */
#	RemoveControlEnabled (Control, Control, Control, Control)	Removes multiple Controls from the list of Controls that will be enabled and disabled by the Viewer based on the current Viewer state @param poControl1 The first Control which shall be removed from the list of managed Controls @param poControl2 The second Control which shall be removed from the list of managed Controls @param poControl3 The third Control which shall be removed from the list of managed Controls @param poControl4 The fourth Control which shall be removed from the list of managed Controls */
#	RemoveControlEnabled (Control, Control, Control, Control, Control)	Removes multiple Controls from the list of Controls that will be enabled and disabled by the Viewer based on the current Viewer state @param poControl1 The first Control which shall be removed from the list of managed Controls @param poControl2 The second Control which shall be removed from the list of managed Controls @param poControl3 The third Control which shall be removed from the list of managed Controls @param poControl4 The fourth Control which shall be removed from the list of managed Controls @param poControl5 The fifth Control which shall be removed from the list of managed Controls */
+	RemoveSmartTableIOSource (ISmartTableIOSource)	Removes a SmartTableIOSource from the SmartDataAdapter instance
+	ResetViewerState (logical)	Resets the state of the Viewer
+	RestoreValuesForCopy ()	Restore the Current Values of all Controls on a SmartViewerControl and in all SmartGroupAssignTargets. This Method is called by CreateRecord from the current Class. Enforced by Interface ISmartGroupAssignTarget.
+	SaveChanges ()	Saves the current changes to the database.
+	LOGICAL SaveChangesOnDeactivateForm (logical)	Saves pending changes when a Form is deactivated
-	ServerSideAfterPerformLookupHandler (Object, EventArgs)	Event handler for AfterPerformLookup event
-	ServerSideClickHandler (Object, EventArgs)	Event handler for Click event
+	ServerSideCurrentChangedHandler (Object, EventArgs)	Event handler for CurrentChanged event
-	ServerSideLeaveHandler (Object, EventArgs)	Event handler for Leave event
-	ServerSideLoadHandler (Object, EventArgs)	Event handler for Load event
-	ServerSideLookupCompleteHandler (Object, EventArgs)	Event handler for LookupComplete event
-	ServerSideLookupKeyValueChangedHandler (Object, EventArgs)	Event handler for LookupKeyValueChanged event
-	ServerSideValidatingHandler (Object, EventArgs)	Event handler for Validating event
-	ServerSideValueChangedHandler (Object, EventArgs)	Event handler for ValueChanged event
+	SetControlEnabled (character, character)	Sets the Enable Mode for the given Controls inside the SmartViewerControl
+	SetControlEnabled (Control, character)	Sets the Enable Mode for a given Control inside the SmartViewerControl. Called by the Method InitializeControlEventHandler () of a SmartViewerControl derived Class.
+	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.
+	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.
+	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.
+	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.
+	SetControlEnabled (Control[], character)	Sets the Enable Mode for the given Controls inside the SmartViewerControl
#	SetControlEnabledFromDescriptor ()	Sets the ControlEnabled property of the visual controls based on the Business Entity Descriptor
-	SetControlSecurityEnabled (Control, character)	Sets the Enable Mode based on Security Constraints for a given Control
+	SetModifyingState ()	Sets the TableIOState to ModifyingData
+	SetOpenedEditorDropDownControl (Control)	Set's the current opened EditorDropDownControl
+	StoreValuesForCopy ()	Store the Current Values of all Controls on a SmartViewerControl and do the same in all SmartGroupAssignTargets. This Method is called by CreateRecord from the current Class. Enforced by Interface ISmartGroupAssignTarget.
+	SubscribeControlEventHandler (Control, character, character)	Subscribes a Control to an Event Handler in the Viewer Logic Class
+	SubscribeParentFormDestroyed ()	Subscribes the ParentFormDestroyed event Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
#	SubscribeUserControlEvents ()	Allows for custom event subscriptions during OnLoad() Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+	TextChangedEventHandler (Object, EventArgs)	Event handler for the TextChangedEvent event of Editor Controls on the SmartViewerControl. Initiate switching to the ModifyingData Mode if the user enters data.
-	ViewerDataSourceCurrentChangedHandler (Object, EventArgs)	Event handler for the CurrentChanged event of the data source this Viewer is attached to
+	VisualValidate ()	Validate data entered into the DataFields
+	Consultingwerk.Windows.LegacyGuiMigration.Widgets.IWidgetFacade WidgetHandle (character)	Returns the WidgetFacade for the given widget

Top Constructor Summary

	Options	Name	Purpose
	+	SmartViewerControl ()	The Constructor initializes a new SmartViewerControl Subscribes handlers for events

Top Event Summary

Options	Name	Purpose
+	AddedRecordModifiedChanged DELEGATE System.EventHandler	Raised when the value of the AddedRecordModified property changes
+	AddingRecordChanged DELEGATE System.EventHandler	Event fired when the AddingRecord Property is changed
+	AfterAddRecord DELEGATE System.EventHandler	Event fired when the viewer has successfully started an Add operation
+	AfterCancelledUpdate (Object, AfterCancelledUpdateEventArgs)	Event fired when the viewer has successfully cancelled an update
+	AfterCancelUpdate DELEGATE System.EventHandler	Event fired when the viewer has successfully cancelled an update
+	AfterCopyRecord DELEGATE System.EventHandler	Event fired when the viewer has successfully started a Copy operation
+	AfterDeleteRecord DELEGATE System.EventHandler	Event fired when the viewer has successfully deleted a record.
+	AfterFieldsEnabled DELEGATE System.EventHandler	Raised after the fields have been enabled
+	AfterSaveChanges DELEGATE System.EventHandler	Event fired when the viewer has successfully saved changes
+	BeforeAddRecord DELEGATE System.ComponentModel.CancelEventHandler	Event fired when the Viewer starts adding a new record. This event is cancelable
+	BeforeCancelUpdate DELEGATE System.ComponentModel.CancelEventHandler	Event fired when the Viewer begins cancelling an update. This event is cancellable
+	BeforeCopyRecord DELEGATE System.ComponentModel.CancelEventHandler	Event fired when the Viewer begins copying a record. This event is cancellable
+	BeforeDeleteRecord DELEGATE System.ComponentModel.CancelEventHandler	Event fired when the Viewer starts deleting a record. This event is cancellable
+	BeforeEnableFields (Object, CancelableEventArgs)	Raised before the fields are enabled
+	BeforeSaveChanges DELEGATE System.ComponentModel.CancelEventHandler	Event fired when the Viewer starts saving a record. This event is cancellable
+	CopyingRecordChanged DELEGATE System.EventHandler	Raised when the CopyingRecord property has changed
+	CurrentChanged DELEGATE System.EventHandler	Event fired when the current record changes
+	FieldsDisabled DELEGATE System.EventHandler	Event fired when the fields of this viewer become disabled
+	FieldsEnabled DELEGATE System.EventHandler	Event fired when the fields of this viewer become enabled
+	FocusControlOnAddChanged DELEGATE System.EventHandler	Event fired when the FocusControlOnAdd property changes
+	FocusControlOnUpdateChanged DELEGATE System.EventHandler	Event fired when the FocusControlOnUpdate property changes
+	GenericEvent (Object, EventArgs)	Raised from custom logic
+	InitializingChanged DELEGATE System.EventHandler	Event fired when the Initializing property changes
+	SmartDataSourceChanged DELEGATE System.EventHandler	Event fired when the SmartDataSource Property is changed
+	SmartGroupAssignSourceChanged DELEGATE System.EventHandler	Event fired when the SmartGroupAssignSource Property is changed
+	SmartTableIOSourceChanged DELEGATE System.EventHandler	Event fired when the SmartTableIOSource Property is changed
+	SmartTableIOStateChanged (Object, SmartTableIOStateChangedEventArgs)	Event fired whenever the SmartTableIOState property has changed
+	VisualValidating DELEGATE System.EventHandler	Raised when the Viewer performs Visual Validation

Top Property Summary

Options	Name	Purpose
+	LOGICAL ActivateCurrentGridRowDuringEdit
+	LOGICAL AddedRecordModified
+	LOGICAL AddingRecord
+	LOGICAL AllowCloseOfUnmodifiedNewRecord
+	LOGICAL CancellingUpdate
+	LOGICAL CopyingRecord
#	CHARACTER DesignerVerbs	Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+	LOGICAL DesignTime	Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+	LOGICAL DisallowUpdateDuringAnotherUpdate
+	LOGICAL DisallowUpdateDuringAnotherUpdateDefault
+	LOGICAL EventHandlerActive
+	System.Windows.Forms.Control FocusControlOnAdd
+	System.Windows.Forms.Control FocusControlOnUpdate
#	CHARACTER HiddenProperties	Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+	LOGICAL Initializing
+	Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataSource LinkDataSource
+	Consultingwerk.SmartComponents.Interfaces.Design.IDesignGroupAssignSource LinkGroupAssignSource
+	Consultingwerk.SmartComponents.Interfaces.Design.IDesignTableIOSource LinkTableIOSource
+	Consultingwerk.SmartComponents.Interfaces.Design.IDesignToolbarSource LinkToolbarSource
#	CHARACTER NonBrowsableProperties	Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
#	Consultingwerk.SmartComponents.Base.SmartViewerOptionalFeatures OptionalFeatures
#	LOGICAL ParentFormDestroyedSubscribed	Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+	LOGICAL ReadOnlyDisabled
+	LOGICAL SaveMode
+	LOGICAL SavingChanges
+	CHARACTER SecurityKey
+	Consultingwerk.SmartComponents.Interfaces.ISmartDataSource SmartDataSource
+	Consultingwerk.SmartComponents.Interfaces.ISmartGroupAssignSource SmartGroupAssignSource
+	Consultingwerk.SmartComponents.Base.ListISmartGroupAssignTarget SmartGroupAssignTargets
+	Consultingwerk.SmartComponents.Interfaces.ISmartTableIOSource SmartTableIOSource
+	CHARACTER SmartTableIOState
+	Consultingwerk.SmartComponents.Interfaces.ISmartToolbarSource SmartToolbarSource
#	LOGICAL TextChangedHandlerSuspended
+	Consultingwerk.SmartComponents.Enum.UpdateStateEnum UpdateState
+	LOGICAL UseBusinessEntityDescriptor
#	LOGICAL UserControlEventsSubscribed	Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl
+	LOGICAL ValidateChildrenOnSaveChanges
+	CHARACTER ViewerLogicClass
+	Consultingwerk.SmartComponents.Interfaces.ISmartViewerLogic ViewerLogicObject

Method Detail

Top

PROTECTED ActivateCurrentGridRow ()

Purpose:	Activates the current row in the linked Grid
Notes:

Top

PUBLIC ActivateEventHandler ()

Purpose:	Activates the Event Handlers for the contained controls
Notes:

Top

PUBLIC AddRecord ()

Purpose:	Add a new record to the SmartDataSource. The Method CreateRecord of
	SmartViewerControl gets called to Handle this Task.
	This Method is called by the Toolbar Classes SmartToolbarController
	or SmartToolStripContainer by pressing the AddRecord Tool.
	Enforced by Interface ISmartDataTarget.
Notes:

Top

PUBLIC AddSmartTableIOSource (ISmartTableIOSource)

Purpose:	Adds a(nother) SmartTableIOSource to the SmartViewerControl
	instance
Notes:	Enables multiple SmartTableIOSources to the SmartViewerControl

Parameters:
poSmartTableIOSource	Consultingwerk.SmartComponents.Interfaces.ISmartTableIOSource
	The SmartTableIOSource instance to add to the list of TableIO Sources of this Control

Top

PROTECTED System.Windows.Forms.Control ApplyFocusToErrorField (character)

Purpose:	Set's focus into a field that is related to an error
Notes:	Protected method, so behavior can be customized
	Returns the focussed Control, so that visual hints may be added

Parameters:
pcFieldName	CHARACTER
	The name of the field to apply Focus to
Returns	System.Windows.Forms.Control
	The Control that the focus was applied to

Top

PROTECTED System.Windows.Forms.Control ApplyFocusToErrorField (IFieldValidationError)

Purpose:	Set's focus into a field that is related to an error
Notes:	Protected method, so behavior can be customized
	Returns the focussed Control, so that visual hints may be added

Parameters:
e	Consultingwerk.SmartComponents.Base.IFieldValidationError
	The IFieldValidationError instance that contains the information about which Control/Field to focus
Returns	System.Windows.Forms.Control
	The Control that the focus was applied to

Top

PUBLIC AttachBindingSource (BindingSource)

Purpose:	This Method attaches a new BindingSource given as the Parameter
	poBindingSource to the Objects of the current Class. The new
	BindingSource may have been created by a DataAdapter or reused from a
	SmartBrowserControl
Notes:	Enforced by Interface ISmartDataTarget.
	It is called by the SmartDataAdapter Class when creating a new
	BindingSource or when a new SmartDataSource is registered to the
	Class implementing the Interface ISmartDataTarget.
	This method is also called from the SmartViewerControl destructor (while
	a form is closed) to de-attach from the Binding Source. In this case
	the poBindingSource reference is passed in as the unknown value.

Parameters:
poBindingSource	Progress.Data.BindingSource
	The BindingSource to be attached to the Controls contained in the Viewer

Top

PUBLIC BeginInit ()

Purpose:	Invoked at the beginning of a Containers InitializeComponents
	method
Notes:	Enforced by System.ComponentModel.ISupportInitialize
	See http://msdn.microsoft.com/de-de/library/system.componentmodel.isupportinitialize.begininit(VS.80).aspx

Top

PROTECTED BeginUpdateStateHandler (Object, DataSourceUpdateStateEventArgs)

Purpose:	Event handler for the BeginUpdateState event of the data source
Notes:

Parameters:
sender	System.Object
	The reference to the object that raised this event
e	Consultingwerk.SmartComponents.Implementation.DataSourceUpdateStateEventArgs
	The DataSourceUpdateStateEventArgs instance with the data for this event

Top

PROTECTED BindingSourcePositionChanged (Object, EventArgs)

Purpose:	Event handler for the PositionChanged event of the BindingSource
	this Viewer is attached to
Notes:	Cancels the pending timer of all Lookups contained on the Viewer

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

PUBLIC CancelUpdate ()

Purpose:	Reverts the changes to the current record.
Notes:	This Method is called by the Toolbar Classes SmartToolbarController
	or SmartToolStripContainer by pressing the corresponding Tool.
	Enforced by Interface ISmartDataTarget.

Top

PUBLIC CleanupLookupControls ()

Purpose:	Destroys the Controls in the Viewer Control
Notes:

Top

PROTECTED LOGICAL ControlFocus (Control)

Purpose:	Calls the Focus() method for a .NET Control
Notes:	SCL-659 : A customer was setting the SET-WAIT-STATE("GENERAL") using
	the WaitStateManager around all TableIO Operations - with the consequence,
	that all Focus() operations on
	- error message putting focus to error field
	- FocusControlOnAdd, etc.
	were not working anymore. Seems that .NET Controls ignore the Focus()
	during the WAIT-STATE. In order to workaround those situation we have
	moved all calls to the Focus() method of Viewer Controls to the
	overridable method ControlFocus() that receives the Control reference
	as the input parameter. This overridable method can be extended by
	customers to make sure no WAIT-STATE is active anymore before the
Control:Focus()	Focus() is called.

Parameters:
poControl	System.Windows.Forms.Control
	The reference to the .NET Control that should receive Focus
Returns	LOGICAL
	Logical value indicating if the input focus request was successful

Top

PUBLIC CopyRecord ()

Purpose:	Copy the current record to a new one. The Method CreateRecord of
	SmartViewerControl gets called to Handle this Task.
	This Method is called by the Toolbar Classes SmartToolbarController
	or SmartToolStripContainer by pressing the corresponding Tool.
	Enforced by Interface ISmartDataTarget.
Notes:

Top

PROTECTED CreateRecord (logical)

Purpose:	Creates a new record in the viewer.
	This Method is called by AddRecord and CopyRecord from the current
	Class but may be overridden.
Notes:

Parameters:
plCopy	LOGICAL
	Logical value indicating if the method has been called from AddRecord or CopyRecord, FALSE = Add new record, TRUE = Copy existing record

Top

PROTECTED CreateVerbs ()

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Purpose:	Creates Designer Verbs based on the DesignerVerbs property
Notes:

Top

PROTECTED CustomInitializeControlHandler (Control)

Purpose:	Overridable method that can be used to perform custom event
	subscriptions
Notes:	Empty method, needs to be overridden in a custom viewer class

Parameters:
poControl	System.Windows.Forms.Control
	The reference to the Control

Top

PUBLIC DeactivateEventHandler ()

Purpose:	Deactivates the Event Handlers for the contained controls
Notes:

Top

PUBLIC DeleteRecord ()

Purpose:	Delete the current record.
Notes:	The Method DeleteRow of the SmartDataSource is called to perform
	this Task. This Method is called by the Toolbar Classes SmartToolbarController
	or SmartToolStripContainer by pressing the corresponding Tool.
	Enforced by Interface ISmartDataTarget.

Top

PUBLIC DeregisterSmartGroupAssignTarget (ISmartGroupAssignTarget)

Purpose:	Deregister a SmartDataTarget with the SmartGroupAssignTarget
	Enforced by Interface ISmartGroupAssignSource.
Notes:

Parameters:
poSmartGroupAssignTarget	Consultingwerk.SmartComponents.Interfaces.ISmartGroupAssignTarget
	The SmartGroupAssignTarget to deregister from this SmartViewerControl instance

Top

PUBLIC DisableFields ()

Purpose:	Disable all enabled controls of the SmartViewerControl.
	This Method is called from inside the SmartViewerControl.
	Enforced by Interface ISmartDataTarget or ISmartGroupAssignTarget.
Notes:

Top

PRIVATE DisableFields (logical)

Purpose:	Disable all enabled controls of the SmartViewerControl.
	This Method is called from inside the SmartViewerControl.
	Enforced by Interface ISmartDataTarget or ISmartGroupAssignTarget.
Notes:	Private version of Disable Fields that allows to disable fields (no
	record available and SaveMode = TRUE) without raising the event that
	the TableIOState was changed

Parameters:
plAssignTableIOState	LOGICAL
	Logical value indicating if the SmartTableIOState should be

Top

PROTECTED DisplayError (Error)

Purpose:	Display ErrorMessages shows a predefined Error Dialog and is called
	from the Method SaveChanges () of the SmartViewerControl Class.
Notes:

Parameters:
e	Progress.Lang.Error
	The error instance to visualize

Top

PROTECTED DisplayError (Error, logical)

Purpose:	Display ErrorMessages shows a predefined Error Dialog and is called
	from the Method SaveChanges () of the SmartViewerControl Class.
Notes:

Parameters:
e	Progress.Lang.Error
	The error instance to visualize
plEnsureVisible	LOGICAL
	Logical flag indicating if the viewer should ensure it's visible

Top

PROTECTED EditorDropDownAfterCloseUpHandler (Object, EventArgs)

Purpose:	Event handler for the AfterCloseUp event of an
	UltraDateTimeEditor. Clears the reference to the currently opened
	DataTime popup editor in the variable oEditorDropDownControl
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

PROTECTED EditorDropDownAfterDropDownHandler (Object, EventArgs)

Purpose:	Event handler for the AfterDropDown event of an
	UltraDateTimeEditor. Stores a reference to the currently opened
	DataTime popup editor in the variable oEditorDropDownControl
	Required to be able to start the update process in the
	method TextChangedHandler (in this class)
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

PUBLIC EnableFields (character)

Purpose:	Enables controls of the SmartViewerControl
Notes:	This Method is called by the Toolbar Classes SmartToolbarController
	or SmartToolStripContainer by pressing the Tools for Add or Edit Data.
	Enforced by Interface ISmartDataTarget or ISmartGroupAssignTarget.

Parameters:
pcFields	CHARACTER
	The EnableFieldsEnum value indicating if the fields are enabled for Add or Update

Top

PUBLIC EnableFields (character, logical)

Purpose:	Enables controls of the SmartViewerControl
Notes:	This Method is called by the Toolbar Classes SmartToolbarController
	or SmartToolStripContainer by pressing the Tools for Add or Edit Data.
	Enforced by Interface ISmartDataTarget or ISmartGroupAssignTarget.

Parameters:
pcFields	CHARACTER
	The EnableFieldsEnum value indicating if the fields are enabled for Add or Update
plEnsureVisible	LOGICAL
	Logical value indicating if the Viewer should ensure it's visible

Top

PUBLIC EndInit ()

Purpose:	Invoked at the end of a Containers InitializeComponents method
Notes:	Enforced by System.ComponentModel.ISupportInitialize
	See http://msdn.microsoft.com/de-de/library/system.componentmodel.isupportinitialize.endinit(VS.80).aspx

Top

PROTECTED EndUpdateStateHandler (Object, DataSourceUpdateStateEventArgs)

Purpose:	Event handler for the EndUpdateState event of the data source
Notes:

Parameters:
sender	System.Object
	The object that raised the EndUpdateState event
e	Consultingwerk.SmartComponents.Implementation.DataSourceUpdateStateEventArgs
	The DataSourceUpdateStateEventArgs with the data for this event

Top

PUBLIC EnsureVisible ()

Purpose:	Ensures that this SmartViewerControl is visible
Notes:

Top

PRIVATE EnterEditorControlHandler (Object, EventArgs)

Purpose:	Event handler for the Enter event of an EditorButtonControlBase
	derived Class. Selects all content from the Controls Text Property
	in the UI.
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

PUBLIC EvaluateTableIOState ()

Purpose:	This Method sets the Property SmartTableIOState to a value according
	to the SmartDataSources state of the current class. Possible values
	for SmartTableIOState are defined in the TableIOStateEnum.
Notes:	This Method is called by the SmartDataAdapter when the
	PositionChangedHandler is fired or inside the SmartViewerControl if
	a new BindingSource is attached.
	Enforced by ISmartDataTarget

Top

PROTECTED FillBoundControlTable (Control)

Purpose:	Populates the ttViewerBoundControls temp-table
Notes:	Internal method, populates records for a single control container at
	a time

Parameters:
poContainer	System.Windows.Forms.Control
	The reference to the current control container

Top

PUBLIC Progress.Data.BindingSource FindDesignTimeBindingSource ()

Purpose:	Attempts to locate the BindingSource that was used in a SmartViewerControl
	at Design Time
Notes:	This method may only be called before the SmartViewerControl:SmartDataSource
	property has been assigned a value to as the Design Time BindingSource
	will be disposed when attaching to the SmartDataSource's BindingSource
	at runtime.
	This method is helpful when building tools that may be able to query
	properties such as the EntityName and EntityTable from the Design Time
	BindingSource
	Supported from OpenEdge

Returns	Progress.Data.BindingSource
	The reference to the design time binding source or ?

Top

PUBLIC LOGICAL FocusFirstEnabledEditorControl (Control)

Purpose:	Focusses the first enabled EditorControl of the given Container
	Control
Notes:	DEFINE PRIVATE STATIC TEMP-TABLE ttTabOrder NO-UNDO
	FIELD RecordOwner AS Progress.Lang.Object
	FIELD ChildControl AS Progress.Lang.Object
	FIELD TabOrder AS INTEGER
	INDEX RecordOwner RecordOwner TabOrder .

Parameters:
poControl	System.Windows.Forms.Control
	The reference to the container control
Returns	LOGICAL
	Logical value indicating the success of this method

Top

PROTECTED FormActivatedHandler (Object, EventArgs)

Purpose:	Event handler for the Activate event of the owning Form
Notes:	Notes, this Event Handler is only subscribed to the Activate event
	of the containing Form when the Viewer's event handlers are activated,
	i.o.w the Viewer is active.

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

PROTECTED FormClosedHandler (Object, EventArgs)

Purpose:	Handles the FormClosed event of the containing Form
Notes:	Notes, this Event Handler is only subscribed to the FormClosed event
	of the containing Form when the Viewer's event handlers are activated,
	iow the Viewer is active.

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

PRIVATE FormClosedHandler2 (Object, EventArgs)

Purpose:	Handles the FormClosed event of the containing Form
Notes:	Notes, this Event Handler is always subscribed to the FormClosed event
	of the containing Form

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

PROTECTED FormDeactivatedHandler (Object, EventArgs)

Purpose:	Event handler for the Deactivate event of the owning Form
Notes:	Notes, this Event Handler is only subscribed to the Deactivated event
	of the containing Form when the Viewer's event handlers are activated,
	iow the Viewer is active.

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

PUBLIC System.Collections.Generic.List <System.ComponentModel.Component> GetAllComponents ()

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Purpose:	Returns a List of all Components in the Form
Notes:	Supported on OpenEdge 11 only, due to dependency to the ComponentsCollection
	list not available on 10.2B

Returns	System.Collections.Generic.List <System.ComponentModel.Component>
	The List of Components in the Form

Top

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

Purpose:	Returns the reference to the Control that is bound to the named field
	of the binding source
Notes:

Parameters:
pcBindingPropertyName	CHARACTER
	The name of the field in the ProBindingSource
Returns	System.Windows.Forms.Control
	The reference to the resulting Control

Top

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

Purpose:	Returns the list of Controls that is bound to the named field
	of the binding source
Notes:	Returns all Controls in the 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

PUBLIC GetBoundControlTable (table)

Purpose:	Populates a temp-table with information about all bound controls
	in the SmartViewerControl
Notes:	Also processes GroupAssignTarget Viewers

Parameters:
ttViewerBoundControls	TEMP-TABLE ttViewerBoundControls
	INPUT-OUTPUT TABLE with the data binding information, from Consultingwerk\SmartComponents\Base\ttViewerBoundControls.i

Top

PUBLIC CHARACTER GetControlEnabled (Control)

Purpose:	Returns the Enable mode for a Control from the list of Controls that will be enabled
	and disabled by the Viewer based on the current Viewer state

Parameters:
poControl	System.Windows.Forms.Control
	The Control for which the Enable mode should be returned
Returns	CHARACTER
	The CHARACTER value representing the Control Enabled mode

Top

PUBLIC CHARACTER GetControlSecurityEnabled (Control)

Purpose:	Returns the security Enable mode for a Control from the list of Controls
	that will be enabled and disabled by the Viewer based on the current Viewer
	state

Parameters:
poControl	System.Windows.Forms.Control
	The Control for which the Enable mode should be returned
Returns	CHARACTER
	The CHARACTER value representing the security Control Enabled mode

Top

PUBLIC HANDLE GetScreenValuesDataset ()

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)

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 System.Windows.Forms.Control GetViewerField (character, Control)

Purpose:	Recursively searches for the Control with the given name
Notes:	This Method is called by the Method GetViewerField (pcControlName AS CHARACTER)
	of the SmartViewerControl Class.

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

Top

PROTECTED Consultingwerk.SmartComponents.Interfaces.ISmartGroupAssignTarget GetViewerForBoundControl (character)

Purpose:	Returns the reference to the SmartGroupAssignTarget that contains
	a Control bound to the given field name
Notes:

Parameters:
pcFieldName	CHARACTER
	The name of the field
Returns	Consultingwerk.SmartComponents.Interfaces.ISmartGroupAssignTarget
	The reference to the SmartGroupAssignTarget that contains a Control bound to the given field name

Top

PROTECTED GroupAssignSmartTableIOStateChangedHandler (Object, SmartTableIOStateChangedEventArgs)

Purpose:	Event handler for the SmartTableIOStateChanged event of the
	Group assign Source
Notes:

Parameters:
sender	System.Object
	The reference to the object that raised the event
e	Consultingwerk.SmartComponents.Base.SmartTableIOStateChangedEventArgs
	The SmartTableIOStateChangedEventArgs with the data for this event

Top

PROTECTED HandleServerEvent (Object, EventArgs, character)

Purpose:	Event handler for a server-side event
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
pcEventName	CHARACTER
	The name of the event

Top

PROTECTED HandleServerEvent (Object, EventArgs, character, character)

Purpose:	Event handler for a server-side event
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
pcEventName	CHARACTER
	The name of the event
pcEventContext	CHARACTER
	The context for the event

Top

PUBLIC HandleUiControl (UiControl, handle)

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

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

Top

PUBLIC HandleValidationError (Error)

Purpose:	Handles an error raised by validation routines
Notes:	Displays the Error message and focusses the field that caused the error

Parameters:
poError	Progress.Lang.Error
	The reference to the validation error instance

Top

PUBLIC LOGICAL HasBoundControl (character, logical)

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

Parameters:
pcBindingPropertyName	CHARACTER
	The name of the field in the ProBindingSource
plIncludeGroupAssignTargets	LOGICAL
	Logical value indicating if the method should also look in GroupAssign Target Viewers
Returns	LOGICAL
	Logical value indicating if a bound control exists

Top

PROTECTED InitializeControlEventHandler ()

Purpose:	Subscribe the EventHandler(s) to events of all controls added to
	the SmartViewerControl. The RecurseInitializeControlEventHandler is
	used to Handle this Task.
	This Method is called every Time a new Control is added to the
	SmartViewerControl.
Notes:

Top

PROTECTED InitializeViewerLogicObject ()

Purpose:	Initializes the Viewer Logic Object
Notes:	The SmartViewerControl will initialize the ViewerLogicClass during
	EndInit when the property ViewerLogicClass is set and the Viewer
	does not have a SmartGroupAssignSource
	The Viewer Logic Object will also not initialized when the ViewerLogicObject
	instance is already set
	Registers the ViewerLogicObject also for the SmartGroupAssignTargets

Top

PUBLIC InitializeViewerUiControlHandler ()

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 LOGICAL IsControlEnabled (character, character, logical)

Purpose:	Determines if a Control should be enabled based on the SecurityEnableMode
	and EnableMode
Notes:

Parameters:
pcSecurityEnableMode	CHARACTER
	The security enable mode of the current control
pcEnableMode	CHARACTER
	The enable mode of the current control
plAdd	LOGICAL
	Logical value indicating if the viewer is in Add (true) or Update (false) mode
Returns	LOGICAL
	Logical value indicating if the control is supposed to be enabled or not

Top

PUBLIC LOGICAL IsEditorControl (Control)

Purpose:	Returns TRUE is the Controls is recognized as an Editor Control
Notes:	That is a Control the user normally enters Text

Parameters:
poControl	System.Windows.Forms.Control
	The reference to the Control to test
Returns	LOGICAL
	Logical value indicating if the Control is a known Editor Control

Top

PUBLIC LOGICAL IsOkToClose (logical, CloseReason)

Purpose:	Check if it is ok to close the parent form.
	Returns TRUE when the form can be closed. Otherwise returns FALSE.
	Enforced by the Interface ICheckOkToClose.
Notes:

Parameters:
plShowMessage	LOGICAL
	When TRUE a message is Shown explaining why it is not ok to close the parent form
poCloseReason	System.Windows.Forms.CloseReason
	The System.Windows.Forms.CloseReason passed from then OnFormClosing Method of the parent form giving the reason why the form is closed
Returns	LOGICAL
	Logical value indicating if the parent Form may be closed

Top

PROTECTED LOGICAL IsValueChanged (Object)

Purpose:	Returns if the current (screen-value) of a Control in the SmartViewerControl
	derived class has changed in comparison to the underlying buffer value
Notes:	Currently compares based on Value, Text, CheckedState or LookupKeyValue
	bound values

Parameters:
poControl	System.Object
	The reference to the Control (type is System.Object for convenience of passing in the sender of a .NET event handler)
Returns	LOGICAL
	Logical value indicating if the current value has changed

Top

PROTECTED LeaveHandler (Object, EventArgs)

Purpose:	Event handler for the Leave event
Notes:	No longer overriding the OnLeave method as that cause unhandled
	.NET Exceptions when in update mode and the containing Form was closed

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

PROTECTED OnAddedRecordModifiedChanged (EventArgs)

Purpose:	Raises the AddedRecordModifiedChanged
Notes:

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

Top

PROTECTED OnAddingRecordChanged (EventArgs)

Purpose:	Raises the AddingRecordChanged event
Notes:

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

Top

PROTECTED OnAfterAddRecord (EventArgs)

Purpose:	Raises the AfterAddRecord event
Notes:

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

Top

PROTECTED OnAfterCancelledUpdate (AfterCancelledUpdateEventArgs)

Purpose:	Raises the AfterCancelledUpdate event
Notes:

Parameters:
e	Consultingwerk.SmartComponents.Base.AfterCancelledUpdateEventArgs
	The AfterCancelledUpdateEventArgs with the data for this event

Top

PROTECTED OnAfterCancelUpdate (EventArgs)

Purpose:	Raises the AfterCancelUpdate event
Notes:

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

Top

PROTECTED OnAfterCopyRecord (EventArgs)

Purpose:	Raises the AfterCopyRecord event
Notes:

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

Top

PROTECTED OnAfterDeleteRecord (EventArgs)

Purpose:	Raises the AfterDeleteRecord event
Notes:

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

Top

PROTECTED OnAfterFieldsEnabled (EventArgs)

Purpose:	Raises the AfterFieldsEnabled
Notes:

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

Top

PROTECTED OnAfterSaveChanges (EventArgs)

Purpose:	Raises the AfterSaveChanges event
Notes:

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

Top

PROTECTED OnBeforeAddRecord (CancelEventArgs)

Purpose:	Raises the BeforeAddRecord event
Notes:

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

Top

PROTECTED OnBeforeCancelUpdate (CancelEventArgs)

Purpose:	Raises the BeforeCancelUpdate event
Notes:

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

Top

PROTECTED OnBeforeCopyRecord (CancelEventArgs)

Purpose:	Raises the BeforeCopyRecord event
Notes:

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

Top

PROTECTED OnBeforeDeleteRecord (CancelEventArgs)

Purpose:	Raises the BeforeDeleteRecord event
Notes:

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

Top

PROTECTED OnBeforeEnableFields (CancelableEventArgs)

Purpose:	Raises the BeforeEnableFields
Notes:

Parameters:
e	Consultingwerk.CancelableEventArgs
	The CancelableEventArgs with the data for the event

Top

PROTECTED OnBeforeSaveChanges (CancelEventArgs)

Purpose:	Raises the BeforeSaveChanges event
Notes:

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

Top

PROTECTED OnCopyingRecordChanged (EventArgs)

Purpose:	Raises the CopyingRecordChanged event
Notes:

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

Top

PROTECTED OnCurrentChanged (EventArgs)

Purpose:	Raises the CurrentChanged event
Notes:

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

Top

PROTECTED OnEnter (EventArgs)

Purpose:	Raises the Enter event
Notes:

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

Top

PROTECTED OnFieldsDisabled (EventArgs)

Purpose:	Raises the FieldsDisabled event.
Notes:

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

Top

PROTECTED OnFieldsEnabled (EventArgs)

Purpose:	Raises the FieldsEnabled event.
Notes:

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

Top

PROTECTED OnFocusControlOnAddChanged (EventArgs)

Purpose:	Raises the FocusControlOnAddChanged event
Notes:

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

Top

PROTECTED OnFocusControlOnUpdateChanged (EventArgs)

Purpose:	Raises the FocusControlOnUpdateChanged event
Notes:

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

Top

PROTECTED OnGenericEvent (EventArgs)

Purpose:	Raises the GenericEvent
Notes:

Parameters:
e	Consultingwerk.EventArgs
	The Consultingwerk.EventArgs with the data for the event

Top

PROTECTED OnInitializingChanged (EventArgs)

Purpose:	Raises the InitializingChanged event
Notes:

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

Top

PROTECTED OnLoad (EventArgs)

Overrides Consultingwerk.SmartComponents.Base.SmartUserControl:OnLoad (EventArgs)

Purpose:	Raises the Load event
Notes:	Initializes the ViewerLogic class if property is set

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

Top

PROTECTED OnSmartDataSourceChanged (EventArgs)

Purpose:	Publishes the SmartDataSourceChanged event
Notes:

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

Top

PROTECTED OnSmartGroupAssignSourceChanged (EventArgs)

Purpose:	Publishes the SmartGroupAssignSourceChanged event
Notes:

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

Top

PROTECTED OnSmartTableIOSourceChanged (EventArgs)

Purpose:	Publishes the SmartGroupAssignSourceChanged event
Notes:

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

Top

PROTECTED OnSmartTableIOStateChanged (SmartTableIOStateChangedEventArgs)

Purpose:	Publishes the SmartTableIOStateChanged event
Notes:

Parameters:
e	Consultingwerk.SmartComponents.Base.SmartTableIOStateChangedEventArgs
	The System.EventArgs with the data for this event

Top

PUBLIC OnVerbClicked (character)

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Purpose:	Event Handler method for Designer Verbs
Notes:	This method is intended to be overridden

Parameters:
pcDesignerVerb	CHARACTER
	The name (Label) of the Designer Verb that was invoked

Top

PROTECTED OnVisualValidating (EventArgs)

Purpose:	Raises the VisualValidating event
Notes:

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

Top

PROTECTED ParentChangedHandler (Object, EventArgs)

Purpose:	Event handler to the ParentChanged event
	Add EventHandlers to Child Controls inside the SmartViewerControl.
	This Method is Executed when the SmartViewerControl is added to a Form.
Notes:	Executed only one time.

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

PROTECTED ParentFormDestroyedHandler (Object, EventArgs)

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Purpose:	Event handler for the FormDestroyed event of the owning Form
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

PUBLIC ProcessHiddenControls ()

Purpose:	Processes the registered hidden controls
Notes:	Intended to make them Visible = FALSE after DataBinding has been initialized

Top

PUBLIC RaiseGenericEvent (EventArgs)

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. This method is package-protected
	as it's only meant to be used from the SmartViewerLogic class

Parameters:
e	Consultingwerk.EventArgs
	The Consultingwerk.EventArgs

Top

PUBLIC LOGICAL RaiseToolbarAction (Object, ToolClickEventArgs, character)

Purpose:	Executes a Toolbar Action
Notes:

Parameters:
sender	System.Object
	The reference to the control that raised the ToolClick event
e	Infragistics.Win.UltraWinToolbars.ToolClickEventArgs
	The ToolClickEventArgs with the data for the ToolClick event
pcToolbarAction	CHARACTER
	The name of the method to execute
Returns	LOGICAL
	Logical value indicating if the action was executed

Top

PROTECTED RecurseInitializeControlEventHandler (Control)

Purpose:	Subscribe the EventHandler(s) to events of all controls added to
	the SmartViewerControl.
	This Method is called by the Method InitializeControlEventHandler ()
	of the SmartViewerControl.
Notes:

Parameters:
poParentControl	System.Windows.Forms.Control
	The The Parent Control (THIS-OBJECT), nested Container

Top

PROTECTED System.Windows.Forms.Control RecurseLocateBindingControl (Control, character)

Purpose:	Recurses through the Controls in this SmartViewerControl and nested
	controls searching for a Control that is bound to the named
	BindingProperty (a field attached to the ProBindingSource).
Notes:

Parameters:
poParentControl	System.Windows.Forms.Control
	The reference to the ParentControl
pcBindingPropertyName	CHARACTER
	The name of the field in the ProBindingSource
Returns	System.Windows.Forms.Control
	The reference to the resulting Control

Top

PROTECTED RecurseLocateBindingControls (Control, Control>, character)

Purpose:	Recurses through the Controls in this SmartViewerControl and nested
	controls searching for all Controls that are bound to the named
	BindingProperty (a field attached to the ProBindingSource).
Notes:	The controls will be added to the list

Parameters:
poParentControl	System.Windows.Forms.Control
	The reference to the ParentControl
poList	System.Collections.Generic.List
	The list to add the control references to
pcBindingPropertyName	CHARACTER
	The name of the field in the ProBindingSource

Top

PROTECTED RecurseLookupStopTimer (Control)

Purpose:	Stops the current timer of all Lookups
Notes:	Invoked when a PositionChanged event occurs

Parameters:
poParentControl	System.Windows.Forms.Control
	The parent Control of the current iteration

Top

PROTECTED RecursePerformLookup (Control)

Purpose:	Performs the Lookup operation in all contained SmartLookup Controls
Notes:	Called at the begin of a Save operations

Parameters:
poParentControl	System.Windows.Forms.Control
	The parent Control for the current iteration

Top

PROTECTED RecurseReplaceBindingSource (Control, BindingSource)

Purpose:	Internal method to replace the data bindings of all contained
	Controls with the actual binding source provided by a SmartDataSource.
Notes:	Initially called by the Method AttachBindingSource () of the
	SmartViewerControl.
	This method also applies field security from the IFieldAuthorizationProvider
	implementation. When a Control is hidden, the label is also hidden. The
	Label for a Control is located using the GetNextControl method of the
	parent control, thus it's required that the label is standing exactly
	before the Control in the Tab-Order of the Viewer.

Parameters:
poParentControl	System.Windows.Forms.Control
	Current Container to perform Action on
poBindingSource	Progress.Data.BindingSource
	New BindingSource Instance passed to the Class

Top

PROTECTED RecurseRestoreCurrentValues (Control)

Purpose:	Recurse Restore the Current Values of the Controls on the Viewer
	after a new DataRow is created.
	This Method is called by the internal Method RestoreValuesForCopy ().
Parameters:
Notes:

Parameters:
poParentControl	System.Windows.Forms.Control
	The parent control of the current iteration

Top

PROTECTED RecurseStoreCurrentValues (Control)

Purpose:	Recurse Store the Current Values of the Controls on the Viewer
	before a new DataRow is created.
	This Method is called by the internal Method StoreValuesForCopy ().
Notes:

Parameters:
poParentControl	System.Windows.Forms.Control
	The parent Control of the current iteration

Top

PUBLIC RegisterHiddenControl (Control)

Purpose:	Register a hidden control
Notes:	Hidden Controls are rendered Visible but Hidden at the end of the Viewer's
	OnLoad method - to allow data-binding to be initialized

Parameters:
poControl	System.Windows.Forms.Control
	The Control to register as hidden

Top

PROTECTED RegisterServerSideEventHandler (Control, character, character)

Purpose:	Subscribes a Control to a server-side event handler
Notes:	Method in a Business Task

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 RegisterSmartGroupAssignTarget (ISmartGroupAssignTarget)

Purpose:	Register a SmartDataTarget with the SmartGroupAssignTarget
	This Method is executed every time a new SmartGroupAssignSource is
	registered to the corresponding Property of a Class implementing the
	Interface ISmartGroupAssignSource.
	Enforced by Interface ISmartGroupAssignSource.
Notes:

Parameters:
poSmartGroupAssignTarget	Consultingwerk.SmartComponents.Interfaces.ISmartGroupAssignTarget
	The SmartGroupAssignTarget to register with this SmartViewerControl instance

Top

PROTECTED RemoveControlEnabled (Control)

Purpose:	Removes a Control from the list of Controls that will be enabled
	and disabled by the Viewer based on the current Viewer state

Parameters:
poControl	System.Windows.Forms.Control
	The Control which shall be removed from the list of managed Controls

Top

PROTECTED RemoveControlEnabled (Control, Control)

Purpose:	Removes multiple Controls from the list of Controls that will be enabled
	and disabled by the Viewer based on the current Viewer state

Parameters:
poControl1	System.Windows.Forms.Control
	The first Control which shall be removed from the list of managed Controls
poControl2	System.Windows.Forms.Control
	The second Control which shall be removed from the list of managed Controls

Top

PROTECTED RemoveControlEnabled (Control, Control, Control)

Purpose:	Removes multiple Controls from the list of Controls that will be enabled
	and disabled by the Viewer based on the current Viewer state

Parameters:
poControl1	System.Windows.Forms.Control
	The first Control which shall be removed from the list of managed Controls
poControl2	System.Windows.Forms.Control
	The second Control which shall be removed from the list of managed Controls
poControl3	System.Windows.Forms.Control
	The third Control which shall be removed from the list of managed Controls

Top

PROTECTED RemoveControlEnabled (Control, Control, Control, Control)

Purpose:	Removes multiple Controls from the list of Controls that will be enabled
	and disabled by the Viewer based on the current Viewer state

Parameters:
poControl1	System.Windows.Forms.Control
	The first Control which shall be removed from the list of managed Controls
poControl2	System.Windows.Forms.Control
	The second Control which shall be removed from the list of managed Controls
poControl3	System.Windows.Forms.Control
	The third Control which shall be removed from the list of managed Controls
poControl4	System.Windows.Forms.Control
	The fourth Control which shall be removed from the list of managed Controls

Top

PROTECTED RemoveControlEnabled (Control, Control, Control, Control, Control)

Purpose:	Removes multiple Controls from the list of Controls that will be enabled
	and disabled by the Viewer based on the current Viewer state

Parameters:
poControl1	System.Windows.Forms.Control
	The first Control which shall be removed from the list of managed Controls
poControl2	System.Windows.Forms.Control
	The second Control which shall be removed from the list of managed Controls
poControl3	System.Windows.Forms.Control
	The third Control which shall be removed from the list of managed Controls
poControl4	System.Windows.Forms.Control
	The fourth Control which shall be removed from the list of managed Controls
poControl5	System.Windows.Forms.Control
	The fifth Control which shall be removed from the list of managed Controls

Top

PUBLIC RemoveSmartTableIOSource (ISmartTableIOSource)

Purpose:	Removes a SmartTableIOSource from the SmartDataAdapter
	instance
Notes:	Enables multiple SmartTableIOSource to the SmartDataAdapter.

Parameters:
poSmartTableIOSource	Consultingwerk.SmartComponents.Interfaces.ISmartTableIOSource
	The SmartTableIOSource to remove from the Viewer

Top

PUBLIC ResetViewerState (logical)

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

Parameters:
plLoadEvent	LOGICAL
	Logical value indicating if we're called from the Load event

Top

PUBLIC RestoreValuesForCopy ()

Purpose:	Restore the Current Values of all Controls on a SmartViewerControl
	and in all SmartGroupAssignTargets.
	This Method is called by CreateRecord from the current Class.
	Enforced by Interface ISmartGroupAssignTarget.
Notes:

Top

PUBLIC SaveChanges ()

Purpose:	Saves the current changes to the database.
Notes:	This Method is called by the Toolbar Classes SmartToolbarController
	or SmartToolStripContainer by pressing the corresponding Tool.
	Enforced by Interface ISmartDataTarget or ISmartGroupAssignTarget.

Top

PUBLIC LOGICAL SaveChangesOnDeactivateForm (logical)

Purpose:	Saves pending changes when a Form is deactivated
Notes:

Parameters:
plShowMessage	LOGICAL
	When TRUE a message is asking the user if values should be saved. When FALSE values will be saved silently
Returns	LOGICAL
	True when the user did choose not to save or the save was successful, False when the control remains in Update state

Top

PRIVATE ServerSideAfterPerformLookupHandler (Object, EventArgs)

Purpose:	Event handler for AfterPerformLookup event
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

PRIVATE ServerSideClickHandler (Object, EventArgs)

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

PUBLIC ServerSideCurrentChangedHandler (Object, EventArgs)

Purpose:	Event handler for CurrentChanged event
Notes:	Public so that the SmartViewerUiControlHandler can call into this method

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

PRIVATE ServerSideLeaveHandler (Object, EventArgs)

Purpose:	Event handler for Leave event
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

PRIVATE ServerSideLoadHandler (Object, EventArgs)

Purpose:	Event handler for Load event
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

PRIVATE ServerSideLookupCompleteHandler (Object, EventArgs)

Purpose:	Event handler for LookupComplete event
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

PRIVATE ServerSideLookupKeyValueChangedHandler (Object, EventArgs)

Purpose:	Event handler for LookupKeyValueChanged event
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

PRIVATE ServerSideValidatingHandler (Object, EventArgs)

Purpose:	Event handler for Validating event
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

PRIVATE ServerSideValueChangedHandler (Object, EventArgs)

Purpose:	Event handler for ValueChanged event
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

PUBLIC SetControlEnabled (character, character)

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)

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	System.Windows.Forms.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)

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	System.Windows.Forms.Control
	The first Control which shall be set to the passed in Mode
poControl2	System.Windows.Forms.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)

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	System.Windows.Forms.Control
	The first Control which shall be set to the passed in Mode
poControl2	System.Windows.Forms.Control
	The second Control which shall be set to the passed in Mode
poControl3	System.Windows.Forms.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)

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	System.Windows.Forms.Control
	The first Control which shall be set to the passed in Mode
poControl2	System.Windows.Forms.Control
	The second Control which shall be set to the passed in Mode
poControl3	System.Windows.Forms.Control
	The third Control which shall be set to the passed in Mode
poControl4	System.Windows.Forms.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)

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	System.Windows.Forms.Control
	The first Control which shall be set to the passed in Mode
poControl2	System.Windows.Forms.Control
	The second Control which shall be set to the passed in Mode
poControl3	System.Windows.Forms.Control
	The third Control which shall be set to the passed in Mode
poControl4	System.Windows.Forms.Control
	The forth Control which shall be set to the passed in Mode
poControl5	System.Windows.Forms.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)

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	System.Windows.Forms.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

PROTECTED SetControlEnabledFromDescriptor ()

Purpose:	Sets the ControlEnabled property of the visual controls
	based on the Business Entity Descriptor
Notes:

Top

PRIVATE SetControlSecurityEnabled (Control, character)

Purpose:	Sets the Enable Mode based on Security Constraints for a given Control
Notes:	Possible Values for pcEnabled (ControlEnabledEnum):
	Add, Always, Never, Update, UpdateOnly

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

Top

PUBLIC SetModifyingState ()

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

Top

PUBLIC SetOpenedEditorDropDownControl (Control)

Purpose:	Set's the current opened EditorDropDownControl
Notes:	See Bug 1878 for details

Parameters:
poControl	System.Windows.Forms.Control
	The reference to the Control that currently has the list dropped down

Top

PUBLIC StoreValuesForCopy ()

Purpose:	Store the Current Values of all Controls on a SmartViewerControl
	and do the same in all SmartGroupAssignTargets.
	This Method is called by CreateRecord from the current Class.
	Enforced by Interface ISmartGroupAssignTarget.
Notes:

Top

PUBLIC SubscribeControlEventHandler (Control, character, character)

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 SubscribeParentFormDestroyed ()

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Purpose:	Subscribes the ParentFormDestroyed event
Notes:

Top

PROTECTED SubscribeUserControlEvents ()

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Purpose:	Allows for custom event subscriptions during OnLoad()
Notes:	Intended to be overridden in the inheriting user control

Top

PUBLIC TextChangedEventHandler (Object, EventArgs)

Purpose:	Event handler for the TextChangedEvent event of Editor Controls on
	the SmartViewerControl.
	Initiate switching to the ModifyingData Mode if the user enters data.
Notes:	This Method is executed every time data changes in the EditorControls
	of a SmartViewerControl.
	Enforced by Interface ISmartGroupAssignSource.

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

PRIVATE ViewerDataSourceCurrentChangedHandler (Object, EventArgs)

Purpose:	Event handler for the CurrentChanged event of the data source
	this Viewer is attached to
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

PUBLIC VisualValidate ()

Purpose:	Validate data entered into the DataFields
Notes:	This is a placeholder that can be overridden in a viewer control
	inheriting from SmartViewerControl
	Due to limitations with the .NET Visual Designer environment, this
	method cannot be market ABSTRACT

Top

PUBLIC Consultingwerk.Windows.LegacyGuiMigration.Widgets.IWidgetFacade WidgetHandle (character)

Purpose:	Returns the WidgetFacade for the given widget
Notes:

Parameters:
pcName	CHARACTER
	The name of the widget to return the name for
Returns	Consultingwerk.Windows.LegacyGuiMigration.Widgets.IWidgetFacade
	The IWidgetFacade reference or ? when the widget cannot be located

Constructor Detail

Top

PUBLIC SmartViewerControl ()

Purpose:	The Constructor initializes a new SmartViewerControl
	Subscribes handlers for events
Notes:

Event Detail

Top

PUBLIC AddedRecordModifiedChanged DELEGATE System.EventHandler

Purpose:	Raised when the value of the AddedRecordModified property changes
Notes:

Delegate: System.EventHandler

Top

PUBLIC AddingRecordChanged DELEGATE System.EventHandler

Purpose:	Event fired when the AddingRecord Property is changed
Notes:

Delegate: System.EventHandler

Top

PUBLIC AfterAddRecord DELEGATE System.EventHandler

Purpose:	Event fired when the viewer has successfully started an Add
	operation
Notes:	This event is defined using a .NET delegate, so it will show in
	the PropertyGrid of the VisualDesigner

Delegate: System.EventHandler

Top

PUBLIC AfterCancelledUpdate (Object, AfterCancelledUpdateEventArgs)

Purpose:	Event fired when the viewer has successfully cancelled an update
Notes:	This event is defined using a .NET delegate, so it will show in
	the PropertyGrid of the VisualDesigner
	This event fires after the AfterCancelUpdate has fired and all update
	status is reset

Parameters:
sender	System.Object
	The reference to the control that raised the event
e	Consultingwerk.SmartComponents.Base.AfterCancelledUpdateEventArgs
	The AfterCancelledUpdateEventArgs with the data for this event

Top

PUBLIC AfterCancelUpdate DELEGATE System.EventHandler

Purpose:	Event fired when the viewer has successfully cancelled an update
Notes:	This event is defined using a .NET delegate, so it will show in
	the PropertyGrid of the VisualDesigner

Delegate: System.EventHandler

Top

PUBLIC AfterCopyRecord DELEGATE System.EventHandler

Purpose:	Event fired when the viewer has successfully started a Copy operation
Notes:	This event is defined using a .NET delegate, so it will show in
	the PropertyGrid of the VisualDesigner

Delegate: System.EventHandler

Top

PUBLIC AfterDeleteRecord DELEGATE System.EventHandler

Purpose:	Event fired when the viewer has successfully deleted a record.
Notes:	This event is defined using a .NET delegate, so it will show in
	the PropertyGrid of the VisualDesigner

Delegate: System.EventHandler

Top

PUBLIC AfterFieldsEnabled DELEGATE System.EventHandler

Purpose:	Raised after the fields have been enabled
Notes:

Delegate: System.EventHandler

Top

PUBLIC AfterSaveChanges DELEGATE System.EventHandler

Purpose:	Event fired when the viewer has successfully saved changes
Notes:	This event is defined using a .NET delegate, so it will show in
	the PropertyGrid of the VisualDesigner

Delegate: System.EventHandler

Top

PUBLIC BeforeAddRecord DELEGATE System.ComponentModel.CancelEventHandler

Purpose:	Event fired when the Viewer starts adding a new record.
	This event is cancelable
Notes:	This event is defined using a .NET delegate, so it will show in
	the PropertyGrid of the VisualDesigner

Delegate: System.ComponentModel.CancelEventHandler

Top

PUBLIC BeforeCancelUpdate DELEGATE System.ComponentModel.CancelEventHandler

Purpose:	Event fired when the Viewer begins cancelling an update.
	This event is cancellable
Notes:	This event is defined using a .NET delegate, so it will show in
	the PropertyGrid of the VisualDesigner

Delegate: System.ComponentModel.CancelEventHandler

Top

PUBLIC BeforeCopyRecord DELEGATE System.ComponentModel.CancelEventHandler

Purpose:	Event fired when the Viewer begins copying a record.
	This event is cancellable
Notes:	This event is defined using a .NET delegate, so it will show in
	the PropertyGrid of the VisualDesigner

Delegate: System.ComponentModel.CancelEventHandler

Top

PUBLIC BeforeDeleteRecord DELEGATE System.ComponentModel.CancelEventHandler

Purpose:	Event fired when the Viewer starts deleting a record.
	This event is cancellable
Notes:	This event is defined using a .NET delegate, so it will show in
	the PropertyGrid of the VisualDesigner

Delegate: System.ComponentModel.CancelEventHandler

Top

PUBLIC BeforeEnableFields (Object, CancelableEventArgs)

Purpose:	Raised before the fields are enabled
Notes:

Parameters:
sender	Progress.Lang.Object
	The object that raised the BeforeEnableFields event
e	Consultingwerk.CancelableEventArgs
	The CancelableEventArgs with the data for the event

Top

PUBLIC BeforeSaveChanges DELEGATE System.ComponentModel.CancelEventHandler

Purpose:	Event fired when the Viewer starts saving a record.
	This event is cancellable
Notes:	This event is defined using a .NET delegate, so it will show in
	the PropertyGrid of the VisualDesigner

Delegate: System.ComponentModel.CancelEventHandler

Top

PUBLIC CopyingRecordChanged DELEGATE System.EventHandler

Purpose:	Raised when the CopyingRecord property has changed
Notes:

Delegate: System.EventHandler

Top

PUBLIC CurrentChanged DELEGATE System.EventHandler

Purpose:	Event fired when the current record changes
Notes:	This event is defined using a .NET delegate, so it will show in
	the PropertyGrid of the VisualDesigner

Delegate: System.EventHandler

Top

PUBLIC FieldsDisabled DELEGATE System.EventHandler

Purpose:	Event fired when the fields of this viewer become disabled
Notes:	This event is defined using a .NET delegate, so it will show in
	the PropertyGrid of the VisualDesigner

Delegate: System.EventHandler

Top

PUBLIC FieldsEnabled DELEGATE System.EventHandler

Purpose:	Event fired when the fields of this viewer become enabled
Notes:	This event is defined using a .NET delegate, so it will show in
	the PropertyGrid of the VisualDesigner

Delegate: System.EventHandler

Top

PUBLIC FocusControlOnAddChanged DELEGATE System.EventHandler

Purpose:	Event fired when the FocusControlOnAdd property changes
Notes:

Delegate: System.EventHandler

Top

PUBLIC FocusControlOnUpdateChanged DELEGATE System.EventHandler

Purpose:	Event fired when the FocusControlOnUpdate property changes
Notes:

Delegate: System.EventHandler

Top

PUBLIC GenericEvent (Object, EventArgs)

Purpose:	Raised from custom logic
Notes:	Support raising an event from a viewer logic class

Parameters:
sender	Progress.Lang.Object
	The object that raised the GenericEvent event
e	Consultingwerk.EventArgs
	The Consultingwerk.EventArgs with the data for the event

Top

PUBLIC InitializingChanged DELEGATE System.EventHandler

Purpose:	Event fired when the Initializing property changes
Notes:

Delegate: System.EventHandler

Top

PUBLIC SmartDataSourceChanged DELEGATE System.EventHandler

Purpose:	Event fired when the SmartDataSource Property is changed
Notes:

Delegate: System.EventHandler

Top

PUBLIC SmartGroupAssignSourceChanged DELEGATE System.EventHandler

Purpose:	Event fired when the SmartGroupAssignSource Property is changed
Notes:

Delegate: System.EventHandler

Top

PUBLIC SmartTableIOSourceChanged DELEGATE System.EventHandler

Purpose:	Event fired when the SmartTableIOSource Property is changed
Notes:

Delegate: System.EventHandler

Top

PUBLIC SmartTableIOStateChanged (Object, SmartTableIOStateChangedEventArgs)

Purpose:	Event fired whenever the SmartTableIOState property has changed
Notes:

Parameters:
sender	System.Object
	The object that raised the event
e	Consultingwerk.SmartComponents.Base.SmartTableIOStateChangedEventArgs
	The SmartTableIOStateChangedEventArgs with the data for this event

Top

PUBLIC VisualValidating DELEGATE System.EventHandler

Purpose:	Raised when the Viewer performs Visual Validation
Notes:	May be used by Subscribers to current screen values before validation

Delegate: System.EventHandler

Property Detail

Top

PUBLIC LOGICAL ActivateCurrentGridRowDuringEdit

Returns	LOGICAL

Top

PUBLIC LOGICAL AddedRecordModified

Returns	LOGICAL

Top

PUBLIC LOGICAL AddingRecord

Returns	LOGICAL

Top

PUBLIC LOGICAL AllowCloseOfUnmodifiedNewRecord

Returns	LOGICAL

Top

PUBLIC LOGICAL CancellingUpdate

Returns	LOGICAL

Top

PUBLIC LOGICAL CopyingRecord

Returns	LOGICAL

Top

PROTECTED CHARACTER DesignerVerbs

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns	CHARACTER

Top

PUBLIC LOGICAL DesignTime

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns	LOGICAL

Top

PUBLIC LOGICAL DisallowUpdateDuringAnotherUpdate

Returns	LOGICAL

Top

PUBLIC LOGICAL DisallowUpdateDuringAnotherUpdateDefault

Returns	LOGICAL

Top

PUBLIC LOGICAL EventHandlerActive

Returns	LOGICAL

Top

PUBLIC System.Windows.Forms.Control FocusControlOnAdd

Returns	System.Windows.Forms.Control

Top

PUBLIC System.Windows.Forms.Control FocusControlOnUpdate

Returns	System.Windows.Forms.Control

Top

PROTECTED CHARACTER HiddenProperties

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns	CHARACTER

Top

PUBLIC LOGICAL Initializing

Returns	LOGICAL

Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataSource LinkDataSource

Returns	Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataSource

Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.Design.IDesignGroupAssignSource LinkGroupAssignSource

Returns	Consultingwerk.SmartComponents.Interfaces.Design.IDesignGroupAssignSource

Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.Design.IDesignTableIOSource LinkTableIOSource

Returns	Consultingwerk.SmartComponents.Interfaces.Design.IDesignTableIOSource

Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.Design.IDesignToolbarSource LinkToolbarSource

Returns	Consultingwerk.SmartComponents.Interfaces.Design.IDesignToolbarSource

Top

PROTECTED CHARACTER NonBrowsableProperties

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns	CHARACTER

Top

PROTECTED Consultingwerk.SmartComponents.Base.SmartViewerOptionalFeatures OptionalFeatures

Returns	Consultingwerk.SmartComponents.Base.SmartViewerOptionalFeatures

Top

PROTECTED LOGICAL ParentFormDestroyedSubscribed

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns	LOGICAL

Top

PUBLIC LOGICAL ReadOnlyDisabled

Returns	LOGICAL

Top

PUBLIC LOGICAL SaveMode

Returns	LOGICAL

Top

PUBLIC LOGICAL SavingChanges

Returns	LOGICAL

Top

PUBLIC CHARACTER SecurityKey

Returns	CHARACTER

Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.ISmartDataSource SmartDataSource

Returns	Consultingwerk.SmartComponents.Interfaces.ISmartDataSource

Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.ISmartGroupAssignSource SmartGroupAssignSource

Returns	Consultingwerk.SmartComponents.Interfaces.ISmartGroupAssignSource

Top

PUBLIC Consultingwerk.SmartComponents.Base.ListISmartGroupAssignTarget SmartGroupAssignTargets

Returns	Consultingwerk.SmartComponents.Base.ListISmartGroupAssignTarget

Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.ISmartTableIOSource SmartTableIOSource

Returns	Consultingwerk.SmartComponents.Interfaces.ISmartTableIOSource

Top

PUBLIC CHARACTER SmartTableIOState

Returns	CHARACTER

Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.ISmartToolbarSource SmartToolbarSource

Returns	Consultingwerk.SmartComponents.Interfaces.ISmartToolbarSource

Top

PROTECTED LOGICAL TextChangedHandlerSuspended

Returns	LOGICAL

Top

PUBLIC Consultingwerk.SmartComponents.Enum.UpdateStateEnum UpdateState

Returns	Consultingwerk.SmartComponents.Enum.UpdateStateEnum

Top

PUBLIC LOGICAL UseBusinessEntityDescriptor

Returns	LOGICAL

Top

PROTECTED LOGICAL UserControlEventsSubscribed

Inherited from Consultingwerk.SmartComponents.Base.SmartUserControl

Returns	LOGICAL

Top

PUBLIC LOGICAL ValidateChildrenOnSaveChanges

Returns	LOGICAL

Top

PUBLIC CHARACTER ViewerLogicClass

Returns	CHARACTER

Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.ISmartViewerLogic ViewerLogicObject

Returns	Consultingwerk.SmartComponents.Interfaces.ISmartViewerLogic

Temp-Table Detail

Temp-Table ttViewerBoundControls

Defined in:

info@consultingwerk.de http://www.consultingwerk.de 09.11.2024 18:39:25