Namespace: Consultingwerk.Windows.Framework.Repository.Rendering
Class 
DynamicFormWithRibbon Copy to Clipboard
Parent classes:
Inherits: Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
Implements: IBaseForm, ICheckOkToClose, ICustomTypeDescriptor, IFormSupportsHelp, IFormWithHash, IFormWithUltraDockManager, IHasDesignerVerbs, IHasPrimaryDataSourceAndTarget, IHasSecurityKey, ISmartToolbarTarget, ISmartWindowForm, Consultingwerk.Windows.Framework.Repository.Rendering.ITabFolderParent

File:DynamicFormWithRibbon
Purpose:Default DynamicForm implementation
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Sun Nov 06 12:18:54 CET 2022
Notes:As of SCL-3843 this class is used as the foundation for
rendering of default dynamic forms



Top Method Summary
Options Name Purpose
# ActivateLinks (integer) Activates links of the given tab page
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
+ ActivateLinks (Control) Activates the Links between the active control and the SmartToolbarController
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
# ActivateNavigationLink (integer) Activates Navigation links of the given tab page
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
+ ActivateSmartControl (Control) Marks a SmartViewerControl or SmartBrowserControl as Active
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
# ActivateTableIoLink (integer) Activates TableIO links of the given tab page
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
+ LOGICAL CanFindInComponentsCollection (Object) Returns if the component can be found in the ComponentsCollection
Inherited from Consultingwerk.Forms.BaseForm
# ChildSmartTableIOStateChangedHandler (Object, SmartTableIOStateChangedEventArgs) Event handler for the SmartTableIOStateChanged event of the contained SmartViewer and SmartUpdatableBrowser instances
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ ClearRibbon () Clears the Ribbon
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
# 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
+ DisablePagesInFolder (character) Disables a list of pages
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
# DisplayDirtyState () Displays the DirtyState in the Window Title
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ DoFormAction (character) Executes the Form Action
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
+ 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
+ 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
+ System.Collections.Generic.List <Progress.Windows.Form> FindDynamicFormInstances (character) Returns a list of DynamicForms of the given object master
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
+ 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
+ System.ComponentModel.Component GetInstance (character) Returns the reference to the instance with the provided name
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
+ System.Collections.Generic.List <System.ComponentModel.Component> GetInstances (integer, Class) Returns a List of components of the given type on the given page
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
+ ListSmartDataAdapter GetLinkedDataAdapters () Returns a List of Data Adapter instances in the Form
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ 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
+ SmartBusinessEntityAdapter GetSmartBusinessEntityAdapterInstance (character) Returns the reference to the instance with the provided name as a SmartBusinessEntityAdapter
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
+ SmartDataBrowser GetSmartDataBrowserInstance (character) Returns the reference to the instance with the provided name as a SmartDataBrowser
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
+ SmartDatasetAdapter GetSmartDatasetAdapterInstance (character) Returns the reference to the instance with the provided name as a SmartDatasetAdapter
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
+ SmartToolbarController GetSmartToolbarControllerInstance (character) Returns the reference to the instance with the provided name as a SmartToolbarController
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
+ SmartViewerControl GetSmartViewerControlInstance (character) Returns the reference to the instance with the provided name as a SmartViewerControl
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
+ ISmartToolbarControl GetToolbar () Returns the reference to the ISmartToolbarControl of the ISmartWindowForm
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ UltraTabControl GetUltraTabControlInstance (character) Returns the reference to the instance with the provided name as a UltraTabControl
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
- InitializeComponent () Initializes the Visual Design
# UltraDockManager InitializeDockManager () Initializes the UltraDockManager instance
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
# InitializeFormLogicObject () Initializes the Form Logic Object
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
# InitializeTabFolderEvents (UltraTabControl) Initializes the Tab Folder event handler
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
# LOGICAL IsGrid (Object) Returns if the provided object is a grid
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
+ 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.
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
# LOGICAL IsTabFolder (Object) Returns if the provided object is a tab folder
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
# KeyDownHandler (Object, KeyEventArgs) Event handler for the KeyDown event of the Form
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
# 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
# IHelpRegistry NewHelpRegistry () Factory method for IHelpRegistry instance
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
# OnActiveSmartControlChanged (EventArgs) Raises the ActiveSmartControlChanged event
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
# OnDirtyStateChanged (EventArgs) Raises the DirtyStateChanged
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.Windows.Framework.Repository.Rendering.DynamicForm:OnFormClosed (FormClosedEventArgs)
# OnFormClosing (FormClosingEventArgs) Raises the FormClosing event
Overrides Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm: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.Windows.Framework.Repository.Rendering.DynamicForm:OnLoad (EventArgs)
# OnPageInitializing (PageInitializingEventArgs) Raises the PageInitializing event
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
# 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
Overrides Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm:OnShown (EventArgs)
# OnSmartToolbarControllerChanged () Internal event handler
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ OnVerbClicked (character) Event Handler method for Designer Verbs
Inherited from Consultingwerk.Forms.BaseForm
+ OpenDetailFormHandler (Object, OpenDetailFormEventArgs) Event handler for the OpenDetailForm of a Grid
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
+ LOGICAL OpenHelpPage () Opens the Help Page for the currently focussed Control
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
+ 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 RaiseToolbarAction (Object, ToolClickEventArgs, character) Executes a Toolbar Action
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ ReceiveInstances (table) Receives a copy of the temp-table with the rendered instances
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
+ LOGICAL RecurseCheckIsOkToClose (Control+ControlCollection, logical, CloseReason) Recursively ask all Controls implementing the ICheckOkToClose Interface whether 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
# RecurseSubscribeDirtyStateEvents (Control) Subscribes to the SmartTableIOStateChanged events of Viewers and SmartUpdatableBrowsers
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ RegisterHelp (Object, handle) Registers Help URL and/or Help Text for a Control or Component in the Form
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
+ RegisterPage (character, integer, character) Registers a page with the DynamicForm
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
+ RegisterToolbarButtonHandler (UltraToolbarsManager, character, character) Registers a handler for the ToolClick event of a specific button
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
# RemoveSetting (character) Removes a stored setting
Inherited from Consultingwerk.Forms.BaseForm
# 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
# SelectedPageChangedHandler (Object, TabEventArgs) Event handler for the SelectedPageChangedHandler event
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
# SelectedPageChangingHandler (Object, SelectedTabChangingEventArgs) Event handler for the SelectedPageChangingHandler event
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
# SmartWindowFormToolClickHandler (Object, ToolClickEventArgs) Event handler for the ToolClick event
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
# 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
# SubscribeDirtyStateEvents () Subscribes to the SmartTableIOStateChanged events of Viewers and SmartUpdatableBrowsers
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
# SuspendSTAThreadWarning (UltraDockManager) Suspends STAThread warnings for an UltraDockManager instance
Inherited from Consultingwerk.Forms.BaseForm

Top Constructor Summary
Options Name Purpose
+ DynamicFormWithRibbon () Constructor for the DynamicFormWithRibbon class
+ DynamicFormWithRibbon (character, character) Constructor for the DynamicFormWithRibbon class

Top Event Summary
Options Name Purpose
+ ActiveSmartControlChanged DELEGATE System.EventHandler Raised whenever the ActiveSmartSmartControl property has changed
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ DirtyStateChanged (Object, EventArgs) Raised when the DirtyState of the Window has changes
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 ExternalNavigationSource 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
+ PageInitializing (Object, PageInitializingEventArgs) Raised when a page is initialized, i.e. before it's shown for the first time
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
+ 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
+ LOGICAL AutomaticNavigationLinks
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
+ LOGICAL AutomaticTableIoLinks
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
# CHARACTER BindableProperties
Inherited from Consultingwerk.Forms.BaseForm
# CHARACTER CategorizedProperties
Inherited from Consultingwerk.Forms.BaseForm
# CHARACTER CategoryProperties
Inherited from Consultingwerk.Forms.BaseForm
+ CHARACTER CharacterParameterValue
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
+ System.ComponentModel.IContainer ComponentContainer
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
+ 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
+ LOGICAL DirtyState
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ UltraDockManager DockManager
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
+ ISmartDataSource ExternalDataSource
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ ISmartNavigationTarget ExternalNavigationTarget
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ UltraPanel FillPanel
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
+ CHARACTER FormAction
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ RAW FormHash
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
+ CHARACTER FormLogicClass
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ ISmartFormLogic FormLogicObject
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ IHelpRegistry HelpRegistry
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
# CHARACTER HiddenProperties
Inherited from Consultingwerk.Forms.BaseForm
+ CHARACTER IconFileName
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
+ CHARACTER IconFileNameWeb
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
+ LOGICAL IsClosed
Inherited from Consultingwerk.Forms.BaseForm
# CHARACTER NonBrowsableProperties
Inherited from Consultingwerk.Forms.BaseForm
+ CHARACTER ObjectMasterName
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
+ 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
+ CHARACTER SecurityKey
Inherited from Consultingwerk.Forms.BaseForm
+ ISmartToolbarSource SmartToolbarSource
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
# SmartWindowFormController SmartWindowFormController
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ LOGICAL StoreDockManagerSettings
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
# LOGICAL StoreFormPosition
Inherited from Consultingwerk.Forms.BaseForm
+ LOGICAL SupportsDirtyState
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ SmartToolbarController ToolbarController
Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
+ LOGICAL UseStartupSizeAsMinSize
Inherited from Consultingwerk.Forms.BaseForm
+ CHARACTER WindowPositionRegistryKey
Inherited from Consultingwerk.Forms.BaseForm


Method Detail
Top

PROTECTED ActivateLinks (integer)

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
Purpose: Activates links of the given tab page
Notes:

Parameters:
piPage INTEGER
The page number to activate links for
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 ActivateNavigationLink (integer)

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
Purpose: Activates Navigation links of the given tab page
Notes:

Parameters:
piPage INTEGER
The page number to activate links for
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 ActivateTableIoLink (integer)

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
Purpose: Activates TableIO links of the given tab page
Notes:

Parameters:
piPage INTEGER
The page number to activate links for
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 ChildSmartTableIOStateChangedHandler (Object, SmartTableIOStateChangedEventArgs)

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Event handler for the SmartTableIOStateChanged event of the contained
SmartViewer and SmartUpdatableBrowser instances
Notes:

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

PUBLIC ClearRibbon ()

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
Purpose: Clears the Ribbon
Notes: Only executes this once to support multiple MetaToolbar instances to
share the Ribbon

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

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

PROTECTED DisplayDirtyState ()

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Displays the DirtyState in the Window Title
Notes:

Top

PUBLIC DoFormAction (character)

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
Purpose: Executes the Form Action
Notes:

Parameters:
pcAction CHARACTER
The FormAction to execute
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 enabled 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

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

PUBLIC System.Collections.Generic.List <Progress.Windows.Form> FindDynamicFormInstances (character)

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
Purpose: Returns a list of DynamicForms of the given object master
Notes:

Parameters:
pcObjectMasterName CHARACTER
The name of the repository object master to locate
Returns System.Collections.Generic.List <Progress.Windows.Form>
The .NET Generic List of Form instances
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 System.ComponentModel.Component GetInstance (character)

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
Purpose: Returns the reference to the instance with the provided name
Notes:

Parameters:
pcInstanceName CHARACTER
The name of the instance to locate
Returns System.ComponentModel.Component
The reference to the Component
Top

PUBLIC System.Collections.Generic.List <System.ComponentModel.Component> GetInstances (integer, Class)

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
Purpose: Returns a List of components of the given type on the given page
Notes:

Parameters:
piPage INTEGER
The page number to return instances from
poType Progress.Lang.Class
The Progress.Lang.Class specifying which instances to return
Returns System.Collections.Generic.List <System.ComponentModel.Component>
The reference to the Component
Top

PUBLIC 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 ListSmartDataAdapter
The List of Data Adapter instances
Top

PUBLIC 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 SmartDataAdapter
An optional reference to a SmartDataAdapter to use as the starting point
Returns 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 GetLinkedDataAdapters (poStart)

Parameters:
poStart SmartDataAdapter
The reference to a SmartDataAdapter to use as the starting point
poList 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 SmartBusinessEntityAdapter GetSmartBusinessEntityAdapterInstance (character)

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
Purpose: Returns the reference to the instance with the provided name as a SmartBusinessEntityAdapter
Notes:

Parameters:
pcInstanceName CHARACTER
The name of the instance to locate
Returns SmartBusinessEntityAdapter
The reference to the Component
Top

PUBLIC SmartDataBrowser GetSmartDataBrowserInstance (character)

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
Purpose: Returns the reference to the instance with the provided name as a SmartDataBrowser
Notes:

Parameters:
pcInstanceName CHARACTER
The name of the instance to locate
Returns SmartDataBrowser
The reference to the Component
Top

PUBLIC SmartDatasetAdapter GetSmartDatasetAdapterInstance (character)

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
Purpose: Returns the reference to the instance with the provided name as a SmartDatasetAdapter
Notes:

Parameters:
pcInstanceName CHARACTER
The name of the instance to locate
Returns SmartDatasetAdapter
The reference to the Component
Top

PUBLIC SmartToolbarController GetSmartToolbarControllerInstance (character)

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
Purpose: Returns the reference to the instance with the provided name as a SmartToolbarController
Notes:

Parameters:
pcInstanceName CHARACTER
The name of the instance to locate
Returns SmartToolbarController
The reference to the Component
Top

PUBLIC SmartViewerControl GetSmartViewerControlInstance (character)

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
Purpose: Returns the reference to the instance with the provided name as a SmartViewerControl
Notes:

Parameters:
pcInstanceName CHARACTER
The name of the instance to locate
Returns SmartViewerControl
The reference to the Component
Top

PUBLIC ISmartToolbarControl GetToolbar ()

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

Returns ISmartToolbarControl
The reference to the ISmartToolbarControl of the ISmartWindowForm
Top

PUBLIC UltraTabControl GetUltraTabControlInstance (character)

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
Purpose: Returns the reference to the instance with the provided name as a UltraTabControl
Notes:

Parameters:
pcInstanceName CHARACTER
The name of the instance to locate
Returns UltraTabControl
The reference to the Component
Top

PRIVATE InitializeComponent ()

Purpose: Initializes the Visual Design
Notes:

Top

PROTECTED UltraDockManager InitializeDockManager ()

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
Purpose: Initializes the UltraDockManager instance
Notes:

Returns UltraDockManager
The UltraDockManager instance
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 InitializeTabFolderEvents (UltraTabControl)

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
Purpose: Initializes the Tab Folder event handler
Notes:

Parameters:
poTabControl UltraTabControl
The reference to the UltraTabControl instance
Top

PROTECTED LOGICAL IsGrid (Object)

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
Purpose: Returns if the provided object is a grid
Notes:

Parameters:
poObject Progress.Lang.Object
The object reference to verify
Returns LOGICAL
Logical value indicating if the object is a grid
Top

PUBLIC LOGICAL IsOkToClose (logical, CloseReason)

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
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 IsTabFolder (Object)

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
Purpose: Returns if the provided object is a tab folder
Notes:

Parameters:
poObject Progress.Lang.Object
The object reference to verify
Returns LOGICAL
Logical value indicating if the object is a tab folder
Top

PROTECTED KeyDownHandler (Object, KeyEventArgs)

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
Purpose: Event handler for the KeyDown event of the Form
Notes: Previous keys

Parameters:
sender System.Object
The reference to the component that raised the event
e System.Windows.Forms.KeyEventArgs
The KeyEventArgs with the data for this event
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 IHelpRegistry NewHelpRegistry ()

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
Purpose: Factory method for IHelpRegistry instance
Notes: Returns new instance of HelpRegistry

Returns IHelpRegistry
The reference to the new IHelpRegistry instance
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 OnDirtyStateChanged (EventArgs)

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

Parameters:
e Consultingwerk.EventArgs
The Consultingwerk.EventArgs with the data for the 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.Windows.Framework.Repository.Rendering.DynamicForm: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.Windows.Framework.Repository.Rendering.DynamicForm:OnFormClosing (FormClosingEventArgs)
Purpose: Raises the FormClosing event
Notes: Invoked when the Form is about to be closed

Parameters:
e System.Windows.Forms.FormClosingEventArgs
A FormClosingEventArgs that contains the event data.
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.Windows.Framework.Repository.Rendering.DynamicForm:OnLoad (EventArgs)
Purpose: Raises the Load event
Notes: Invoked when a Form is displayed for the first time

Parameters:
e System.EventArgs
An EventArgs that contains the event data.
Top

PROTECTED OnPageInitializing (PageInitializingEventArgs)

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
Purpose: Raises the PageInitializing event
Notes:

Parameters:
e PageInitializingEventArgs
The PageInitializingEventArgs with the data for the 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)

Overrides Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm: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

PUBLIC OpenDetailFormHandler (Object, OpenDetailFormEventArgs)

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
Purpose: Event handler for the OpenDetailForm of a Grid
Notes: Opens the DetailForm for a Grid

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

PUBLIC LOGICAL OpenHelpPage ()

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
Purpose: Opens the Help Page for the currently focussed Control
Notes:

Returns LOGICAL
Logical value indicating if a help page was opened
Top

PUBLIC 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 behavior

Returns 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 package-protected
as it's only meant to be used from the SmartFormLogic class

Parameters:
e Consultingwerk.EventArgs
The Consultingwerk.EventArgs
Top

PUBLIC LOGICAL RaiseToolbarAction (Object, ToolClickEventArgs, character)

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Executes a Toolbar Action
Notes:

Parameters:
sender System.Object
The reference to the control that raised the ToolClick event
e 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

PUBLIC ReceiveInstances (table)

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
Purpose: Receives a copy of the temp-table with the rendered instances
Notes:

Parameters:
ttInstances TEMP-TABLE ttInstances
The temp-table with the temp-tables (BY-REFERENCE)
Top

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

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Recursively ask all Controls implementing the ICheckOkToClose Interface
whether 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 RecurseSubscribeDirtyStateEvents (Control)

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Subscribes to the SmartTableIOStateChanged events of Viewers
and SmartUpdatableBrowsers
Notes:

Parameters:
poControl System.Windows.Forms.Control
The current control
Top

PUBLIC RegisterHelp (Object, handle)

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
Purpose: Registers Help URL and/or Help Text for a Control or Component in the Form
Notes:

Parameters:
poControl System.Object
The reference to the Control or Component
phBuffer HANDLE
The handle of the buffer with the attribute values
Top

PUBLIC RegisterPage (character, integer, character)

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
Purpose: Registers a page with the DynamicForm
Notes:

Parameters:
pcPageGuid CHARACTER
The GUID of the Page
piPageSequence INTEGER
The Page Sequence
pcPageLabel CHARACTER
The Page Label
Top

PUBLIC RegisterToolbarButtonHandler (UltraToolbarsManager, character, character)

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Registers a handler for the ToolClick event of a specific button
Notes:

Parameters:
poToolbarsManager UltraToolbarsManager
The reference to the UltraToolbarsManager instance
pcToolbaseButtonKey CHARACTER
The name of the toolbar button
pcHandlerName CHARACTER
The method name of the event handler method
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 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 SelectedPageChangedHandler (Object, TabEventArgs)

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
Purpose: Event handler for the SelectedPageChangedHandler event
Notes:

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

PROTECTED SelectedPageChangingHandler (Object, SelectedTabChangingEventArgs)

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
Purpose: Event handler for the SelectedPageChangingHandler event
Notes:

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

PROTECTED SmartWindowFormToolClickHandler (Object, ToolClickEventArgs)

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Event handler for the ToolClick event
Notes:

Parameters:
sender System.Object
The reference to the event that raised the event
e ToolClickEventArgs
The ToolClickEventArgs with the data for this event
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 SubscribeDirtyStateEvents ()

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Subscribes to the SmartTableIOStateChanged events of Viewers
and SmartUpdatableBrowsers
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 UltraDockManager
The reference to the UltraDockManager


Constructor Detail
Top

PUBLIC DynamicFormWithRibbon ()

Purpose: Constructor for the DynamicFormWithRibbon class
Notes:

Top

PUBLIC DynamicFormWithRibbon (character, character)

Purpose: Constructor for the DynamicFormWithRibbon class
Notes:

Parameters:
pcObjectMasterName CHARACTER
The name of the repository object master
pcCharacterParameterValue CHARACTER
The value of the character startup parameter


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

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Raised when the DirtyState of the Window has changes
Notes:

Parameters:
sender Progress.Lang.Object
The object that raised the DirtyStateChanged event
e Consultingwerk.EventArgs
The Consultingwerk.EventArgs with the data for the event
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 ExternalNavigationSource 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 PageInitializing (Object, PageInitializingEventArgs)

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm
Purpose: Raised when a page is initialized, i.e. before it's shown for the
first time
Notes:

Parameters:
sender Progress.Lang.Object
The object that raised the PageInitializing event
e PageInitializingEventArgs
The PageInitializingEventArgs 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

PUBLIC LOGICAL AutomaticNavigationLinks

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm

Returns LOGICAL
Top

PUBLIC LOGICAL AutomaticTableIoLinks

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm

Returns LOGICAL
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 CHARACTER CharacterParameterValue

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm

Returns CHARACTER
Top

PUBLIC System.ComponentModel.IContainer ComponentContainer

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm

Returns System.ComponentModel.IContainer
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 LOGICAL DirtyState

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm

Returns LOGICAL
Top

PUBLIC UltraDockManager DockManager

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm

Returns UltraDockManager
Top

PUBLIC ISmartDataSource ExternalDataSource

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm

Returns ISmartDataSource
Top

PUBLIC ISmartNavigationTarget ExternalNavigationTarget

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm

Returns ISmartNavigationTarget
Top

PUBLIC UltraPanel FillPanel

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm

Returns UltraPanel
Top

PUBLIC CHARACTER FormAction

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm

Returns CHARACTER
Top

PUBLIC RAW FormHash

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm

Returns RAW
Top

PUBLIC CHARACTER FormLogicClass

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm

Returns CHARACTER
Top

PUBLIC ISmartFormLogic FormLogicObject

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm

Returns ISmartFormLogic
Top

PUBLIC IHelpRegistry HelpRegistry

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm

Returns IHelpRegistry
Top

PROTECTED CHARACTER HiddenProperties

Inherited from Consultingwerk.Forms.BaseForm

Returns CHARACTER
Top

PUBLIC CHARACTER IconFileName

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm

Returns CHARACTER
Top

PUBLIC CHARACTER IconFileNameWeb

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm

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 CHARACTER ObjectMasterName

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm

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

PUBLIC CHARACTER SecurityKey

Inherited from Consultingwerk.Forms.BaseForm

Returns CHARACTER
Top

PUBLIC ISmartToolbarSource SmartToolbarSource

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm

Returns ISmartToolbarSource
Top

PROTECTED SmartWindowFormController SmartWindowFormController

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm

Returns SmartWindowFormController
Top

PUBLIC LOGICAL StoreDockManagerSettings

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm

Returns LOGICAL
Top

PROTECTED LOGICAL StoreFormPosition

Inherited from Consultingwerk.Forms.BaseForm

Returns LOGICAL
Top

PUBLIC LOGICAL SupportsDirtyState

Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm

Returns LOGICAL
Top

PUBLIC SmartToolbarController ToolbarController

Inherited from Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm

Returns SmartToolbarController
Top

PUBLIC LOGICAL UseStartupSizeAsMinSize

Inherited from Consultingwerk.Forms.BaseForm

Returns LOGICAL
Top

PUBLIC CHARACTER WindowPositionRegistryKey

Inherited from Consultingwerk.Forms.BaseForm

Returns CHARACTER


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       19.11.2023 16:53:13