Namespace: Consultingwerk.SmartComponents.Base
Class 
SmartWindowForm Copy to Clipboard
Parent classes:
Progress.Windows.Form
Consultingwerk.Forms.BaseForm
Consultingwerk.SmartComponents.Base.SmartWindowForm

Inherits: Consultingwerk.Forms.BaseForm
Implements: IBaseForm, System.ComponentModel.ICustomTypeDescriptor, Consultingwerk.SmartComponents.IHasDesignerVerbs, Consultingwerk.SmartComponents.Interfaces.ISmartWindowForm
Inherited by: Consultingwerk.Studio.LegacyGuiMigration.Browse.AblBrowseMigrationForm Consultingwerk.Studio.LegacyGuiMigration.Frame.AblFrameMigrationForm Consultingwerk.Web.Studio.Viewer.WebViewerDesignerForm Consultingwerk.BusinessEntityDesigner.UI.BusinessEntityDesignerForm Consultingwerk.BusinessEntityDesigner.UI.BusinessEntityDesignerSettingsForm Consultingwerk.BusinessEntityDesigner.UI.CustomPropertiesEditorForm Consultingwerk.BusinessEntityDesigner.UI.DataRelationFieldPickerForm Consultingwerk.BusinessEntityDesigner.UI.FieldEditorForm Consultingwerk.BusinessEntityDesigner.UI.FieldRemovedPromptForm Consultingwerk.BusinessEntityDesigner.UI.NewFieldInIncludeFileForm Consultingwerk.BusinessEntityDesigner.UI.ReorderFieldsForm Consultingwerk.SmartComponents.Base.SmartLookupDialogForm Consultingwerk.SmartComponents.Base.SmartMDIContainer Consultingwerk.SmartComponents.BaseForms.BusinessEntityAdapter.SmartMasterDetailAdapterForm Consultingwerk.SmartComponents.BaseForms.BusinessEntityAdapter.SmartSingleAdapterForm Consultingwerk.SmartComponents.BaseForms.SmartBaseDialogForm Consultingwerk.SmartComponents.BaseForms.TabFolder.SmartTabFolderForm Consultingwerk.SmartComponents.Tools.BusinessEntityBrowser.BusinessEntityBrowserForm Consultingwerk.SmartComponents.Tools.DynamicLookupDesigner.DynamicLookupDesignerForm Consultingwerk.SmartComponents.Tools.ManageClassPath.ManageClassPathForm Consultingwerk.SmartComponents.Tools.OERABusinessEntityTester.UserTableStatsForm Consultingwerk.Windows.Framework.Authentication.SmartUserMaintenanceForm Consultingwerk.Windows.Framework.Authorization.MassSecurityAssignmentForm Consultingwerk.Windows.Framework.Authorization.SmartAuthorizationAssignmentVerificationForm Consultingwerk.Windows.Framework.Authorization.SmartFieldSecurityItemForm Consultingwerk.Windows.Framework.Authorization.SmartGroupMaintenanceForm Consultingwerk.Windows.Framework.Authorization.SmartMenuSecurityMaintenanceForm Consultingwerk.Windows.Framework.Authorization.SmartSecurityAssignmentForm Consultingwerk.Windows.Framework.Authorization.SmartSecurityObjectForm Consultingwerk.Windows.Framework.Authorization.SmartSecurityRealmForm Consultingwerk.Windows.Framework.Authorization.SmartSecurityTokenForm Consultingwerk.Windows.Framework.Authorization.SmartToolbarSecurityItemForm Consultingwerk.Windows.Framework.Authorization.SmartUserAndGroupSelectionForm Consultingwerk.Windows.Framework.Localization.ResourceTranslationMaintenanceForm Consultingwerk.Windows.Framework.Menu.ReorderMenuItemsForm Consultingwerk.Windows.Framework.Menu.SmartFunctionMaintenanceForm Consultingwerk.Windows.Framework.Menu.SmartMenuMaintenanceForm Consultingwerk.Windows.Framework.Menu.SmartMenuStyleForm Consultingwerk.Windows.Framework.Menu.SmartModuleMaintenanceForm Consultingwerk.Windows.Framework.Menu.SmartProductForm Consultingwerk.Windows.Framework.Reference.MainMenuForm Consultingwerk.Windows.Framework.Repository.Class.SmartAttributeForm Consultingwerk.Windows.Framework.Repository.Class.SmartAttributeGroupForm Consultingwerk.Windows.Framework.Repository.Class.SmartClassTypeForm Consultingwerk.Windows.Framework.Repository.Class.SmartLinkTypeForm Consultingwerk.Windows.Framework.Repository.Class.SmartObjectTypeForm Consultingwerk.Windows.Framework.Repository.Customization.SmartCustomizationForm Consultingwerk.Windows.Framework.Repository.Customization.SmartCustomizationTypeForm Consultingwerk.Windows.Framework.Repository.ExportImport.ExportImportForm Consultingwerk.Windows.Framework.Repository.Field.SmartEntityFieldMappingForm Consultingwerk.Windows.Framework.Repository.Object.OpenObjectMasterDialogForm Consultingwerk.Windows.Framework.Repository.Object.ParentObjectInstanceLookupDialog Consultingwerk.Windows.Framework.Repository.Object.SmartObjectMasterForm Consultingwerk.Windows.Framework.Repository.Object.SmartObjectMasterMultiUpdateForm Consultingwerk.Windows.Framework.Repository.Rendering.DynamicForm Consultingwerk.Windows.Framework.Repository.ScreenMapping.SmartEntityTableMappingForm Consultingwerk.Windows.Framework.Repository.ScreenMapping.SmartScreenTypeForm Consultingwerk.Windows.Framework.Repository.ScreenMapping.SmartUiTypeForm Consultingwerk.Windows.Framework.Rollbase.ObjectDefinitionForm Consultingwerk.Windows.Framework.Scheduler.SmartSchedulerJobForm Consultingwerk.Windows.Framework.Scheduler.SmartSchedulerJobPlanForm Consultingwerk.Windows.Framework.Scheduler.SmartSchedulerJobStatusForm Consultingwerk.Windows.Framework.System.ExportImportMetaDataForm Consultingwerk.Windows.Framework.System.SelectRelationsToImportForm Consultingwerk.Windows.Framework.System.SmartAttachmentRoleForm Consultingwerk.Windows.Framework.System.SmartBusinessEntityForm Consultingwerk.Windows.Framework.System.SmartCommentRoleForm Consultingwerk.Windows.Framework.System.SmartDeletionForm Consultingwerk.Windows.Framework.System.SmartKeyFieldAssignmentTypeForm Consultingwerk.Windows.Framework.System.SmartLanguageMaintenanceForm Consultingwerk.Windows.Framework.System.SmartLoginCompanyMaintenanceForm Consultingwerk.Windows.Framework.System.SmartMessageForm Consultingwerk.Windows.Framework.System.SmartModifiedStateForm Consultingwerk.Windows.Framework.System.SmartRelationForm Consultingwerk.Windows.Framework.System.SmartTableForm Consultingwerk.Windows.Framework.System.SmartTranslationForm Consultingwerk.Windows.Framework.System.SmartUiTranslationForm Consultingwerk.Windows.Framework.System.SmartValueListForm Consultingwerk.Windows.Framework.System.TranslateFromSourceCodeDialog Consultingwerk.Windows.Framework.Web.SmartRouteForm Consultingwerk.Windows.Framework.Workflow.SmartWorkflowForm

File:SmartWindowForm
Purpose:Base class for SmartComponent Library Forms
Author(s):Marko Rüterbories / Consultingwerk Ltd.
Created:Wed Jun 17 08:58:39 CEST 2009
/* Mike Fechner, Consultingwerk Ltd. 13.09.2017
Preprocessor variables for SmartComponentLibrary, WinKit and SmartFramework
based on Consultingwerk/packages.i now

Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
+ ActivateLinks (Control) Activates the Links between the active control and the SmartToolbarController
+ ActivateSmartControl (Control) Marks a SmartViewerControl or SmartBrowserControl as Active
+ LOGICAL CanFindInComponentsCollection (Object) Returns if the component can be found in the ComponentsCollection
Inherited from Consultingwerk.Forms.BaseForm
# 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
- DeactivateHandler (Object, EventArgs) Event handler for the Deactivate event
- DeactivateTimerTick (Object, EventArgs) Handles the Tick of the Deactivate Timer component
# DesignerInsertUserControl () Inserts a user control instance at design time.
Inherited from Consultingwerk.Forms.BaseForm
+ DisablePagesInFolder (character) Disables a list of pages
+ EnableDisablePagesInFolder (character, logical) Enables or Disables a list of pages
+ EnablePagesInFolder (character) Enables a list of pages
+ 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
+ System.Collections.Generic.List <System.ComponentModel.Component> GetAllComponents () Returns a List of all Components in the Form
Inherited from Consultingwerk.Forms.BaseForm
+ System.ComponentModel.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
+ System.ComponentModel.TypeConverter GetConverter () Returns a type converter for this instance of a component.
Inherited from Consultingwerk.Forms.BaseForm
+ System.ComponentModel.EventDescriptor GetDefaultEvent () Returns the default event for this instance of a component.
Inherited from Consultingwerk.Forms.BaseForm
+ System.ComponentModel.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
+ System.ComponentModel.EventDescriptorCollection GetEvents () Returns the events for this instance of a component.
Inherited from Consultingwerk.Forms.BaseForm
+ System.ComponentModel.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
+ Consultingwerk.SmartComponents.Base.ListSmartDataAdapter GetLinkedDataAdapters (SmartDataAdapter) Returns a List of Data Adapter instances in the Form
# GetLinkedDataAdapters (SmartDataAdapter, ListSmartDataAdapter) Add linked SmartDataAdapter instances to a List
+ System.ComponentModel.PropertyDescriptorCollection GetProperties () Returns the properties for this instance of a component.
Inherited from Consultingwerk.Forms.BaseForm
+ System.ComponentModel.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
# InitializeFormLogicObject () Initializes the Form Logic Object
# 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
# OnActiveSmartControlChanged (EventArgs) Raises the ActiveSmartControlChanged event
# OnExternalDataSourceChanged (EventArgs) Raises the ExternalDataSourceChanged event
# OnExternalNavigationTargetChanged (EventArgs) Raises the OnExternalNavigationTargetChanged
# OnFormClosed (FormClosedEventArgs) Raises the FormClosed event
Overrides Consultingwerk.Forms.BaseForm:OnFormClosed (FormClosedEventArgs)
# OnFormClosing (FormClosingEventArgs) Checks wheather it is ok to close the form. If not the FormClosing process is canceled.
Overrides Consultingwerk.Forms.BaseForm:OnFormClosing (FormClosingEventArgs)
# OnFormDestroyed (EventArgs) Raises the FormDestroyed event
Inherited from Consultingwerk.Forms.BaseForm
# OnLoad (EventArgs) Raises the Load event
Overrides Consultingwerk.Forms.BaseForm:OnLoad (EventArgs)
# OnPrimaryDataSourceChanged (EventArgs) Raises the PrimaryDataSourceChanged event
# OnPrimaryDataTargetChanged (EventArgs) Raises the PrimaryDataTargetChanged event
# OnPrimaryNavigationSourceChanged (EventArgs) Raises the PrimaryNavigationSourceChanged
# OnSmartToolbarControllerChanged () Internal event handler
+ OnVerbClicked (character) Event Handler method for Designer Verbs
Inherited from Consultingwerk.Forms.BaseForm
+ Consultingwerk.Framework.Enum.DialogResultEnum PromptForSaveOfPendingChangesOnClose () Shows the Prompt to save pending transactions to the backend while closing the Form
+ LOGICAL RecurseCheckIsOkToClose (Control+ControlCollection, logical, CloseReason) Recursivly ask all Controls implementing the ICheckOkToClose Interface wheather it is ok to close the form.
# LOGICAL RecurseSaveChangesOnDeactivateForm (Control+ControlCollection, logical) Recursively checks all contained controls to save changes on Deactivate of the Form
# 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
- SetDesignerProperties () Sets Properties to customize Visual Designer behaviour
# 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

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

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

Top Property Summary
Options Name Purpose
+ System.Windows.Forms.Control ActiveSmartControl
# 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
+ Consultingwerk.SmartComponents.Interfaces.ISmartNavigationTarget ExternalNavigationTarget
+ CHARACTER FormAction
+ CHARACTER FormLogicClass
+ Consultingwerk.SmartComponents.Interfaces.ISmartFormLogic FormLogicObject
# 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
+ Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataTarget PrimaryDataTarget
+ Consultingwerk.SmartComponents.Interfaces.Design.IDesignNavigationSource PrimaryNavigationSource
+ LOGICAL PromptForSaveOnApplicationLeave
+ LOGICAL PromptForSaveOnFormDeactivate
# 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 ActivateLinks (Control)
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

PUBLIC ActivateSmartControl (Control)
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

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

PRIVATE DeactivateHandler (Object, EventArgs)
Purpose: Event handler for the Deactivate event
Notes: Enables the times for the PromptForSaveOnFormDeactivate or
PromptForSaveOnApplicationLeave. Used to be OnDeactivate method
override, but that did lead to crashes at some customers on 11.1.0.005

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 DeactivateTimerTick (Object, EventArgs)
Purpose: Handles the Tick of the Deactivate Timer component
Notes:

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

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

Top

PUBLIC DisablePagesInFolder (character)
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 EnableDisablePagesInFolder (character, logical)
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)
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 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 System.ComponentModel.AttributeCollection GetAttributes ()
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns a collection of custom attributes for this instance of a
component.
Notes:

Returns System.ComponentModel.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 System.ComponentModel.TypeConverter GetConverter ()
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns a type converter for this instance of a component.
Notes:

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

PUBLIC System.ComponentModel.EventDescriptor GetDefaultEvent ()
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns the default event for this instance of a component.
Notes:

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

PUBLIC System.ComponentModel.PropertyDescriptor GetDefaultProperty ()
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns the default property for this instance of a component.
Notes:

Returns System.ComponentModel.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 System.ComponentModel.EventDescriptorCollection GetEvents ()
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns the events for this instance of a component.
Notes:

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

PUBLIC System.ComponentModel.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 System.ComponentModel.EventDescriptorCollection
The System.ComponentModel.EventDescriptorCollection describing the events of the component
Top

PUBLIC Consultingwerk.SmartComponents.Base.ListSmartDataAdapter GetLinkedDataAdapters ()
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)
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)
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 System.ComponentModel.PropertyDescriptorCollection GetProperties ()
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns the properties for this instance of a component.
Notes:

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

PUBLIC System.ComponentModel.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 System.ComponentModel.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 System.ComponentModel.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 ()
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 InitializeFormLogicObject ()
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 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 OnActiveSmartControlChanged (EventArgs)
Purpose: Raises the ActiveSmartControlChanged event
Notes:

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

PROTECTED OnExternalDataSourceChanged (EventArgs)
Purpose: Raises the ExternalDataSourceChanged event
Notes:

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

PROTECTED OnExternalNavigationTargetChanged (EventArgs)
Purpose: Raises the OnExternalNavigationTargetChanged
Notes:

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

PROTECTED OnFormClosed (FormClosedEventArgs)
Overrides Consultingwerk.Forms.BaseForm: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.Forms.BaseForm:OnFormClosing (FormClosingEventArgs)
Purpose: Checks wheather it is ok to close the form. If not the FormClosing
process is canceled.
Notes:

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 OnLoad (EventArgs)
Overrides Consultingwerk.Forms.BaseForm:OnLoad (EventArgs)
Purpose: Raises the Load event
Notes: Passes though the ExternalDataSource to the PrimaryDataTarget

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

PROTECTED OnPrimaryDataSourceChanged (EventArgs)
Purpose: Raises the PrimaryDataSourceChanged event
Notes:

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

PROTECTED OnPrimaryDataTargetChanged (EventArgs)
Purpose: Raises the PrimaryDataTargetChanged event
Notes:

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

PROTECTED OnPrimaryNavigationSourceChanged (EventArgs)
Purpose: Raises the PrimaryNavigationSourceChanged
Notes:

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

PROTECTED OnSmartToolbarControllerChanged ()
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 Consultingwerk.Framework.Enum.DialogResultEnum PromptForSaveOfPendingChangesOnClose ()
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 LOGICAL RecurseCheckIsOkToClose (Control+ControlCollection, logical, CloseReason)
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)
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 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

PRIVATE SetDesignerProperties ()
Purpose: Sets Properties to customize Visual Designer behaviour
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

PROTECTED 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:



Constructor Detail
Top

PUBLIC SmartWindowForm ()
Purpose: Constructor for the SmartWindowForm class
Notes:



Event Detail
Top

PUBLIC ActiveSmartControlChanged DELEGATE System.EventHandler
Purpose: Raised whenever the ActiveSmartSmartControl property has changed
Notes:

Delegate: System.EventHandler
Top

PUBLIC ExternalDataSourceChanged DELEGATE System.EventHandler
Purpose: Raised when the ExternalDataSource property changes
Notes:

Delegate: System.EventHandler
Top

PUBLIC ExternalNavigationTargetChanged (Object, EventArgs)
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 PrimaryDataSourceChanged DELEGATE System.EventHandler
Purpose: Raised when the PrimaryDataSource property changes
Notes:

Delegate: System.EventHandler
Top

PUBLIC PrimaryDataTargetChanged DELEGATE System.EventHandler
Purpose: Raised when the PrimaryDataTarget property changes
Notes:

Delegate: System.EventHandler
Top

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

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

Returns Consultingwerk.SmartComponents.Interfaces.ISmartDataSource
Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.ISmartNavigationTarget ExternalNavigationTarget

Returns Consultingwerk.SmartComponents.Interfaces.ISmartNavigationTarget
Top

PUBLIC CHARACTER FormAction

Returns CHARACTER
Top

PUBLIC CHARACTER FormLogicClass

Returns CHARACTER
Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.ISmartFormLogic FormLogicObject

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

Returns Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataSource
Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataTarget PrimaryDataTarget

Returns Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataTarget
Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.Design.IDesignNavigationSource PrimaryNavigationSource

Returns Consultingwerk.SmartComponents.Interfaces.Design.IDesignNavigationSource
Top

PUBLIC LOGICAL PromptForSaveOnApplicationLeave

Returns LOGICAL
Top

PUBLIC LOGICAL PromptForSaveOnFormDeactivate

Returns LOGICAL
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       04.02.2020 23:16:34