Namespace: Consultingwerk.Studio.ProcedureEditor
Class 
ProcedureEditorBaseForm Copy to Clipboard
Parent classes:
Inherits: Consultingwerk.Forms.BaseForm
Implements: IBaseForm, ICustomTypeDescriptor, IHasDesignerVerbs
Inherited by: Consultingwerk.Studio.ProcedureEditor.ProcedureEditorForm

File:ProcedureEditorBaseForm
Purpose:Specialized (WinKit form) base class for the ProcedureEditorForm
This version excluses customers additions to EmbeddedWindowBaseForm
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Mon Jun 30 12:18:32 CEST 2014
/* traditional return of error
File:EmbeddedWindowBaseForm
Purpose:BaseForm for Embedded Windows Forms
Description:This class implements the majority of properties
enforced by the IEmbeddedWindowForm Interface
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Fri Dec 18 23:26:29 CET 2009
Notes:This class is meant to be ABSTRACT - but the .NET
Visual Designer does not support to design classes with
abstract base classes
This class file can also be used as an include file. It
is a common requirement to workaround the non availbility
of multiple-inheritance. In this case, specify the
&AlterantiveBaseClass
&AlternativePackageName
&AlternativeClassName
as include file parameters. Note that when specifying one,
all need the others to be specified as well



Top Method Summary
Options Name Purpose
+ LOGICAL CanFindInComponentsCollection (Object) Returns if the component can be found in the ComponentsCollection
Inherited from Consultingwerk.Forms.BaseForm
+ CloseEmbeddedWindows (logical) Requests closing of the embedded window
# 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
+ EnableDisableOverlayControls () Toggles Sensitivity of OverlayControls based on the sensitive status of the corresponding Widget/Frame
+ 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
+ HANDLE GetEmbeddedWindows () Returns an indeterminate array of the HANDLEs of the embedded Windows
+ 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
+ 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
# 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
# OnActivated (EventArgs) Raises the Activated event
# OnDeactivate (EventArgs) Raises the Deactivate event
# OnFormClosed (FormClosedEventArgs) Raises the FormClosed event
Overrides Consultingwerk.Forms.BaseForm:OnFormClosed (FormClosedEventArgs)
# OnFormClosing (FormClosingEventArgs) Raises the FormClosing event
Inherited from Consultingwerk.Forms.BaseForm
# OnFormDestroyed (EventArgs) Raises the FormDestroyed event
Inherited from Consultingwerk.Forms.BaseForm
# OnLoad (EventArgs) Raises the Load event
Inherited from Consultingwerk.Forms.BaseForm
+ OnVerbClicked (character) Event Handler method for Designer Verbs
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
# 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
# UpdateControlsForEventHandler () Brings Controls/Widget's in sync for handling .NET Events
+ ViewHideOverlayControls () Toggles Visibily of OverlayControls based on the view/hide status of the corresponding Widget/Frame
+ Progress.Windows.WindowContainer WindowContainerOfWidget (handle) Returns the WindowContainer that contains the widget

Top Constructor Summary
Options Name Purpose
+ ProcedureEditorBaseForm () Default constructor

Top Event Summary
Options Name Purpose
+ FormDestroyed DELEGATE System.EventHandler Raised when a Form is destroyed (in the Destructor)
Inherited from Consultingwerk.Forms.BaseForm

Top Property Summary
Options Name Purpose
# 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
+ WIDGET-HANDLE EmbeddedWindow Returns the reference to the embedded window widget (ABL window)
+ LOGICAL Finalized Flags if the IEmbeddedWindowForm has already been finalized
+ LOGICAL FocusEmbeddedWindowOnActivated Controls if the Embedded window should receive Focus, when the Form is Activated or not
+ CHARACTER FrameHandles Gets and sets a comma-delimited list of all FRAME handles in a Window
# 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
+ LOGICAL MakeMdiChild Controls if the Form should become an MdiChild of not.
+ WIDGET-HANDLE MENU-BAR Gets and sets the reference to the MENU-BAR of the embedded window
+ LOGICAL MenuBarAsToolbar Gets and sets if whole MENU-BAR of the window should be rendered as a toolbar instance
+ LOGICAL MenuItemsAsToolbar Gets and sets if MENU-ITEM Type Menu-Items of the Main-Menubar (Windows MENU-BAR) should be rendered as a separate toolbar instance
+ DECIMAL MinHeightChars Allows the definition of a minimum height in Chars for the embedded ABL window
+ DECIMAL MinWidthChars Allows the definition of a minimum width in Chars for the embedded ABL window
# 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
+ CHARACTER OriginalWindowTitle Keeps the original window title (as entered in the AppBuilder)
+ System.Collections.Generic.Dictionary <System.Windows.Forms.Control> OverlayControls A Dictionary of Overlay Controls
+ HANDLE PreviousFocus A reference to the Widget that had Focus when this Form was deactivated
+ System.Windows.Forms.FormWindowState PreviousWindowState Returns the previous WindowState
Inherited from Consultingwerk.Forms.BaseForm
+ HANDLE ProcedureHandle A reference to the procedure that's owning this EmbeddedWindowBaseForm instance
+ LOGICAL ShowAsDialog Controls if the embedded window Form should be shown as a Dialog
# LOGICAL StoreFormPosition Controls if this Form instance should store and restore the Form position and size.
Inherited from Consultingwerk.Forms.BaseForm
+ Infragistics.Win.UltraWinToolbars.UltraToolbarsManager ToolbarsManager Returns the reference to the UltraToolbarsManager instance contained in the Embedded Window Form
+ 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
+ System.Collections.Generic.List <WindowContainer> WindowContainers A collection of the Progress.Windows.WindowsContainer controls used by this Form
+ CHARACTER WindowPositionRegistryKey Gets and sets the Registry Key used for storing this Forms window position
Inherited from Consultingwerk.Forms.BaseForm


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

PUBLIC CloseEmbeddedWindows (logical)

Purpose: Requests closing of the embedded window
Notes: Returns TRUE when window closed, otherwise FALSE

Parameters:
plOk LOGICAL
Logical value indicating if the windows were closed
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 EnableDisableOverlayControls ()

Purpose: Toggles Sensitivity of OverlayControls based on the sensitive status
of the corresponding Widget/Frame
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 HANDLE GetEmbeddedWindows ()

Purpose: Returns an indeterminate array of the HANDLEs of the embedded Windows
Notes: Returns a size 1 array with the EmbeddedWindow HANDLE

Returns HANDLE
The array with the window HANDLE
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 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

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 OnActivated (EventArgs)

Purpose: Raises the Activated event
Notes: Optionally puts focus into the EmbeddedWindow

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

PROTECTED OnDeactivate (EventArgs)

Purpose: Raises the Deactivate event
Notes:

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

PROTECTED OnFormClosed (FormClosedEventArgs)

Overrides Consultingwerk.Forms.BaseForm:OnFormClosed (FormClosedEventArgs)
Purpose: Raises the FormClosed event
Notes:

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

PROTECTED OnFormClosing (FormClosingEventArgs)

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

Inherited from Consultingwerk.Forms.BaseForm
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

PUBLIC OnVerbClicked (character)

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

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

PROTECTED 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

PROTECTED UpdateControlsForEventHandler ()

Purpose: Brings Controls/Widget's in sync for handling .NET Events
Notes: Used for instance with the ToolClick event and updatable browsers

Top

PUBLIC ViewHideOverlayControls ()

Purpose: Toggles Visibily of OverlayControls based on the view/hide status
of the corresponding Widget/Frame
Notes:

Top

PUBLIC Progress.Windows.WindowContainer WindowContainerOfWidget (handle)

Purpose: Returns the WindowContainer that contains the widget
Notes:

Parameters:
phWidget HANDLE
The handle of the WINDOW widget to locate
Returns Progress.Windows.WindowContainer
The reference to the WindowContainer that contains the WINDOW


Constructor Detail
Top

PUBLIC ProcedureEditorBaseForm ()

Purpose: Default constructor
Notes:



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


Property Detail
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 WIDGET-HANDLE EmbeddedWindow

Purpose: Returns the reference to the embedded window widget (ABL window)
Notes: Read-Only, set by EmbedWindow method

Returns WIDGET-HANDLE
Top

PUBLIC LOGICAL Finalized

Purpose: Flags if the IEmbeddedWindowForm has already been finalized
Notes: Prevents duplicate execution of embedfinalize.i

Returns LOGICAL
Top

PUBLIC LOGICAL FocusEmbeddedWindowOnActivated

Purpose: Controls if the Embedded window should receive Focus, when the Form
is Activated or not
Notes:

Returns LOGICAL
Top

PUBLIC CHARACTER FrameHandles

Purpose: Gets and sets a comma-delimited list of all FRAME handles in a Window
Notes: This may be useful when FRAME's are realized (and made visible) after
the Window is shown. In this case it may be difficult to query the
FRAME handles from the Window widget-tree

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

Purpose: Controls if the Form should become an MdiChild of not.
Notes:

Returns LOGICAL
Top

PUBLIC WIDGET-HANDLE MENU-BAR

Purpose: Gets and sets the reference to the MENU-BAR of the embedded window
Notes: This property is required, as the embedding seems to remove the
reference to the menu-bar, but the menu-bar is still available
(the legacy ABL code).

Returns WIDGET-HANDLE
Top

PUBLIC LOGICAL MenuBarAsToolbar

Purpose: Gets and sets if whole MENU-BAR of the window should be rendered as
a toolbar instance
Notes: This is an optional property .
The initial value is FALSE .

Returns LOGICAL
Top

PUBLIC LOGICAL MenuItemsAsToolbar

Purpose: Gets and sets if MENU-ITEM Type Menu-Items of the Main-Menubar
(Windows MENU-BAR) should be rendered as a separate toolbar instance
Notes: This is an optional property .
The initial value is FALSE .

Returns LOGICAL
Top

PUBLIC DECIMAL MinHeightChars

Purpose: Allows the definition of a minimum height in Chars for the embedded
ABL window
Notes: This property is not required by the standard WinKit functionality
and is reserved for customization

Returns DECIMAL
Top

PUBLIC DECIMAL MinWidthChars

Purpose: Allows the definition of a minimum width in Chars for the embedded
ABL window
Notes: This property is not required by the standard WinKit functionality
and is reserved for customization

Returns DECIMAL
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 CHARACTER OriginalWindowTitle

Purpose: Keeps the original window title (as entered in the AppBuilder)
Notes: This is useful if this string should be used as the standard caption
of Ribbon Tabs or similar and during the initalization runtime
specific attributes (like the client or user) are added to the window title.

Returns CHARACTER
Top

PUBLIC System.Collections.Generic.Dictionary <System.Windows.Forms.Control> OverlayControls

Purpose: A Dictionary of Overlay Controls
Notes: OverlayControls is not a Dictionary with the STRING of the associated
widgets handle as the key and the reference to the .NET Control as
the value

Returns System.Collections.Generic.Dictionary <System.Windows.Forms.Control>
Top

PUBLIC HANDLE PreviousFocus

Purpose: A reference to the Widget that had Focus when this Form was
deactivated
Notes:

Returns HANDLE
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 HANDLE ProcedureHandle

Purpose: A reference to the procedure that's owning this
EmbeddedWindowBaseForm instance
Notes:

Returns HANDLE
Top

PUBLIC LOGICAL ShowAsDialog

Purpose: Controls if the embedded window Form should be shown as a Dialog
Notes: Typically supresses the call of the Show() method in the embedfinalize.i
and the call to the Dispose() method in closewindow.i

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 Infragistics.Win.UltraWinToolbars.UltraToolbarsManager ToolbarsManager

Purpose: Returns the reference to the UltraToolbarsManager instance contained
in the Embedded Window Form
Notes:

Returns Infragistics.Win.UltraWinToolbars.UltraToolbarsManager
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 System.Collections.Generic.List <WindowContainer> WindowContainers

Purpose: A collection of the Progress.Windows.WindowsContainer controls used
by this Form
Notes:

Returns System.Collections.Generic.List <WindowContainer>
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:45:30