Namespace: Consultingwerk.BusinessEntityDesigner.UI
Class 
BusinessEntityDesignerForm Copy to Clipboard
Parent classes:
Inherits: Consultingwerk.SmartComponents.Base.SmartWindowForm
Implements: IBaseForm, ICustomTypeDescriptor, IHasDesignerVerbs, Consultingwerk.SmartComponents.Interfaces.ISmartWindowForm

File:BusinessEntityDesignerForm
Purpose:Main Form of the Consultingwerk BusinessEntity Designer
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Wed Oct 13 12:07:58 CEST 2010
Notes:Built using Infragistics Controls and Crainiate ERM
Controls



Top Method Summary
Options Name Purpose
+ ActivateDesignCanvas () Activates the Design Canvas
# ActivateDrawConnector () Activates the Add connector mode (allows dragging of new relations) on the model
# ActivateDrawPointer () Activates the pointer mode (allows selection of Shapes) on the model
+ ActivateLinks (Control) Activates the Links between the active control and the SmartToolbarController
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
# ActivateMenuItems () Activates the (context) menu items based on the current selected
+ ActivateSmartControl (Control) Marks a SmartViewerControl or SmartBrowserControl as Active
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
# AddToolForClearWindowSettings () Adds a Tool to the Business Entity Designer Ribbon application menu that allows a user wipe out all window settings
# AddToolForReleaseNotesSetting () Adds a Tool to the Business Entity Designer Ribbon application menu that allows a user to toggle the display of the release notes
+ AutoLayout () Performs an Auto Layout of the Current Diagram
# BuildLRUMenuItems ()
# BusinessEntityTester () Starts the Business Entity Tester for the current Business Entity
+ LOGICAL CanFindInComponentsCollection (Object) Returns if the component can be found in the ComponentsCollection
Inherited from Consultingwerk.Forms.BaseForm
# LOGICAL CheckChanges () Prompts for SaveChanges prompt if required
# LOGICAL CheckCloseSourceCodeEditor () Closes the source code editor
# ClearWindowSettings () Clears all Window Settings
# CollapseAllTables () Collapses all tables on the model
# Compile () Compiles the generated source code
# CopyFieldNames () Shows a dialog that allows to copy field names of the selected table to the clipboard
# CreateVerbs () Creates Designer Verbs based on the DesignerVerbs property
Inherited from Consultingwerk.Forms.BaseForm
# CustomizeToolbar () Customizes the UltraToolbarController associated with this BaseForm
Inherited from Consultingwerk.Forms.BaseForm
# DesignerInsertUserControl () Inserts a user control instance at design time.
Inherited from Consultingwerk.Forms.BaseForm
- diagram1_DoubleClick (Object, EventArgs) Event handler for the DoubleClick event of the crainiate diagram1
- diagram1_DragDrop (Object, DragEventArgs) Event handler for the DragDrop event of the crainiate diagram1
- diagram1_DragEnter (Object, DragEventArgs) Event handler for the DragEnter event of the crainiate diagram1
- diagram1_DragOver (Object, DragEventArgs) Event handler for the DragOver event of the crainiate diagram1
- diagram1_ElementInserted (Object, ElementsEventArgs) Event handler for the ElementInserted event of the crainiate diagram1
- diagram1_ElementRemoved (Object, ElementsEventArgs) Event handler for the ElementRemoved event of the crainiate diagram1
- diagram1_EnabledChanged (Object, EventArgs) Event handler for the EnabledChanged event of the crainiate diagram1
- diagram1_SelectedChanged (Object, EventArgs) Event handler for the SelectedChanged event of the crainiate diagram1
+ DisablePagesInFolder (character) Disables a list of pages
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ DisplayStatus (character) Displays a text in the "status" panel of the UltraStatusBar
# DuplicateSelectedTable () Duplicates the currently selected table
# EditActiveElement () Edits the active element
- EditFields () Invokes the Field Editor Form
# EditSource () Opens the BusinessEntitySourceEditorForm for the current business entity
+ EnableDisablePagesInFolder (character, logical) Enables or Disables a list of pages
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ EnablePagesInFolder (character) Enables a list of pages
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
# EnableViewerFromShortcut (SmartViewerControl) Enables one of the property sheet viewers from a shortcut key
# LOGICAL EnsureAllViewersSaved () Ensures that all Viewers have saved their changes
# ExpandAllTables () Expands all tables on the model
# FieldsReorder ()
# FilterTables (character) Filters the list of database tables in the toolbox
+ System.Collections.Generic.List <System.Windows.Forms.Control> FindAllControlsOfType (Type) Returns a List of all Controls in the Form that are of the given type
Inherited from Consultingwerk.Forms.BaseForm
+ Progress.Windows.Form FindDependentFormOfClass (Class) Returns the dependent form instance of the given class
Inherited from Consultingwerk.Forms.BaseForm
# GenerateSource () Generates the source code
# GenericStatusChandedHandler (IStatusManager, character) Event handler for the GenericStatusChanded event of the IStatusManager
+ System.Collections.Generic.List <System.ComponentModel.Component> GetAllComponents () Returns a List of all Components in the Form
Inherited from Consultingwerk.Forms.BaseForm
+ AttributeCollection GetAttributes () Returns a collection of custom attributes for this instance of a component.
Inherited from Consultingwerk.Forms.BaseForm
+ CHARACTER GetClassName () Returns the class name of this instance of a component.
Inherited from Consultingwerk.Forms.BaseForm
+ CHARACTER GetComponentName () Returns the name of this instance of a component.
Inherited from Consultingwerk.Forms.BaseForm
+ TypeConverter GetConverter () Returns a type converter for this instance of a component.
Inherited from Consultingwerk.Forms.BaseForm
+ EventDescriptor GetDefaultEvent () Returns the default event for this instance of a component.
Inherited from Consultingwerk.Forms.BaseForm
+ PropertyDescriptor GetDefaultProperty () Returns the default property for this instance of a component.
Inherited from Consultingwerk.Forms.BaseForm
+ System.Object GetEditor (Type) Returns an editor of the specified type for this instance of a component.
Inherited from Consultingwerk.Forms.BaseForm
+ EventDescriptorCollection GetEvents () Returns the events for this instance of a component.
Inherited from Consultingwerk.Forms.BaseForm
+ EventDescriptorCollection GetEvents (Attribute[]) Returns the events for this instance of a component using the specified attribute array as a filter.
Inherited from Consultingwerk.Forms.BaseForm
+ Consultingwerk.SmartComponents.Base.ListSmartDataAdapter GetLinkedDataAdapters () Returns a List of Data Adapter instances in the Form
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ Consultingwerk.SmartComponents.Base.ListSmartDataAdapter GetLinkedDataAdapters (SmartDataAdapter) Returns a List of Data Adapter instances in the Form
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
# GetLinkedDataAdapters (SmartDataAdapter, ListSmartDataAdapter) Add linked SmartDataAdapter instances to a List
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ PropertyDescriptorCollection GetProperties () Returns the properties for this instance of a component.
Inherited from Consultingwerk.Forms.BaseForm
+ PropertyDescriptorCollection GetProperties (Attribute[]) Returns the properties for this instance of a component using the attribute array as a filter.
Inherited from Consultingwerk.Forms.BaseForm
+ System.Object GetPropertyOwner (PropertyDescriptor) Returns an object that contains the property described by the specified property descriptor.
Inherited from Consultingwerk.Forms.BaseForm
+ Consultingwerk.SmartComponents.Interfaces.ISmartToolbarControl GetToolbar () Returns the reference to the ISmartToolbarControl of the ISmartWindowForm
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
# ImportTable () Prompts for a file to import and invokes the ImportTableFromFile method in the BusinessEntityDatasetController class
- InitializeComponent () Initializes the Visual Design
# InitializeFormLogicObject () Initializes the Form Logic Object
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
# InitializePlugins () Initializes the Plugins for the Business Entity Designer
# InitializeShortcutsKeys () Initilizes Shortcut keys in the Business Entity Designer
+ LOGICAL IsPluginActive (character) Returns if the plugin with the given name is active
# LoadFileLRU () Loads the .bedgm file LRU from the Registry
+ LoadLRU () Loads the table filter LRU from the registry
# LoadRibbonQuickAccessToolbar () Restores the Quick Access Toolbar items from the Registry
Inherited from Consultingwerk.Forms.BaseForm
# CHARACTER LoadSettings () Loads the stored window settings (position etc.) from the registry
Inherited from Consultingwerk.Forms.BaseForm
# CHARACTER LoadSettings (character) Loads stored window settings from the registry
Inherited from Consultingwerk.Forms.BaseForm
# NewDesign () Creates a new Business Entity Design
+ NewWindow () Opens a new window
# OnActiveSmartControlChanged (EventArgs) Raises the ActiveSmartControlChanged event
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
# OnExternalDataSourceChanged (EventArgs) Raises the ExternalDataSourceChanged event
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
# OnExternalNavigationTargetChanged (EventArgs) Raises the OnExternalNavigationTargetChanged
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
# OnFormClosed (FormClosedEventArgs) Raises the FormClosed event
Overrides Consultingwerk.SmartComponents.Base.SmartWindowForm:OnFormClosed (FormClosedEventArgs)
# OnFormClosing (FormClosingEventArgs) Raises the FormClosing Event
Overrides Consultingwerk.SmartComponents.Base.SmartWindowForm:OnFormClosing (FormClosingEventArgs)
# OnFormDestroyed (EventArgs) Raises the FormDestroyed event
Inherited from Consultingwerk.Forms.BaseForm
# OnGenericEvent (EventArgs) Raises the GenericEvent
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
# OnLoad (EventArgs) Raises the Load event
Overrides Consultingwerk.SmartComponents.Base.SmartWindowForm:OnLoad (EventArgs)
# OnPrimaryDataSourceChanged (EventArgs) Raises the PrimaryDataSourceChanged event
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
# OnPrimaryDataTargetChanged (EventArgs) Raises the PrimaryDataTargetChanged event
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
# OnPrimaryNavigationSourceChanged (EventArgs) Raises the PrimaryNavigationSourceChanged
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
# OnShown (EventArgs) Raises the Shown event
# OnSmartToolbarControllerChanged () Internal event handler
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ OnVerbClicked (character) Event Handler method for Designer Verbs
Inherited from Consultingwerk.Forms.BaseForm
# OpenDesign () Opens a design using a FileOpen Dialog
# OpenFileFromLRU (character) Opens a file from the LRU list
# ParseStartupParameter () Parses and processes the startup parameters
# PasteSourceCode () Pastes temp-tables from a block of source code
# Print ()
+ Consultingwerk.Framework.Enum.DialogResultEnum PromptForSaveOfPendingChangesOnClose () Shows the Prompt to save pending transactions to the backend while closing the Form
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ RaiseGenericEvent (EventArgs) Raises the Generic Event
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ LOGICAL RecurseCheckIsOkToClose (Control+ControlCollection, logical, CloseReason) Recursivly ask all Controls implementing the ICheckOkToClose Interface wheather it is ok to close the form.
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
# LOGICAL RecurseSaveChangesOnDeactivateForm (Control+ControlCollection, logical) Recursively checks all contained controls to save changes on Deactivate of the Form
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
# RefreshTable () Refreshes the selected temp-tables from the database
# RefreshTableFromInclude () Refreshes the selected temp-tables from the include files
# RegenerateSource () Re-Generates source code (refresh)
+ RegisterElementRenderer (Render) Registers the renderers for the Element types
# RegisterServices () Registers the Business Entity Desginer Form and the BusinessEntityDatasetController in the ServiceContainer
# ReleaseNotesControlDragEnter (Object, DragEventArgs) Event handler for the DragEnter event of the ReleaseNotesControl
# RemoveDataRelation () Removes the currently selected data relation
# RemoveSetting (character) Removes a stored setting
Inherited from Consultingwerk.Forms.BaseForm
# RenameMove () Performs a Rename or Move operation
# RenameSelectedTable () Renames the currently selected table
# RestoreUltraSplitterPosition () Restores the position of the Ultra Splitter Controls
Inherited from Consultingwerk.Forms.BaseForm
# RestoreWindowPosition () Restores the stored window position
Inherited from Consultingwerk.Forms.BaseForm
# SaveDesign (logical) Saves the design
# SaveDesignAs (logical) Saves the design under a new name
- searchTimer_Tick (Object, EventArgs) Event handler for the Tick event of the searchTimer component
- ShortcutKeyDownHandler (Object, KeyEventArgs) Event hander for the KeyDown event of the Form
# ShowConnectDatabaseDialog () Shows the Connect Database Dialog
# ShowDatabaseConnectionsDialog () Shows the Progress ADE Database Connections Dialog
# ShowDatabaseLoginPreferences () Shows the Login Preferencse Dialog
# ShowOptionsDialog ()
# ShutdownPlugins () Shutdown all loaded plugins
- smartToolbarController1_ToolClick (Object, ToolClickEventArgs) Event handler for the ToolClick event of the smartToolbarController1
- smartToolbarController1_ToolKeyPress (Object, ToolKeyPressEventArgs) Event handler for the ToolKeyPress event of the smartToolbarController1
# StoreFileLRU () Stores the LRU file list in the registry
# StoreLRU ()
# StoreRibbonQuickAccessToolbar () Stores the current Quick Access Toolbar items in the Registry
Inherited from Consultingwerk.Forms.BaseForm
# StoreSettings (character) Stores the current window settings (position etc.) to the registry
Inherited from Consultingwerk.Forms.BaseForm
# StoreSettings (character, character) Stores window settings to the registry
Inherited from Consultingwerk.Forms.BaseForm
+ StoreUltraSplitterPosition () Stores the position of the UltraSplitter Controls in the Registry
Inherited from Consultingwerk.Forms.BaseForm
# StoreWindowPosition () Stores the window position to the resgistry
Inherited from Consultingwerk.Forms.BaseForm
# SuspendSTAThreadWarning (UltraDockManager) Suspends STAThread warnings for an UltraDockManager instance
Inherited from Consultingwerk.Forms.BaseForm
# TableItemSelectedHandler (Object, EventArgs) Event handler for the TableItemSelected event of the BusinessEntityDatasetController
- timer1_Tick (Object, EventArgs) Event Handler for the Tick Event of the timer1 component
# TimerTick (Object, EventArgs) Event handler for the Tick event of the temporary Timer instance
# ToggleDisplayReleaseNotes () Handles changing the DisplayReleaseNotes toggle
- ultraDockManager1_PaneActivate (Object, ControlPaneEventArgs) Event handler for the PaneActivate event of the ultraDockManager1
- ultraExplorerBar1_ActiveGroupChanged (Object, GroupEventArgs) Event handler for the ActiveGroupChanged event of the ActiveGroupChanged
- ultraExplorerBar1_MouseDown (Object, MouseEventArgs) Event handler for the MouseDown event of the ultraExplorerBar1
- ultraStatusBar1_ButtonClick (Object, PanelEventArgs) Event handler for the ButtonClick event of the ultraStatusBar
- ultraTrackBar1_ValueChanged (Object, EventArgs) Event handler for the ValueChanged event of the ultraTrackBar1
- ultraTree1_AfterSelect (Object, SelectEventArgs) Event handler for the AfterSelect event of the ultraTree1
# UnsavedChangesChangedHandler (Object, EventArgs) Handles the UnsavedChangesChanged event of the BusinessEntityDatasetController
+ UpdateCustomProperties (CustomPropertiesScopeEnum) Updates the custom properties for the currently selected object of the given scope
+ UpdateCustomProperties (CustomPropertiesScopeEnum, character) Updates the custom properties for the currently selected object of the given scope
# UpdateFileLRU (character) Updates the LRU file list with a recently opened file name
# UpdateRelationFields () Pops up dialog for relation field mapping
# ValidateDesign () Validates the Design
# ViewerFieldsEnabledHandler (Object, EventArgs) Event handler for the FieldsEnabled event of the five viewers in the Business Entity Designer Form
# CHARACTER WindowTitle (character) Returns the Title that should be shown in the title bar Business Entity Designer Form

Top Constructor Summary
Options Name Purpose
+ BusinessEntityDesignerForm () Constructor for the BusinessEntityDesignerForm class

Top Event Summary
Options Name Purpose
+ ActiveSmartControlChanged DELEGATE System.EventHandler Raised whenever the ActiveSmartSmartControl property has changed
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ ExternalDataSourceChanged DELEGATE System.EventHandler Raised when the ExternalDataSource property changes
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ ExternalNavigationTargetChanged (Object, EventArgs) Raised when the ExtenalNavigationSource property changes
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ FormDestroyed DELEGATE System.EventHandler Raised when a Form is destroyed (in the Destructor)
Inherited from Consultingwerk.Forms.BaseForm
+ GenericEvent (Object, EventArgs) Raised from custom logic
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ PrimaryDataSourceChanged DELEGATE System.EventHandler Raised when the PrimaryDataSource property changes
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ PrimaryDataTargetChanged DELEGATE System.EventHandler Raised when the PrimaryDataTarget property changes
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ PrimaryNavigationSourceChanged (Object, EventArgs) Raised when the PrimaryNavigationSource property changes
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm

Top Property Summary
Options Name Purpose
+ System.Windows.Forms.Control ActiveSmartControl
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
# CHARACTER BindableProperties
Inherited from Consultingwerk.Forms.BaseForm
# CHARACTER CategorizedProperties
Inherited from Consultingwerk.Forms.BaseForm
# CHARACTER CategoryProperties
Inherited from Consultingwerk.Forms.BaseForm
+ LOGICAL DeleteOnFormClosed
Inherited from Consultingwerk.Forms.BaseForm
+ System.Collections.Generic.List <Progress.Windows.Form> DependentForms
Inherited from Consultingwerk.Forms.BaseForm
# CHARACTER DescribedProperties
Inherited from Consultingwerk.Forms.BaseForm
# CHARACTER DescriptionProperties
Inherited from Consultingwerk.Forms.BaseForm
# CHARACTER DesignerVerbs
Inherited from Consultingwerk.Forms.BaseForm
# CHARACTER DesignerVisibilityAttributes
Inherited from Consultingwerk.Forms.BaseForm
# CHARACTER DesignerVisibilityProperties
Inherited from Consultingwerk.Forms.BaseForm
+ LOGICAL DesignTime
Inherited from Consultingwerk.Forms.BaseForm
+ Consultingwerk.SmartComponents.Interfaces.ISmartDataSource ExternalDataSource
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ Consultingwerk.SmartComponents.Interfaces.ISmartNavigationTarget ExternalNavigationTarget
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ CHARACTER FileName
+ CHARACTER FormAction
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ CHARACTER FormLogicClass
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ Consultingwerk.SmartComponents.Interfaces.ISmartFormLogic FormLogicObject
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
# CHARACTER HiddenProperties
Inherited from Consultingwerk.Forms.BaseForm
+ LOGICAL IsClosed
Inherited from Consultingwerk.Forms.BaseForm
# CHARACTER NonBrowsableProperties
Inherited from Consultingwerk.Forms.BaseForm
+ System.Windows.Forms.FormWindowState PreviousWindowState
Inherited from Consultingwerk.Forms.BaseForm
+ Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataSource PrimaryDataSource
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataTarget PrimaryDataTarget
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ Consultingwerk.SmartComponents.Interfaces.Design.IDesignNavigationSource PrimaryNavigationSource
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ LOGICAL PromptForSaveOnApplicationLeave
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ LOGICAL PromptForSaveOnFormDeactivate
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
# Consultingwerk.SmartComponents.Base.SmartWindowFormController SmartWindowFormController
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
# LOGICAL StoreFormPosition
Inherited from Consultingwerk.Forms.BaseForm
+ LOGICAL UseStartupSizeAsMinSize
Inherited from Consultingwerk.Forms.BaseForm
+ CHARACTER WindowPositionRegistryKey
Inherited from Consultingwerk.Forms.BaseForm


Method Detail
Top

PUBLIC ActivateDesignCanvas ()

Purpose: Activates the Design Canvas
Notes:

Top

PROTECTED ActivateDrawConnector ()

Purpose: Activates the Add connector mode (allows dragging of new relations)
on the model
Notes:

Top

PROTECTED ActivateDrawPointer ()

Purpose: Activates the pointer mode (allows selection of Shapes) on the model
Notes:

Top

PUBLIC ActivateLinks (Control)

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Activates the Links between the active control and the
SmartToolbarController
Notes: When the ActiveControl is a read-only Browse, we attempt to activate
the TableIO Link on another Data-Target of the Browsers SmartDataAdapter
That could be a Viewer with is linked to the same adapter

Parameters:
poActiveControl System.Windows.Forms.Control
The Control where the Links should be activated
Top

PROTECTED ActivateMenuItems ()

Purpose: Activates the (context) menu items based on the current selected
Notes:

Top

PUBLIC ActivateSmartControl (Control)

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Marks a SmartViewerControl or SmartBrowserControl as Active
Notes:

Parameters:
poControl System.Windows.Forms.Control
The reference to the Control that has become active
Top

PROTECTED AddToolForClearWindowSettings ()

Purpose: Adds a Tool to the Business Entity Designer Ribbon application
menu that allows a user wipe out all window settings
Notes:

Top

PROTECTED AddToolForReleaseNotesSetting ()

Purpose: Adds a Tool to the Business Entity Designer Ribbon application
menu that allows a user to toggle the display of the release
notes
Notes:

Top

PUBLIC AutoLayout ()

Purpose: Performs an Auto Layout of the Current Diagram
Notes:

Top

PROTECTED BuildLRUMenuItems ()

Purpose:
Notes:

Top

PROTECTED BusinessEntityTester ()

Purpose: Starts the Business Entity Tester for the current Business Entity
Notes:

Top

PUBLIC LOGICAL CanFindInComponentsCollection (Object)

Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns if the component can be found in the ComponentsCollection
Notes: Available from OpenEdge 11.1 on

Parameters:
poComponent System.Object
The component to locate
Returns LOGICAL
Logical value indicating if the component can be found in the ComponentsCollection
Top

PROTECTED LOGICAL CheckChanges ()

Purpose: Prompts for SaveChanges prompt if required
Notes:

Returns LOGICAL
Logical value indicating if the user has chosen to save changes
Top

PROTECTED LOGICAL CheckCloseSourceCodeEditor ()

Purpose: Closes the source code editor
Notes:

Returns LOGICAL
Logical value indicating if the editor was closed
Top

PROTECTED ClearWindowSettings ()

Purpose: Clears all Window Settings
Notes: Closes the application when done

Top

PROTECTED CollapseAllTables ()

Purpose: Collapses all tables on the model
Notes:

Top

PROTECTED Compile ()

Purpose: Compiles the generated source code
Notes:

Top

PROTECTED CopyFieldNames ()

Purpose: Shows a dialog that allows to copy field names of the selected
table to the clipboard
Notes:

Top

PROTECTED CreateVerbs ()

Inherited from Consultingwerk.Forms.BaseForm
Purpose: Creates Designer Verbs based on the DesignerVerbs property
Notes:

Top

PROTECTED CustomizeToolbar ()

Inherited from Consultingwerk.Forms.BaseForm
Purpose: Customizes the UltraToolbarController associated with this BaseForm
Notes: Uses the IFormToolbarCustomizer Service if present

Top

PROTECTED DesignerInsertUserControl ()

Inherited from Consultingwerk.Forms.BaseForm
Purpose: Inserts a user control instance at design time.
Notes:

Top

PRIVATE diagram1_DoubleClick (Object, EventArgs)

Purpose: Event handler for the DoubleClick event of the crainiate diagram1
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 diagram1_DragDrop (Object, DragEventArgs)

Purpose: Event handler for the DragDrop event of the crainiate diagram1
Notes:

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

PRIVATE diagram1_DragEnter (Object, DragEventArgs)

Purpose: Event handler for the DragEnter event of the crainiate diagram1
Notes:

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

PRIVATE diagram1_DragOver (Object, DragEventArgs)

Purpose: Event handler for the DragOver event of the crainiate diagram1
Notes:

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

PRIVATE diagram1_ElementInserted (Object, ElementsEventArgs)

Purpose: Event handler for the ElementInserted event of the crainiate diagram1
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e Crainiate.Diagramming.ElementsEventArgs
The ElementsEventArgs with the data for this event
Top

PRIVATE diagram1_ElementRemoved (Object, ElementsEventArgs)

Purpose: Event handler for the ElementRemoved event of the crainiate diagram1
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e Crainiate.Diagramming.ElementsEventArgs
The ElementsEventArgs with the data for this event
Top

PRIVATE diagram1_EnabledChanged (Object, EventArgs)

Purpose: Event handler for the EnabledChanged event of the crainiate diagram1
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 diagram1_SelectedChanged (Object, EventArgs)

Purpose: Event handler for the SelectedChanged event of the crainiate diagram1
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 DisablePagesInFolder (character)

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Disables a list of pages
Notes: Seeks for the outermost UltraTab Control

Parameters:
pcPagesList CHARACTER
The comma delimited list of pages to Disable
Top

PUBLIC DisplayStatus (character)

Purpose: Displays a text in the "status" panel of the UltraStatusBar
Notes:

Parameters:
pcStatusText CHARACTER
The StatusText to display
Top

PROTECTED DuplicateSelectedTable ()

Purpose: Duplicates the currently selected table
Notes:

Top

PROTECTED EditActiveElement ()

Purpose: Edits the active element
Notes:

Top

PRIVATE EditFields ()

Purpose: Invokes the Field Editor Form
Notes:

Top

PROTECTED EditSource ()

Purpose: Opens the BusinessEntitySourceEditorForm for the current business
entity
Notes:

Top

PUBLIC EnableDisablePagesInFolder (character, logical)

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Enables or Disables a list of pages
Notes: Seeks for the outermost UltraTab Control

Parameters:
pcPagesList CHARACTER
The comma delimited list of pages to Disable
plEnable LOGICAL
Logical value indicating if the pages should be enabeld or disabled
Top

PUBLIC EnablePagesInFolder (character)

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Enables a list of pages
Notes: Seeks for the outermost UltraTab Control

Parameters:
pcPagesList CHARACTER
The comma delimited list of pages to Disable
Top

PROTECTED EnableViewerFromShortcut (SmartViewerControl)

Purpose: Enables one of the property sheet viewers from a shortcut key
Notes: Viewer is expected to use an ultraTabControl1

Parameters:
poViewer Consultingwerk.SmartComponents.Base.SmartViewerControl
The viewer to enable
Top

PROTECTED LOGICAL EnsureAllViewersSaved ()

Purpose: Ensures that all Viewers have saved their changes
Notes:

Returns LOGICAL
Logical value indicating if all Viewers are saved
Top

PROTECTED ExpandAllTables ()

Purpose: Expands all tables on the model
Notes:

Top

PROTECTED FieldsReorder ()

Purpose:
Notes:

Top

PROTECTED FilterTables (character)

Purpose: Filters the list of database tables in the toolbox
Notes:

Parameters:
pcFilter CHARACTER
The filter value
Top

PUBLIC System.Collections.Generic.List <System.Windows.Forms.Control> FindAllControlsOfType (Type)

Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns a List of all Controls in the Form that are of the given type
Notes:

Parameters:
poType System.Type
The reference to the System.Type
Returns System.Collections.Generic.List <System.Windows.Forms.Control>
The List of all Controls of the given type
Top

PUBLIC Progress.Windows.Form FindDependentFormOfClass (Class)

Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns the dependent form instance of the given class
Notes:

Parameters:
poClass Progress.Lang.Class
The class to locate
Returns Progress.Windows.Form
Form instance
Top

PROTECTED GenerateSource ()

Purpose: Generates the source code
Notes:

Top

PROTECTED GenericStatusChandedHandler (IStatusManager, character)

Purpose: Event handler for the GenericStatusChanded event of the IStatusManager
Notes:

Parameters:
sender Consultingwerk.Framework.IStatusManager
The reference to the IStatusManager that raised the event
pcStatus CHARACTER
The new status text
Top

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

Inherited from Consultingwerk.Forms.BaseForm
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 AttributeCollection GetAttributes ()

Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns a collection of custom attributes for this instance of a
component.
Notes:

Returns AttributeCollection
The System.ComponentModel.AttributeCollection describing the types attributes
Top

PUBLIC CHARACTER GetClassName ()

Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns the class name of this instance of a component.
Notes:

Returns CHARACTER
The class name of the Component
Top

PUBLIC CHARACTER GetComponentName ()

Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns the name of this instance of a component.
Notes:

Returns CHARACTER
The Component Name of this instance
Top

PUBLIC TypeConverter GetConverter ()

Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns a type converter for this instance of a component.
Notes:

Returns TypeConverter
The System.ComponentModel.TypeConverter for this instance of a component.
Top

PUBLIC EventDescriptor GetDefaultEvent ()

Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns the default event for this instance of a component.
Notes:

Returns EventDescriptor
The System.ComponentModel.EventDescriptor for the default event of this component
Top

PUBLIC PropertyDescriptor GetDefaultProperty ()

Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns the default property for this instance of a component.
Notes:

Returns PropertyDescriptor
The System.ComponentModel.PropertyDescriptor for the default property of the component
Top

PUBLIC System.Object GetEditor (Type)

Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns an editor of the specified type for this instance of a
component.
Notes:

Parameters:
editorBaseType System.Type
A System.Type that represents the editor for this object.
Returns System.Object
The reference to the Editor of the type of the component instance
Top

PUBLIC EventDescriptorCollection GetEvents ()

Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns the events for this instance of a component.
Notes:

Returns EventDescriptorCollection
The System.ComponentModel.EventDescriptorCollection describing the events of the component
Top

PUBLIC EventDescriptorCollection GetEvents (Attribute[])

Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns the events for this instance of a component using the
specified attribute array as a filter.
Notes:

Parameters:
attributes System.Attribute[]
A System.Attribute[] that is used as a filter.
Returns EventDescriptorCollection
The System.ComponentModel.EventDescriptorCollection describing the events of the component
Top

PUBLIC Consultingwerk.SmartComponents.Base.ListSmartDataAdapter GetLinkedDataAdapters ()

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Returns a List of Data Adapter instances in the Form
Notes: Returns the PrimaryDataTarget (when that's a Data Adapter) and
the PrimaryDataSource as well as all their DataTarget instances

Returns Consultingwerk.SmartComponents.Base.ListSmartDataAdapter
The List of Data Adapter instances
Top

PUBLIC Consultingwerk.SmartComponents.Base.ListSmartDataAdapter GetLinkedDataAdapters (SmartDataAdapter)

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Returns a List of Data Adapter instances in the Form
Notes: Returns the PrimaryDataTarget (when that's a Data Adapter) and
the PrimaryDataSource or the poStart SmartDataAdapter instance
as well as all their DataTarget instances

Parameters:
poStart Consultingwerk.SmartComponents.Base.SmartDataAdapter
An optional reference to a SmartDataAdapter to use as the starting point
Returns Consultingwerk.SmartComponents.Base.ListSmartDataAdapter
The List of Data Adapter instances
Top

PROTECTED GetLinkedDataAdapters (SmartDataAdapter, ListSmartDataAdapter)

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Add linked SmartDataAdapter instances to a List
Notes: Used by GetLinkedDataAdpaters (poStart)

Parameters:
poStart Consultingwerk.SmartComponents.Base.SmartDataAdapter
The reference to a SmartDataAdapter to use as the starting point
poList Consultingwerk.SmartComponents.Base.ListSmartDataAdapter
The list of SmartDataAdapters to add to
Top

PUBLIC PropertyDescriptorCollection GetProperties ()

Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns the properties for this instance of a component.
Notes:

Returns PropertyDescriptorCollection
A System.ComponentModel.PropertyDescriptorCollection that represents the properties for this component instance.
Top

PUBLIC PropertyDescriptorCollection GetProperties (Attribute[])

Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns the properties for this instance of a component using the
attribute array as a filter.
Notes:

Parameters:
attributes System.Attribute[]
A System.Attribute[] that is used as a filter.
Returns PropertyDescriptorCollection
A System.ComponentModel.PropertyDescriptorCollection that represents the properties for this component instance.
Top

PUBLIC System.Object GetPropertyOwner (PropertyDescriptor)

Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns an object that contains the property described by the
specified property descriptor.
Notes:

Parameters:
pd PropertyDescriptor
A System.ComponentModel.PropertyDescriptor that represents the property whose owner is to be found.
Returns System.Object
An System.Object that represents the owner of the specified property.
Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.ISmartToolbarControl GetToolbar ()

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Returns the reference to the ISmartToolbarControl of the ISmartWindowForm
Notes:

Returns Consultingwerk.SmartComponents.Interfaces.ISmartToolbarControl
The reference to the ISmartToolbarControl of the ISmartWindowForm
Top

PROTECTED ImportTable ()

Purpose: Prompts for a file to import and invokes the ImportTableFromFile method
in the BusinessEntityDatasetController class
Notes:

Top

PRIVATE InitializeComponent ()

Purpose: Initializes the Visual Design
Notes:

Top

PROTECTED InitializeFormLogicObject ()

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Initializes the Form Logic Object
Notes: The SmartWindowForm will initialize the FormLogicClass during
OnLoad. The Form Logic Object will also not initialized when the
FormLogicObject instance is already set

Top

PROTECTED InitializePlugins ()

Purpose: Initializes the Plugins for the Business Entity Designer
Notes:

Top

PROTECTED InitializeShortcutsKeys ()

Purpose: Initilizes Shortcut keys in the Business Entity Designer
Notes: Edit Entity, Table, Field, Index, Relation Properties
(CTRL-E, CTRL-T, CTRL-F, CTRL-I, CTRL-R), Save (CTRL-S) and
cancel (ESC)

Top

PUBLIC LOGICAL IsPluginActive (character)

Purpose: Returns if the plugin with the given name is active
Notes:

Parameters:
pcPluginName CHARACTER
The name of the Plugin
Returns LOGICAL
Logical value indicating if the plugin is loaded
Top

PROTECTED LoadFileLRU ()

Purpose: Loads the .bedgm file LRU from the Registry
Notes:

Top

PUBLIC LoadLRU ()

Purpose: Loads the table filter LRU from the registry
Notes:

Top

PROTECTED LoadRibbonQuickAccessToolbar ()

Inherited from Consultingwerk.Forms.BaseForm
Purpose: Restores the Quick Access Toolbar items from the Registry
Notes:

Top

PROTECTED CHARACTER LoadSettings ()

Inherited from Consultingwerk.Forms.BaseForm
Purpose: Loads the stored window settings (position etc.) from the registry
Notes:

Returns CHARACTER
The string containing the stored window settings
Top

PROTECTED CHARACTER LoadSettings (character)

Inherited from Consultingwerk.Forms.BaseForm
Purpose: Loads stored window settings from the registry
Notes:

Parameters:
pcSettingsKey CHARACTER
The key under which the settings for this Form are stored (e.g. Position)
Returns CHARACTER
The string containing the stored window settings
Top

PROTECTED NewDesign ()

Purpose: Creates a new Business Entity Design
Notes:

Top

PUBLIC NewWindow ()

Purpose: Opens a new window
Notes:

Top

PROTECTED OnActiveSmartControlChanged (EventArgs)

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Raises the ActiveSmartControlChanged event
Notes:

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

PROTECTED OnExternalDataSourceChanged (EventArgs)

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Raises the ExternalDataSourceChanged event
Notes:

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

PROTECTED OnExternalNavigationTargetChanged (EventArgs)

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Raises the OnExternalNavigationTargetChanged
Notes:

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

PROTECTED OnFormClosed (FormClosedEventArgs)

Overrides Consultingwerk.SmartComponents.Base.SmartWindowForm:OnFormClosed (FormClosedEventArgs)
Purpose: Raises the FormClosed event
Notes: Deletes the Form Instance when it has been closed.
See Progress K-Base Entry ID: P179041
Title: "User Controls that have events attached to them cause
parent forms to not get garbage collected"
Dialog Forms will not get deleted. Typically Dialog Forms will need
to return values to the calling Program using properties. This
requires that the dialog form is valid after the WAIT-FOR
ShowDialog statement.
(Dialog Forms are detected using the Modal property)

Parameters:
e System.Windows.Forms.FormClosedEventArgs
A FormClosedEventArgs that contains the event data.
Top

PROTECTED OnFormClosing (FormClosingEventArgs)

Overrides Consultingwerk.SmartComponents.Base.SmartWindowForm:OnFormClosing (FormClosingEventArgs)
Purpose: Raises the FormClosing Event
Notes: Shut's down Plugins and saves UI preferences to .BusinessEntityDesignerSettings2.xml

Parameters:
e System.Windows.Forms.FormClosingEventArgs
The FormClosingEventArgs with the data for this event
Top

PROTECTED OnFormDestroyed (EventArgs)

Inherited from Consultingwerk.Forms.BaseForm
Purpose: Raises the FormDestroyed event
Notes:

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

PROTECTED OnGenericEvent (EventArgs)

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Raises the GenericEvent
Notes:

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

PROTECTED OnLoad (EventArgs)

Overrides Consultingwerk.SmartComponents.Base.SmartWindowForm:OnLoad (EventArgs)
Purpose: Raises the Load event
Notes:

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

PROTECTED OnPrimaryDataSourceChanged (EventArgs)

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Raises the PrimaryDataSourceChanged event
Notes:

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

PROTECTED OnPrimaryDataTargetChanged (EventArgs)

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Raises the PrimaryDataTargetChanged event
Notes:

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

PROTECTED OnPrimaryNavigationSourceChanged (EventArgs)

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Raises the PrimaryNavigationSourceChanged
Notes:

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

PROTECTED OnShown (EventArgs)

Purpose: Raises the Shown event
Notes:

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

PROTECTED OnSmartToolbarControllerChanged ()

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Internal event handler
Notes: Invoked when the SmartToolbarController property changes

Top

PUBLIC OnVerbClicked (character)

Inherited from Consultingwerk.Forms.BaseForm
Purpose: Event Handler method for Designer Verbs
Notes:

Parameters:
pcVerbText CHARACTER
The label of the verb the developer clicked on in the Visual Designer
Top

PROTECTED OpenDesign ()

Purpose: Opens a design using a FileOpen Dialog
Notes:

Top

PROTECTED OpenFileFromLRU (character)

Purpose: Opens a file from the LRU list
Notes:

Parameters:
pcFileName CHARACTER
The file name to load
Top

PROTECTED ParseStartupParameter ()

Purpose: Parses and processes the startup parameters
Notes: When the -param parameter contains open= then we'll open the
given .bedgm file

Top

PROTECTED PasteSourceCode ()

Purpose: Pastes temp-tables from a block of source code
Notes:

Top

PROTECTED Print ()

Purpose:
Notes:

Top

PUBLIC Consultingwerk.Framework.Enum.DialogResultEnum PromptForSaveOfPendingChangesOnClose ()

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Shows the Prompt to save pending transactions to the backend while
closing the Form
Notes: Can be overridden by customers to change behaviour

Returns Consultingwerk.Framework.Enum.DialogResultEnum
The DialogResultEnum value indicating "Yes" to save changes, "No" to not save changes and "Cancel" to not close the Form
Top

PUBLIC RaiseGenericEvent (EventArgs)

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Raises the Generic Event
Notes: Supports raising events from the Form Logic Class - it's recommended
to use a derived event arg to distinguish events. This method is pacakge-protected
as it's only meant to be used from the SmartFormLogic class

Parameters:
e Consultingwerk.EventArgs
The Consultingwerk.EventArgs
Top

PUBLIC LOGICAL RecurseCheckIsOkToClose (Control+ControlCollection, logical, CloseReason)

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Recursivly ask all Controls implementing the ICheckOkToClose Interface
wheather it is ok to close the form.
Notes:

Parameters:
poControls System.Windows.Forms.Control+ControlCollection
The System.Windows.Forms.Control+ControlCollection Collection of Controls to iterate
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 who closes the form.
Returns LOGICAL
Logical value indicating if the Form can be closed or not.
Top

PROTECTED LOGICAL RecurseSaveChangesOnDeactivateForm (Control+ControlCollection, logical)

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Recursively checks all contained controls to save changes on
Deactivate of the Form
Notes:

Parameters:
poControls System.Windows.Forms.Control+ControlCollection
The System.Windows.Forms.Control+ControlCollection Collection of Controls to iterate
plShowMessage LOGICAL
When TRUE a message is Shown explaining why it is not ok to close the parent form.
Returns LOGICAL
Logical value indicating if it's o.k. to move to the Activated window
Top

PROTECTED RefreshTable ()

Purpose: Refreshes the selected temp-tables from the database
Notes:

Top

PROTECTED RefreshTableFromInclude ()

Purpose: Refreshes the selected temp-tables from the include files
Notes:

Top

PROTECTED RegenerateSource ()

Purpose: Re-Generates source code (refresh)
Notes:

Top

PUBLIC RegisterElementRenderer (Render)

Purpose: Registers the renderers for the Element types
Notes:

Parameters:
poRender Crainiate.Diagramming.Forms.Rendering.Render
The reference to the Crainiate Diagram Render instance
Top

PROTECTED RegisterServices ()

Purpose: Registers the Business Entity Desginer Form and the BusinessEntityDatasetController
in the ServiceContainer
Notes: Ensures that it's accessible from plugins or custom services loaded
in the Business Entity Designer environment

Top

PROTECTED ReleaseNotesControlDragEnter (Object, DragEventArgs)

Purpose: Event handler for the DragEnter event of the ReleaseNotesControl
Notes:

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

PROTECTED RemoveDataRelation ()

Purpose: Removes the currently selected data relation
Notes:

Top

PROTECTED RemoveSetting (character)

Inherited from Consultingwerk.Forms.BaseForm
Purpose: Removes a stored setting
Notes:

Parameters:
pcSettingsKey CHARACTER
The settings key to remove
Top

PROTECTED RenameMove ()

Purpose: Performs a Rename or Move operation
Notes:

Top

PROTECTED RenameSelectedTable ()

Purpose: Renames the currently selected table
Notes:

Top

PROTECTED RestoreUltraSplitterPosition ()

Inherited from Consultingwerk.Forms.BaseForm
Purpose: Restores the position of the Ultra Splitter Controls
Notes:

Top

PROTECTED RestoreWindowPosition ()

Inherited from Consultingwerk.Forms.BaseForm
Purpose: Restores the stored window position
Notes:

Top

PROTECTED SaveDesign (logical)

Purpose: Saves the design
Notes:

Parameters:
plOk LOGICAL
Logical value indicating if the design was saved
Top

PROTECTED SaveDesignAs (logical)

Purpose: Saves the design under a new name
Notes:

Parameters:
plOk LOGICAL
Logical value indicating if the design was saved
Top

PRIVATE searchTimer_Tick (Object, EventArgs)

Purpose: Event handler for the Tick event of the searchTimer component
Notes:

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

PRIVATE ShortcutKeyDownHandler (Object, KeyEventArgs)

Purpose: Event hander for the KeyDown event of the Form
Notes:

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

PROTECTED ShowConnectDatabaseDialog ()

Purpose: Shows the Connect Database Dialog
Notes:

Top

PROTECTED ShowDatabaseConnectionsDialog ()

Purpose: Shows the Progress ADE Database Connections Dialog
Notes:

Top

PROTECTED ShowDatabaseLoginPreferences ()

Purpose: Shows the Login Preferencse Dialog
Notes:

Top

PROTECTED ShowOptionsDialog ()

Purpose:
Notes:

Top

PROTECTED ShutdownPlugins ()

Purpose: Shutdown all loaded plugins
Notes:

Top

PRIVATE smartToolbarController1_ToolClick (Object, ToolClickEventArgs)

Purpose: Event handler for the ToolClick event of the smartToolbarController1
Notes:

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

PRIVATE smartToolbarController1_ToolKeyPress (Object, ToolKeyPressEventArgs)

Purpose: Event handler for the ToolKeyPress event of the smartToolbarController1
Notes:

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

PROTECTED StoreFileLRU ()

Purpose: Stores the LRU file list in the registry
Notes:

Top

PROTECTED StoreLRU ()

Purpose:
Notes:

Top

PROTECTED StoreRibbonQuickAccessToolbar ()

Inherited from Consultingwerk.Forms.BaseForm
Purpose: Stores the current Quick Access Toolbar items in the Registry
Notes:

Top

PROTECTED StoreSettings (character)

Inherited from Consultingwerk.Forms.BaseForm
Purpose: Stores the current window settings (position etc.) to the registry
Notes:

Parameters:
pcSettings CHARACTER
The string containing the window settings to be stored
Top

PROTECTED StoreSettings (character, character)

Inherited from Consultingwerk.Forms.BaseForm
Purpose: Stores window settings to the registry
Notes:

Parameters:
pcSettings CHARACTER
The string containing the window settings to be stored
pcSettingsKey CHARACTER
The key under which the settings for this Form are stored (e.g. Position)
Top

PUBLIC StoreUltraSplitterPosition ()

Inherited from Consultingwerk.Forms.BaseForm
Purpose: Stores the position of the UltraSplitter Controls in the Registry
Notes:

Top

PROTECTED StoreWindowPosition ()

Inherited from Consultingwerk.Forms.BaseForm
Purpose: Stores the window position to the resgistry
Notes:

Top

PROTECTED SuspendSTAThreadWarning (UltraDockManager)

Inherited from Consultingwerk.Forms.BaseForm
Purpose: Suspends STAThread warnings for an UltraDockManager instance
Notes: SCL-3144
https://www.infragistics.com/community/forums/f/ultimate-ui-for-windows-forms/121824/appstylist-for-windows-forms-2020-1/537711 //www.infragistics.com/community/forums/f/ultimate-ui-for-windows-forms/121824/appstylist-for-windows-forms-2020-1/537711

Parameters:
poDockManager Infragistics.Win.UltraWinDock.UltraDockManager
The reference to the UltraDockManager
Top

PROTECTED TableItemSelectedHandler (Object, EventArgs)

Purpose: Event handler for the TableItemSelected event of the
BusinessEntityDatasetController
Notes:

Parameters:
sender Progress.Lang.Object
The reference to the object that raised the event
e Consultingwerk.EventArgs
The Consultingwerk.EventArgs with the data for this event
Top

PRIVATE timer1_Tick (Object, EventArgs)

Purpose: Event Handler for the Tick Event of the timer1 component
Notes: Used when a new Data-Relation has been dragged on the design canvas
In the diagram1_ElementInserted event handler, the target shape of the
new connector is not yet set. This is the case immediately after
that event handler - thus the use of this timer.

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 TimerTick (Object, EventArgs)

Purpose: Event handler for the Tick event of the temporary Timer instance
Notes: Close the splash screen after a while

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

Purpose: Handles changing the DisplayReleaseNotes toggle
Notes:

Top

PRIVATE ultraDockManager1_PaneActivate (Object, ControlPaneEventArgs)

Purpose: Event handler for the PaneActivate event of the ultraDockManager1
Notes:

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

PRIVATE ultraExplorerBar1_ActiveGroupChanged (Object, GroupEventArgs)

Purpose: Event handler for the ActiveGroupChanged event of the ActiveGroupChanged
Notes:

Parameters:
sender System.Object
The object that raised the event
e Infragistics.Win.UltraWinExplorerBar.GroupEventArgs
The GroupEventArgs with the data for this event
Top

PRIVATE ultraExplorerBar1_MouseDown (Object, MouseEventArgs)

Purpose: Event handler for the MouseDown event of the ultraExplorerBar1
Notes:

Parameters:
sender System.Object
The object that raised the event
e System.Windows.Forms.MouseEventArgs
The MouseEventArgs with the data for this event
Top

PRIVATE ultraStatusBar1_ButtonClick (Object, PanelEventArgs)

Purpose: Event handler for the ButtonClick event of the ultraStatusBar
Notes:

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

PRIVATE ultraTrackBar1_ValueChanged (Object, EventArgs)

Purpose: Event handler for the ValueChanged event of the ultraTrackBar1
Notes:

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

PRIVATE ultraTree1_AfterSelect (Object, SelectEventArgs)

Purpose: Event handler for the AfterSelect event of the ultraTree1
Notes:

Parameters:
sender System.Object
The object that raised the event
e Infragistics.Win.UltraWinTree.SelectEventArgs
The SelectEventArgs with the data for this event
Top

PROTECTED UnsavedChangesChangedHandler (Object, EventArgs)

Purpose: Handles the UnsavedChangesChanged event of the BusinessEntityDatasetController
Notes:

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

PUBLIC UpdateCustomProperties (CustomPropertiesScopeEnum)

Purpose: Updates the custom properties for the currently selected object of
the given scope
Notes: Calls into the BusinessEntityDatasetController's UpdateCustomProperties
method

Parameters:
poCustomPropertiesScope Consultingwerk.BusinessEntityDesigner.Services.CustomPropertiesScopeEnum
The property scope to edit the custom properties for
Top

PUBLIC UpdateCustomProperties (CustomPropertiesScopeEnum, character)

Purpose: Updates the custom properties for the currently selected object of
the given scope
Notes: Calls into the BusinessEntityDatasetController's UpdateCustomProperties
method

Parameters:
poCustomPropertiesScope Consultingwerk.BusinessEntityDesigner.Services.CustomPropertiesScopeEnum
The property scope to edit the custom properties for
pcCustomPropertiesScopeName CHARACTER
The name of the custom properties scope
Top

PROTECTED UpdateFileLRU (character)

Purpose: Updates the LRU file list with a recently opened file name
Notes:

Parameters:
pcFileName CHARACTER
The name of the recently opened file
Top

PROTECTED UpdateRelationFields ()

Purpose: Pops up dialog for relation field mapping
Notes:

Top

PROTECTED ValidateDesign ()

Purpose: Validates the Design
Notes:

Top

PROTECTED ViewerFieldsEnabledHandler (Object, EventArgs)

Purpose: Event handler for the FieldsEnabled event of the five viewers in the
Business Entity Designer Form
Notes: Ensures that only a single property viewer is in update mode

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

PROTECTED CHARACTER WindowTitle (character)

Purpose: Returns the Title that should be shown in the title bar Business Entity Designer Form
Notes:

Parameters:
pcFileName CHARACTER
The currently open file name or ? for "untitled"
Returns CHARACTER
The Title that should be shown in the title bar


Constructor Detail
Top

PUBLIC BusinessEntityDesignerForm ()

Purpose: Constructor for the BusinessEntityDesignerForm class
Notes:



Event Detail
Top

PUBLIC ActiveSmartControlChanged DELEGATE System.EventHandler

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Raised whenever the ActiveSmartSmartControl property has changed
Notes:

Delegate: System.EventHandler
Top

PUBLIC ExternalDataSourceChanged DELEGATE System.EventHandler

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Raised when the ExternalDataSource property changes
Notes:

Delegate: System.EventHandler
Top

PUBLIC ExternalNavigationTargetChanged (Object, EventArgs)

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Raised when the ExtenalNavigationSource property changes
Notes:

Parameters:
sender Progress.Lang.Object
The object that raised the OnExternalNavigationTargetChanged event
e System.EventArgs
The System.EventArgs with the data for the event
Top

PUBLIC FormDestroyed DELEGATE System.EventHandler

Inherited from Consultingwerk.Forms.BaseForm
Purpose: Raised when a Form is destroyed (in the Destructor)
Notes:

Delegate: System.EventHandler
Top

PUBLIC GenericEvent (Object, EventArgs)

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Raised from custom logic
Notes: Support raising an event from a form 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 PrimaryDataSourceChanged DELEGATE System.EventHandler

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Raised when the PrimaryDataSource property changes
Notes:

Delegate: System.EventHandler
Top

PUBLIC PrimaryDataTargetChanged DELEGATE System.EventHandler

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Raised when the PrimaryDataTarget property changes
Notes:

Delegate: System.EventHandler
Top

PUBLIC PrimaryNavigationSourceChanged (Object, EventArgs)

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Raised when the PrimaryNavigationSource property changes
Notes:

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


Property Detail
Top

PUBLIC System.Windows.Forms.Control ActiveSmartControl

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm

Returns System.Windows.Forms.Control
Top

PROTECTED CHARACTER BindableProperties

Inherited from Consultingwerk.Forms.BaseForm

Returns CHARACTER
Top

PROTECTED CHARACTER CategorizedProperties

Inherited from Consultingwerk.Forms.BaseForm

Returns CHARACTER
Top

PROTECTED CHARACTER CategoryProperties

Inherited from Consultingwerk.Forms.BaseForm

Returns CHARACTER
Top

PUBLIC LOGICAL DeleteOnFormClosed

Inherited from Consultingwerk.Forms.BaseForm

Returns LOGICAL
Top

PUBLIC System.Collections.Generic.List <Progress.Windows.Form> DependentForms

Inherited from Consultingwerk.Forms.BaseForm

Returns System.Collections.Generic.List <Progress.Windows.Form>
Top

PROTECTED CHARACTER DescribedProperties

Inherited from Consultingwerk.Forms.BaseForm

Returns CHARACTER
Top

PROTECTED CHARACTER DescriptionProperties

Inherited from Consultingwerk.Forms.BaseForm

Returns CHARACTER
Top

PROTECTED CHARACTER DesignerVerbs

Inherited from Consultingwerk.Forms.BaseForm

Returns CHARACTER
Top

PROTECTED CHARACTER DesignerVisibilityAttributes

Inherited from Consultingwerk.Forms.BaseForm

Returns CHARACTER
Top

PROTECTED CHARACTER DesignerVisibilityProperties

Inherited from Consultingwerk.Forms.BaseForm

Returns CHARACTER
Top

PUBLIC LOGICAL DesignTime

Inherited from Consultingwerk.Forms.BaseForm

Returns LOGICAL
Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.ISmartDataSource ExternalDataSource

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm

Returns Consultingwerk.SmartComponents.Interfaces.ISmartDataSource
Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.ISmartNavigationTarget ExternalNavigationTarget

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm

Returns Consultingwerk.SmartComponents.Interfaces.ISmartNavigationTarget
Top

PUBLIC CHARACTER FileName


Returns CHARACTER
Top

PUBLIC CHARACTER FormAction

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm

Returns CHARACTER
Top

PUBLIC CHARACTER FormLogicClass

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm

Returns CHARACTER
Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.ISmartFormLogic FormLogicObject

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm

Returns Consultingwerk.SmartComponents.Interfaces.ISmartFormLogic
Top

PROTECTED CHARACTER HiddenProperties

Inherited from Consultingwerk.Forms.BaseForm

Returns CHARACTER
Top

PUBLIC LOGICAL IsClosed

Inherited from Consultingwerk.Forms.BaseForm

Returns LOGICAL
Top

PROTECTED CHARACTER NonBrowsableProperties

Inherited from Consultingwerk.Forms.BaseForm

Returns CHARACTER
Top

PUBLIC System.Windows.Forms.FormWindowState PreviousWindowState

Inherited from Consultingwerk.Forms.BaseForm

Returns System.Windows.Forms.FormWindowState
Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataSource PrimaryDataSource

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm

Returns Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataSource
Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataTarget PrimaryDataTarget

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm

Returns Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataTarget
Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.Design.IDesignNavigationSource PrimaryNavigationSource

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm

Returns Consultingwerk.SmartComponents.Interfaces.Design.IDesignNavigationSource
Top

PUBLIC LOGICAL PromptForSaveOnApplicationLeave

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm

Returns LOGICAL
Top

PUBLIC LOGICAL PromptForSaveOnFormDeactivate

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm

Returns LOGICAL
Top

PROTECTED Consultingwerk.SmartComponents.Base.SmartWindowFormController SmartWindowFormController

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm

Returns Consultingwerk.SmartComponents.Base.SmartWindowFormController
Top

PROTECTED LOGICAL StoreFormPosition

Inherited from Consultingwerk.Forms.BaseForm

Returns LOGICAL
Top

PUBLIC LOGICAL UseStartupSizeAsMinSize

Inherited from Consultingwerk.Forms.BaseForm

Returns LOGICAL
Top

PUBLIC CHARACTER WindowPositionRegistryKey

Inherited from Consultingwerk.Forms.BaseForm

Returns CHARACTER


©2006-2020 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       29.06.2022 12:39:05