Namespace: Consultingwerk.WindowIntegrationKit.Forms
Interface 
IEmbeddedWindowForm Copy to Clipboard
Parent classes:
Inherits: Progress.Lang.Object
Implemented by: Consultingwerk.Studio.ProcedureEditor.ProcedureEditorForm, Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowForm, Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowTabFolderForm

File:IEmbeddedWindowForm
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Mon Dec 08 10:05:22 CET 2008

Navigate to: Methods | Constructors | Events | Properties



Top Method Summary
Options Name Purpose
+ CloseEmbeddedWindows (logical) Requests closing of the embedded window
+ CloseFromCode () Closes the Form after unsubscribing it's own FormClosing event handle
+ EmbedWindow (handle) Creates a new instance of the Progress.Windows.WindowContainer instance and embeds the given window widget in that instance - but does not parent the WindowContainer instance in the Form (THIS-OBJECT). This is delayed till later.
+ EnableDisableOverlayControls () Toggles Sensitivity of OverlayControls based on the sensitive status of the corresponding Widget/Frame
+ FinalizeEmbedding () Finalize the embedding of an ABL window widget by parenting the Progress.Windows.WindowContainer instance in the Form (THIS-OBJECT). Sets the Form Text property and applies the window-resized event to the window widget.
+ HANDLE GetEmbeddedWindows () Returns an indeterminate array of the HANDLEs of the embedded Windows
+ RefreshButtons () Refreshes the state of all overlay buttons in the IEmbeddedWindowForm
+ UpdateWindowAttributes () Update Form properties with Properties from the WindowWidget
+ 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 Property Summary
Options Name Purpose
+ System.Windows.Forms.Control ClientArea Returns the reference to the main client are of the IEmbeddedWindowForm
+ WIDGET-HANDLE EmbeddedWindow Returns the reference to the embedded window widget (ABL window)
+ LOGICAL Finalized Flags if the IEmbeddedWindowForm has already been finalized
+ CHARACTER FrameHandles Gets and sets a comma-delimited list of all FRAME handles in a Window
+ 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 OriginalWindowTitle Keeps the original window title (as entered in the AppBuilder) in a
+ System.Collections.Generic.Dictionary <System.Windows.Forms.Control> OverlayControls A Dictionary of Overlay Controls
+ 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
+ Infragistics.Win.UltraWinToolbars.UltraToolbarsManager ToolbarsManager Returns the reference to the UltraToolbarsManager instance contained in the Embedded Window Form
+ INTEGER WindowContainerColOffset Gets and Sets the Col offset used when positioning the WindowContainer control in this .NET Form.
+ INTEGER WindowContainerRowOffset Gets and Sets the default Row offset used when positioning the WindowContainer control in this .NET Form.
+ System.Collections.Generic.List <Progress.Windows.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


Method Detail
Top

PUBLIC CloseEmbeddedWindows (logical)
Purpose: Requests closing of the embedded window
Notes:

Parameters:
lOk LOGICAL
Logical value indicating if the windows were closed
Top

PUBLIC CloseFromCode ()
Purpose: Closes the Form after unsubscribing it's own FormClosing event handle
Notes: Invoked from src/winkit/closewindow.i after the ABL window WINDOW-CLOSE
event handler has not cancelled the closing of the WINDOW and Form

Top

PUBLIC EmbedWindow (handle)
Purpose: Creates a new instance of the Progress.Windows.WindowContainer
instance and embeds the given window widget in that instance -
but does not parent the WindowContainer instance in the Form
(THIS-OBJECT). This is delayed till later.
Notes: Required due to incombatibily issues with the Infragistics
UltraTabbedMdiManager.

Parameters:
phWindow HANDLE
The handle of the WINDOW widget to embed
Top

PUBLIC EnableDisableOverlayControls ()
Purpose: Toggles Sensitivity of OverlayControls based on the sensitive status
of the corresponding Widget/Frame
Notes:

Top

PUBLIC FinalizeEmbedding ()
Purpose: Finalize the embedding of an ABL window widget by parenting
the Progress.Windows.WindowContainer instance in the Form
(THIS-OBJECT). Sets the Form Text property and applies the
window-resized event to the window widget.
Notes: Required due to incombatibily issues with the Infragistics
UltraTabbedMdiManager.

Top

PUBLIC HANDLE GetEmbeddedWindows ()
Purpose: Returns an indeterminate array of the HANDLEs of the embedded Windows
Notes:

Returns HANDLE
The array of window HANDLE's
Top

PUBLIC RefreshButtons ()
Purpose: Refreshes the state of all overlay buttons in the IEmbeddedWindowForm
Notes:

Top

PUBLIC UpdateWindowAttributes ()
Purpose: Update Form properties with Properties from the WindowWidget
Notes:

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


Property Detail
Top

PUBLIC System.Windows.Forms.Control ClientArea
Purpose: Returns the reference to the main client are of the IEmbeddedWindowForm
Notes: Read-Only

Returns System.Windows.Forms.Control
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 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

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

PUBLIC CHARACTER OriginalWindowTitle
Purpose: Keeps the original window title (as entered in the AppBuilder) in a
Notes: This is useful if this string shoudl be used for a 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 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

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 INTEGER WindowContainerColOffset
Purpose: Gets and Sets the Col offset used when positioning the
WindowContainer control in this .NET Form.
Notes: Needs to be set before EmbedWindow is invoked

Returns INTEGER
Top

PUBLIC INTEGER WindowContainerRowOffset
Purpose: Gets and Sets the default Row offset used when positioning the
WindowContainer control in this .NET Form.
Notes: Needs to be set before EmbedWindow is invoked

Returns INTEGER
Top

PUBLIC System.Collections.Generic.List <Progress.Windows.WindowContainer> WindowContainers
Purpose: A collection of the Progress.Windows.WindowsContainer controls used
by this Form
Notes:

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

PUBLIC CHARACTER WindowPositionRegistryKey
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:47:33