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

Inherits: Consultingwerk.SmartComponents.Base.SmartWindowForm
Implements: IBaseForm, ICustomTypeDescriptor, IHasDesignerVerbs, ISmartWindowForm

File:SmartMasterDetailAdapterForm
Purpose:Simple SmartWindowForm template with a single
SmartBusinessEntityAdapter instance, a SmartDataBrowser
and space for a SmartViewerControl
Syntax:See SCL-580
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Mon Dec 08 14:33:33 CET 2014
Notes:This Form is not intended to be executed on it's own. This
form is only intended to be used as a base for inheriting
Forms.
As the .NET Visual Designer does not support visual
inheritance from abstract classes, this class is not marked
as abstract.
http://confluence.consultingwerkcloud.com/wiki/display/SCL/Using+Visual+Base+From+classes

Navigate to: Methods | Constructors | Events | Properties



Top Method Summary
Options Name Purpose
+ ActivateLinks (Control) Activates the Links between the active control and the SmartToolbarController
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ ActivateSmartControl (Control) Marks a SmartViewerControl or SmartBrowserControl as Active
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ 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
# DesignerInsertUserControl () Inserts a user control instance at design time.
Inherited from Consultingwerk.Forms.BaseForm
+ 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
+ AttributeCollection GetAttributes () Returns a collection of custom attributes for this instance of a component.
Inherited from Consultingwerk.Forms.BaseForm
+ CHARACTER GetClassName () Returns the class name of this instance of a component.
Inherited from Consultingwerk.Forms.BaseForm
+ CHARACTER GetComponentName () Returns the name of this instance of a component.
Inherited from Consultingwerk.Forms.BaseForm
+ TypeConverter GetConverter () Returns a type converter for this instance of a component.
Inherited from Consultingwerk.Forms.BaseForm
+ EventDescriptor GetDefaultEvent () Returns the default event for this instance of a component.
Inherited from Consultingwerk.Forms.BaseForm
+ PropertyDescriptor GetDefaultProperty () Returns the default property for this instance of a component.
Inherited from Consultingwerk.Forms.BaseForm
+ System.Object GetEditor (Type) Returns an editor of the specified type for this instance of a component.
Inherited from Consultingwerk.Forms.BaseForm
+ EventDescriptorCollection GetEvents () Returns the events for this instance of a component.
Inherited from Consultingwerk.Forms.BaseForm
+ EventDescriptorCollection GetEvents (Attribute[]) Returns the events for this instance of a component using the specified attribute array as a filter.
Inherited from Consultingwerk.Forms.BaseForm
+ Consultingwerk.SmartComponents.Base.ListSmartDataAdapter GetLinkedDataAdapters () Returns a List of Data Adapter instances in the Form
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ Consultingwerk.SmartComponents.Base.ListSmartDataAdapter GetLinkedDataAdapters (SmartDataAdapter) Returns a List of Data Adapter instances in the Form
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
# GetLinkedDataAdapters (SmartDataAdapter, ListSmartDataAdapter) Add linked SmartDataAdapter instances to a List
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ PropertyDescriptorCollection GetProperties () Returns the properties for this instance of a component.
Inherited from Consultingwerk.Forms.BaseForm
+ PropertyDescriptorCollection GetProperties (Attribute[]) Returns the properties for this instance of a component using the attribute array as a filter.
Inherited from Consultingwerk.Forms.BaseForm
+ System.Object GetPropertyOwner (PropertyDescriptor) Returns an object that contains the property described by the specified property descriptor.
Inherited from Consultingwerk.Forms.BaseForm
+ ISmartToolbarControl GetToolbar () Returns the reference to the ISmartToolbarControl of the ISmartWindowForm
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
- InitializeComponent () Initializes the Visual Design
# InitializeDataBinding () Initializes the BindingSource with the same parameters as the Business Entity Adapter and sets up binding source schema
# 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
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
Inherited from Consultingwerk.Forms.BaseForm
# OnFormClosing (FormClosingEventArgs) Raises the FormClosing event
Overrides Consultingwerk.SmartComponents.Base.SmartWindowForm:OnFormClosing (FormClosingEventArgs)
# OnFormDestroyed (EventArgs) Raises the FormDestroyed event
Inherited from Consultingwerk.Forms.BaseForm
# OnLoad (EventArgs) Raises the Load event
Overrides Consultingwerk.SmartComponents.Base.SmartWindowForm:OnLoad (EventArgs)
# OnPrimaryDataSourceChanged (EventArgs) Raises the PrimaryDataSourceChanged event
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
# OnPrimaryDataTargetChanged (EventArgs) Raises the PrimaryDataTargetChanged event
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
# OnPrimaryNavigationSourceChanged (EventArgs) Raises the PrimaryNavigationSourceChanged
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
# OnShown (EventArgs) Raises the Shown Event
# OnSmartToolbarControllerChanged () Internal event handler
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ OnVerbClicked (character) Event Handler method for Designer Verbs
Inherited from Consultingwerk.Forms.BaseForm
+ DialogResultEnum PromptForSaveOfPendingChangesOnClose () Shows the Prompt to save pending transactions to the backend while closing the Form
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ LOGICAL RecurseCheckIsOkToClose (Control+ControlCollection, logical, CloseReason) Recursivly ask all Controls implementing the ICheckOkToClose Interface wheather it is ok to close the form.
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
# LOGICAL RecurseSaveChangesOnDeactivateForm (Control+ControlCollection, logical) Recursively checks all contained controls to save changes on Deactivate of the Form
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
# 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
# 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
- ultraTabControl1_SelectedTabChanged (Object, SelectedTabChangedEventArgs) Event handler for the SelectedTabChanged event of the ultraTabControl1

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

Top Event Summary
Options Name Purpose
+ ActiveSmartControlChanged DELEGATE System.EventHandler Raised whenever the ActiveSmartSmartControl property has changed
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ ExternalDataSourceChanged DELEGATE System.EventHandler Raised when the ExternalDataSource property changes
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ ExternalNavigationTargetChanged (Object, EventArgs) Raised when the ExtenalNavigationSource property changes
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ FormDestroyed DELEGATE System.EventHandler Raised when a Form is destroyed (in the Destructor)
Inherited from Consultingwerk.Forms.BaseForm
+ 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 A reference to the last recently activated (focussed) SmartControl such as a SmartViewerControl or SmartBrowserControl
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
# CHARACTER BindableProperties Property that is used to mark properties (comma-delimited list) that should be Data-Bindable
Inherited from Consultingwerk.Forms.BaseForm
# CHARACTER CategorizedProperties Property that is used to mark properties (comma-delimited list) that should receive a Category attribute
Inherited from Consultingwerk.Forms.BaseForm
# CHARACTER CategoryProperties Categories of the Property in the CategorizedProperty list
Inherited from Consultingwerk.Forms.BaseForm
+ LOGICAL DeleteOnFormClosed Gets/Sets if the BaseForm instance should automatically delete itself in the OnFormClosed method (defaults to True). Setting this to FALSE will allow to let the BaseForm instance in memory (when no other reference exists), i.e. to access properties of the Form class when the Form has been closed.
Inherited from Consultingwerk.Forms.BaseForm
+ System.Collections.Generic.List <Progress.Windows.Form> DependentForms A list of Forms that are dependent from this Form.
Inherited from Consultingwerk.Forms.BaseForm
# CHARACTER DescribedProperties Property that is used to mark properties (comma-delimited list) that should receive a Description attribute
Inherited from Consultingwerk.Forms.BaseForm
# CHARACTER DescriptionProperties Description of the Property in the DescribedProperties list
Inherited from Consultingwerk.Forms.BaseForm
# CHARACTER DesignerVerbs Property that is used to generate Designer Verbs (actions for the Visual Designer)
Inherited from Consultingwerk.Forms.BaseForm
# CHARACTER DesignerVisibilityAttributes The CHARACTER representation of the DesignerSerializationVisibiltiy attribute (Content/Visible/Hidden), see .NET Enumeration System.ComponentModel.DesignerSerializationVisibility
Inherited from Consultingwerk.Forms.BaseForm
# CHARACTER DesignerVisibilityProperties Property that is used to mark properties (comma-delimited list) that should receive a DesignerSerializationVisibility Attribute
Inherited from Consultingwerk.Forms.BaseForm
+ LOGICAL DesignTime Propery flags if the current instance of the SmartBindingSource is running at design time or runtime.
Inherited from Consultingwerk.Forms.BaseForm
+ Consultingwerk.SmartComponents.Base.SmartViewerControl DetailViewerControl Gets and sets the instance of the SmartViewerControl used for the detail record by this form
+ ISmartDataSource ExternalDataSource A DataSource that is passed in from the launching Container (Form) to this Form. The ExternalDataSource will typically be passed on to the internal PrimaryDataTarget
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ ISmartNavigationTarget ExternalNavigationTarget A NavigationTarget that is passed in from the launching Container (Form) to this Form. The ExternalNavigationtarget will typically be passed on to the internal PrimaryNavigationSource
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
# CHARACTER HiddenProperties Property that is used to mark properties (comma-delimited list) that will be excluded from the .NET TypeDescriptor properties list
Inherited from Consultingwerk.Forms.BaseForm
+ LOGICAL IsClosed Returns if the Forms has been closed.
Inherited from Consultingwerk.Forms.BaseForm
+ Consultingwerk.SmartComponents.Base.SmartViewerControl MasterViewerControl Gets and sets the instance of the SmartViewerControl used for the master record by this form
# CHARACTER NonBrowsableProperties Property that is used to mark properties (comma-delimited list) that should not show up in the Visual Designers Property Grid
Inherited from Consultingwerk.Forms.BaseForm
+ System.Windows.Forms.FormWindowState PreviousWindowState Returns the previous WindowState
Inherited from Consultingwerk.Forms.BaseForm
+ Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataSource PrimaryDataSource A reference to the primary data source in this Form
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataTarget PrimaryDataTarget A reference to the primary data target in this Form
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ Consultingwerk.SmartComponents.Interfaces.Design.IDesignNavigationSource PrimaryNavigationSource A reference to the primary navigation source in this Form
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ LOGICAL PromptForSaveOnApplicationLeave Gets and sets if the Form asks contained Controls to Save when the Form is deactivated and the Focus leaves the Application
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
+ LOGICAL PromptForSaveOnFormDeactivate Gets and sets if the Form asks contained Controls to Save when the Form is deactivated and the Focus remains within the Application
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
# LOGICAL StoreFormPosition Controls if this Form instance should store and restore the Form position and size.
Inherited from Consultingwerk.Forms.BaseForm
+ LOGICAL UseStartupSizeAsMinSize When set to True the OnLoad method will apply the current form (startup size) to the MinimumSize. This will be done before loading the stored Form size from the user profile (e.g. Windows Registry)
Inherited from Consultingwerk.Forms.BaseForm
+ CHARACTER WindowPositionRegistryKey Gets and sets the Registry Key used for storing this Forms window position
Inherited from Consultingwerk.Forms.BaseForm


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

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

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

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

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 AttributeCollection GetAttributes ()
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns a collection of custom attributes for this instance of a
component.
Notes:

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

PUBLIC CHARACTER GetClassName ()
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns the class name of this instance of a component.
Notes:

Returns CHARACTER
The class name of the Component
Top

PUBLIC CHARACTER GetComponentName ()
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns the name of this instance of a component.
Notes:

Returns CHARACTER
The Component Name of this instance
Top

PUBLIC TypeConverter GetConverter ()
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns a type converter for this instance of a component.
Notes:

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

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

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

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

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

PUBLIC System.Object GetEditor (Type)
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns an editor of the specified type for this instance of a
component.
Notes:

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

PUBLIC EventDescriptorCollection GetEvents ()
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns the events for this instance of a component.
Notes:

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

PUBLIC EventDescriptorCollection GetEvents (Attribute[])
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns the events for this instance of a component using the
specified attribute array as a filter.
Notes:

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

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

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

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

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

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

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

PUBLIC PropertyDescriptorCollection GetProperties ()
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns the properties for this instance of a component.
Notes:

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

PUBLIC PropertyDescriptorCollection GetProperties (Attribute[])
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns the properties for this instance of a component using the
attribute array as a filter.
Notes:

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

PUBLIC System.Object GetPropertyOwner (PropertyDescriptor)
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns an object that contains the property described by the
specified property descriptor.
Notes:

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

PUBLIC 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

PRIVATE InitializeComponent ()
Purpose: Initializes the Visual Design
Notes:

Top

PROTECTED InitializeDataBinding ()
Purpose: Initializes the BindingSource with the same parameters as the
Business Entity Adapter and sets up binding source schema
Notes:

Top

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

Top

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

Returns CHARACTER
The string containing the stored window settings
Top

PROTECTED CHARACTER LoadSettings (character)
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Loads stored window settings from the registry
Notes:

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

PROTECTED OnActiveSmartControlChanged (EventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Raises the ActiveSmartControlChanged event
Notes:

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

PROTECTED OnExternalDataSourceChanged (EventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Raises the ExternalDataSourceChanged event
Notes:

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

PROTECTED OnExternalNavigationTargetChanged (EventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Raises the OnExternalNavigationTargetChanged
Notes:

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

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

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

PROTECTED OnFormClosing (FormClosingEventArgs)
Overrides Consultingwerk.SmartComponents.Base.SmartWindowForm:OnFormClosing (FormClosingEventArgs)
Purpose: Raises the FormClosing event
Notes: 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 OnLoad (EventArgs)
Overrides Consultingwerk.SmartComponents.Base.SmartWindowForm: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 OnPrimaryDataSourceChanged (EventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Raises the PrimaryDataSourceChanged event
Notes:

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

PROTECTED OnPrimaryDataTargetChanged (EventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Raises the PrimaryDataTargetChanged event
Notes:

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

PROTECTED OnPrimaryNavigationSourceChanged (EventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Raises the PrimaryNavigationSourceChanged
Notes:

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

PROTECTED OnShown (EventArgs)
Purpose: Raises the Shown Event
Notes:

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

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

Top

PUBLIC OnVerbClicked (character)
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Event Handler method for Designer Verbs
Notes:

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

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 behaviour

Returns 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)
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Recursivly ask all Controls implementing the ICheckOkToClose Interface
wheather it is ok to close the form.
Notes:

Parameters:
poControls System.Windows.Forms.Control+ControlCollection
The System.Windows.Forms.Control+ControlCollection Collection of Controls to iterate
plShowMessage LOGICAL
When TRUE a message is Shown explaining why it is not ok to close the parent form.
poCloseReason System.Windows.Forms.CloseReason
The System.Windows.Forms.CloseReason passed from then OnFormClosing Method of the parent form giving the reason who closes the form.
Returns LOGICAL
Logical value indicating if the Form can be closed or not.
Top

PROTECTED LOGICAL RecurseSaveChangesOnDeactivateForm (Control+ControlCollection, logical)
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Recursively checks all contained controls to save changes on
Deactivate of the Form
Notes:

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

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

Top

PRIVATE ultraTabControl1_SelectedTabChanged (Object, SelectedTabChangedEventArgs)
Purpose: Event handler for the SelectedTabChanged event of the ultraTabControl1
Notes:

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


Constructor Detail
Top

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



Event Detail
Top

PUBLIC ActiveSmartControlChanged DELEGATE System.EventHandler
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Raised whenever the ActiveSmartSmartControl property has changed
Notes:

Delegate: System.EventHandler
Top

PUBLIC ExternalDataSourceChanged DELEGATE System.EventHandler
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Raised when the ExternalDataSource property changes
Notes:

Delegate: System.EventHandler
Top

PUBLIC ExternalNavigationTargetChanged (Object, EventArgs)
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Raised when the ExtenalNavigationSource property changes
Notes:

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

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

Delegate: System.EventHandler
Top

PUBLIC 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
Purpose: A reference to the last recently activated (focussed) SmartControl
such as a SmartViewerControl or SmartBrowserControl
Notes: Propaty SET is private as the Method ActivateSmartControl is the
proper way to set this property from anywhere else

Returns System.Windows.Forms.Control
Top

PROTECTED CHARACTER BindableProperties
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Property that is used to mark properties (comma-delimited list) that
should be Data-Bindable
Notes: C# Annotation: [Bindable(true)]

Returns CHARACTER
Top

PROTECTED CHARACTER CategorizedProperties
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Property that is used to mark properties (comma-delimited list) that
should receive a Category attribute
Notes: C# Annotation: [Category("...")]
This is a comma delimited list

Returns CHARACTER
Top

PROTECTED CHARACTER CategoryProperties
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Categories of the Property in the CategorizedProperty list
Notes: C# Annotation: [Category("...")]
This is a comma delimited list

Returns CHARACTER
Top

PUBLIC LOGICAL DeleteOnFormClosed
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Gets/Sets if the BaseForm instance should automatically delete
itself in the OnFormClosed method (defaults to True). Setting this
to FALSE will allow to let the BaseForm instance in memory (when no
other reference exists), i.e. to access properties of the Form
class when the Form has been closed.
Notes: See Progress K-Base Entry ID: P179041
Title: "User Controls that have events attached to them cause
parent forms to not get garbage collected"

Returns LOGICAL
Top

PUBLIC System.Collections.Generic.List <Progress.Windows.Form> DependentForms
Inherited from Consultingwerk.Forms.BaseForm
Purpose: A list of Forms that are dependent from this Form.
Notes: Dependent Forms are similar to ChildForms with the exception that
DependentForms are not automatically kept on top of the Owner.
But when the owner is closed, ths DependentForms will be closed as
well.

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

PROTECTED CHARACTER DescribedProperties
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Property that is used to mark properties (comma-delimited list) that
should receive a Description attribute
Notes: C# Annotation: [Description("...")]
This is a comma delimited list

Returns CHARACTER
Top

PROTECTED CHARACTER DescriptionProperties
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Description of the Property in the DescribedProperties list
Notes: C# Annotation: [Description("...")]
This is a CHR(1) delimited list

Returns CHARACTER
Top

PROTECTED CHARACTER DesignerVerbs
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Property that is used to generate Designer Verbs (actions for the
Visual Designer)
Notes:

Returns CHARACTER
Top

PROTECTED CHARACTER DesignerVisibilityAttributes
Inherited from Consultingwerk.Forms.BaseForm
Purpose: The CHARACTER representation of the DesignerSerializationVisibiltiy
attribute (Content/Visible/Hidden), see .NET Enumeration
System.ComponentModel.DesignerSerializationVisibility
Notes: C# Annotation: [DesignerSerializationVisibility(...)]
This is a comma delimited list

Returns CHARACTER
Top

PROTECTED CHARACTER DesignerVisibilityProperties
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Property that is used to mark properties (comma-delimited list) that
should receive a DesignerSerializationVisibility Attribute
Notes: C# Annotation: [DesignerSerializationVisibility(...)]
This is a comma delimited list

Returns CHARACTER
Top

PUBLIC LOGICAL DesignTime
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Propery flags if the current instance of the SmartBindingSource
is running at design time or runtime.
Notes: Set during constructor using a check at the
System.ComponentModel.LicenseManager

Returns LOGICAL
Top

PUBLIC Consultingwerk.SmartComponents.Base.SmartViewerControl DetailViewerControl
Purpose: Gets and sets the instance of the SmartViewerControl used for the
detail record by this form
Notes: Once set, this property value cannot be changed

Returns Consultingwerk.SmartComponents.Base.SmartViewerControl
Top

PUBLIC ISmartDataSource ExternalDataSource
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: A DataSource that is passed in from the launching Container (Form)
to this Form. The ExternalDataSource will typically be passed on
to the internal PrimaryDataTarget
Notes: Used for PASS-THROUGH data links

Returns ISmartDataSource
Top

PUBLIC ISmartNavigationTarget ExternalNavigationTarget
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: A NavigationTarget that is passed in from the launching Container (Form)
to this Form. The ExternalNavigationtarget will typically be passed on
to the internal PrimaryNavigationSource
Notes: Used for PASS-THROUGH navigation links

Returns ISmartNavigationTarget
Top

PROTECTED CHARACTER HiddenProperties
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Property that is used to mark properties (comma-delimited list) that
will be excluded from the .NET TypeDescriptor properties list
Notes:

Returns CHARACTER
Top

PUBLIC LOGICAL IsClosed
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns if the Forms has been closed.
Notes: A Form may be closed but not yet deleted

Returns LOGICAL
Top

PUBLIC Consultingwerk.SmartComponents.Base.SmartViewerControl MasterViewerControl
Purpose: Gets and sets the instance of the SmartViewerControl used for the
master record by this form
Notes: Once set, this property value cannot be changed

Returns Consultingwerk.SmartComponents.Base.SmartViewerControl
Top

PROTECTED CHARACTER NonBrowsableProperties
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Property that is used to mark properties (comma-delimited list) that
should not show up in the Visual Designers Property Grid
Notes:

Returns CHARACTER
Top

PUBLIC System.Windows.Forms.FormWindowState PreviousWindowState
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Returns the previous WindowState
Notes: This is useful when minimized Form should be brought back to foreground
and it is important to know if the window should be receiving Normal
or Maximized window state
Progress introduced in a 10.2B service pack the property previousState
that returned the previous WindowState. However in OpenEdge 11.1 this
property has been removed (or marked private) as this property was
never intended for the public use. As we and other customer have
been relying on this property Progress has logged bug # OE00222715
to restore this property in a future release or service pack

Returns System.Windows.Forms.FormWindowState
Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataSource PrimaryDataSource
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: A reference to the primary data source in this Form
Notes:

Returns Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataSource
Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataTarget PrimaryDataTarget
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: A reference to the primary data target in this Form
Notes: Used for PASS-THROUGH data links

Returns Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataTarget
Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.Design.IDesignNavigationSource PrimaryNavigationSource
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: A reference to the primary navigation source in this Form
Notes: Used for PASS-THROUGH navigation links

Returns Consultingwerk.SmartComponents.Interfaces.Design.IDesignNavigationSource
Top

PUBLIC LOGICAL PromptForSaveOnApplicationLeave
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Gets and sets if the Form asks contained Controls to Save when the
Form is deactivated and the Focus leaves the Application
Notes: May be combined with PromptForSaveOnFormDeactivate

Returns LOGICAL
Top

PUBLIC LOGICAL PromptForSaveOnFormDeactivate
Inherited from Consultingwerk.SmartComponents.Base.SmartWindowForm
Purpose: Gets and sets if the Form asks contained Controls to Save when the
Form is deactivated and the Focus remains within the Application
Notes: May be combined with PromptForSaveOnApplicationLeave

Returns LOGICAL
Top

PROTECTED LOGICAL StoreFormPosition
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Controls if this Form instance should store and restore the Form
position and size.
Notes: Allows alternative Form positions (like CenterParent etc.)

Returns LOGICAL
Top

PUBLIC LOGICAL UseStartupSizeAsMinSize
Inherited from Consultingwerk.Forms.BaseForm
Purpose: When set to True the OnLoad method will apply the current form (startup
size) to the MinimumSize. This will be done before loading the stored
Form size from the user profile (e.g. Windows Registry)
Notes: Defaulted by static property UseStartupSizeAsMinSizeDefault in
Consultingwerk.Framework.FrameworkSettings. This property used to
be in the class itself, but was moved to the FrameworkSettings class
to avoid issues with the combination of static and hybrids on 11.2
and 11.3, OE defect OE00240707
http://knowledgebase.progress.com/articles/Article/000042229?popup=true

Returns LOGICAL
Top

PUBLIC CHARACTER WindowPositionRegistryKey
Inherited from Consultingwerk.Forms.BaseForm
Purpose: Gets and sets the Registry Key used for storing this Forms
window position
Notes:

Returns CHARACTER


©2006-2016 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       26.08.2016 08:31:27