Namespace: Consultingwerk.WindowIntegrationKit.Forms
Interface 
IEmbeddedWindowTabFolderForm Copy to Clipboard
Parent classes:
Inherits: Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm
Implemented by: Consultingwerk.WindowIntegrationKit.Forms.EmbeddedWindowTabFolderForm

File:IEmbeddedWindowTabFolderForm
Purpose:An Interface describing the methods required in WinKit
Forms that realize a TabFolder
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Tue Jan 15 13:11:13 CET 2013
Purpose: Gets and sets the Splitter's distance
Notes: Should be set to match the position of the original ABL tabfolder



Top Method Summary
Options Name Purpose
+ AssignTabLabels (character, character) Assigns the Labels of the Tabfolder based on a Character List
+ CloseEmbeddedWindows (logical) Requests closing of the embedded window
Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm
+ CloseFromCode () Closes the Form after unsubscribing it's own FormClosing event handle
Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm
+ CloseTabs () Closes the dynamically created windows and WindowContainer objects
+ CreateTab (character, integer) Creates a Tab on the TabFolder with the given Label and key
+ CreateTabPageFrame (integer) Creates the Window and Frame used for folder pages
+ CreateTabs (character) Creates Tabs for a list of Tabs
+ CreateTabs (character, character) Creates Tabs for a list of Tabs
+ DeleteTabPage (integer) Deletes (removes) a Tab Page
+ DisableFolderPage (integer) Disables a folder Page
+ 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.
Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm
+ EnableDisableOverlayControls () Toggles Sensitivity of OverlayControls based on the sensitive status of the corresponding Widget/Frame
Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm
+ EnableFolderPage (integer) Enables a folder Page
+ 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.
Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm
+ FinalizeTabPage (integer) Fianlizes the Embedding of a single Tab Page
+ HANDLE GetEmbeddedWindows () Returns an indeterminate array of the HANDLEs of the embedded Windows
Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm
+ System.Windows.Forms.Control GetTabPageControl (integer) Returns the UltraTab Control that was created for a tab page
+ HANDLE GetTabPageFrame (integer) Returns the HANDLE of the ABL Frame that was created as the default frame for a tab page
+ HANDLE GetTabPageWindow (integer) Returns the HANDLE of the ABL Window that was created for a tab page
+ Progress.Windows.WindowContainer GetTabPageWindowContainer (integer) Returns the WindowContainer Control that was created for a tab page
+ RefreshButtons () Refreshes the state of all overlay buttons in the IEmbeddedWindowForm
Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm
+ SelectTab (integer) Selects a TabPage
+ UpdateWindowAttributes () Update Form properties with Properties from the WindowWidget
Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm
+ ViewHideOverlayControls () Toggles Visibily of OverlayControls based on the view/hide status of the corresponding Widget/Frame
Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm
+ Progress.Windows.WindowContainer WindowContainerOfWidget (handle) Returns the WindowContainer that contains the widget
Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm

Top Property Summary
Options Name Purpose
+ System.Windows.Forms.Control ClientArea
Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm
+ WIDGET-HANDLE EmbeddedWindow
Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm
+ LOGICAL Finalized
Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm
+ CHARACTER FrameHandles
Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm
+ LOGICAL MakeMdiChild
Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm
+ WIDGET-HANDLE MENU-BAR
Overrides Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm:MENU-BAR
+ LOGICAL MenuBarAsToolbar
Overrides Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm:MenuBarAsToolbar
+ LOGICAL MenuItemsAsToolbar
Overrides Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm:MenuItemsAsToolbar
+ DECIMAL MinHeightChars
Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm
+ DECIMAL MinWidthChars
Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm
+ CHARACTER OriginalWindowTitle
Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm
+ System.Collections.Generic.Dictionary <System.Windows.Forms.Control> OverlayControls
Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm
+ HANDLE ProcedureHandle
Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm
+ LOGICAL ShowAsDialog
Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm
+ INTEGER SplitterDistance
+ Infragistics.Win.UltraWinTabControl.UltraTabControl TabFolder
+ UltraToolbarsManager ToolbarsManager
Overrides Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm:ToolbarsManager
+ INTEGER WindowContainerColOffset
Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm
+ INTEGER WindowContainerRowOffset
Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm
+ System.Collections.Generic.List <Progress.Windows.WindowContainer> WindowContainers
Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm
+ CHARACTER WindowPositionRegistryKey
Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm


Method Detail
Top

PUBLIC AssignTabLabels (character, character)

Purpose: Assigns the Labels of the Tabfolder based on a Character List
Notes:

Parameters:
pcLabels CHARACTER
A delimited list of tab labels
pcDelimiter CHARACTER
The list delimited, like the | (pipe) for ADM2 folder
Top

PUBLIC CloseEmbeddedWindows (logical)

Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm
Purpose: Requests closing of the embedded window
Notes:

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

PUBLIC CloseFromCode ()

Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm
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 CloseTabs ()

Purpose: Closes the dynamically created windows and WindowContainer objects
Notes: Used by closewindow.i

Top

PUBLIC CreateTab (character, integer)

Purpose: Creates a Tab on the TabFolder with the given Label and key
Notes:

Parameters:
pcTabText CHARACTER
The label to use for the new tab
piTabKey INTEGER
The 1 based number for the tab to create
Top

PUBLIC CreateTabPageFrame (integer)

Purpose: Creates the Window and Frame used for folder pages
Notes: Creates ttFolderPages record

Parameters:
piPage INTEGER
The page number to create a window and frame for
Top

PUBLIC CreateTabs (character)

Purpose: Creates Tabs for a list of Tabs
Notes: Uses the comma as the default delimiter

Parameters:
pcLabels CHARACTER
A comma-charcater delimited list of tab labels
Top

PUBLIC CreateTabs (character, character)

Purpose: Creates Tabs for a list of Tabs
Notes:

Parameters:
pcLabels CHARACTER
A delimited character list of tab labels
pcDelimiter CHARACTER
The character used as the delimiter of the list
Top

PUBLIC DeleteTabPage (integer)

Purpose: Deletes (removes) a Tab Page
Notes:

Parameters:
piPage INTEGER
The tab page to remove
Top

PUBLIC DisableFolderPage (integer)

Purpose: Disables a folder Page
Notes:

Parameters:
piPage INTEGER
The page number to disable (based on 1)
Top

PUBLIC EmbedWindow (handle)

Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm
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 ()

Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm
Purpose: Toggles Sensitivity of OverlayControls based on the sensitive status
of the corresponding Widget/Frame
Notes:

Top

PUBLIC EnableFolderPage (integer)

Purpose: Enables a folder Page
Notes:

Parameters:
piPage INTEGER
The page number to enable (based on 1)
Top

PUBLIC FinalizeEmbedding ()

Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm
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 FinalizeTabPage (integer)

Purpose: Fianlizes the Embedding of a single Tab Page
Notes:

Parameters:
piPage INTEGER
The Tab Page Number
Top

PUBLIC HANDLE GetEmbeddedWindows ()

Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm
Purpose: Returns an indeterminate array of the HANDLEs of the embedded Windows
Notes:

Returns HANDLE
The array of window HANDLE's
Top

PUBLIC System.Windows.Forms.Control GetTabPageControl (integer)

Purpose: Returns the UltraTab Control that was created for a tab page
Notes:

Parameters:
piPage INTEGER
The 1 based index of the tab page
Returns System.Windows.Forms.Control
The reference to the UltraTab Control that was created for a tab page
Top

PUBLIC HANDLE GetTabPageFrame (integer)

Purpose: Returns the HANDLE of the ABL Frame that was created as the default
frame for a tab page
Notes:
frame for a tab page

Parameters:
piPage INTEGER
The 1 based index of the tab page
Returns HANDLE
The HANDLE of the ABL Frame that was created as the default
Top

PUBLIC HANDLE GetTabPageWindow (integer)

Purpose: Returns the HANDLE of the ABL Window that was created for a tab page
Notes:

Parameters:
piPage INTEGER
The 1 based index of the tab page
Returns HANDLE
The HANDLE of the ABL Window that was created for a tab page
Top

PUBLIC Progress.Windows.WindowContainer GetTabPageWindowContainer (integer)

Purpose: Returns the WindowContainer Control that was created for a tab page
Notes:

Parameters:
piPage INTEGER
The 1 based index of the tab page
Returns Progress.Windows.WindowContainer
The reference to the WindowContainer Control that was created for a tab page
Top

PUBLIC RefreshButtons ()

Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm
Purpose: Refreshes the state of all overlay buttons in the IEmbeddedWindowForm
Notes:

Top

PUBLIC SelectTab (integer)

Purpose: Selects a TabPage
Notes:

Parameters:
piPage INTEGER
The tab page number
Top

PUBLIC UpdateWindowAttributes ()

Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm
Purpose: Update Form properties with Properties from the WindowWidget
Notes:

Top

PUBLIC ViewHideOverlayControls ()

Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm
Purpose: Toggles Visibily of OverlayControls based on the view/hide status
of the corresponding Widget/Frame
Notes:

Top

PUBLIC Progress.Windows.WindowContainer WindowContainerOfWidget (handle)

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

Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm

Returns System.Windows.Forms.Control
Top

PUBLIC WIDGET-HANDLE EmbeddedWindow

Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm

Returns WIDGET-HANDLE
Top

PUBLIC LOGICAL Finalized

Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm

Returns LOGICAL
Top

PUBLIC CHARACTER FrameHandles

Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm

Returns CHARACTER
Top

PUBLIC LOGICAL MakeMdiChild

Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm

Returns LOGICAL
Top

PUBLIC WIDGET-HANDLE MENU-BAR

Overrides Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm:MENU-BAR

Returns WIDGET-HANDLE
Top

PUBLIC LOGICAL MenuBarAsToolbar

Overrides Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm:MenuBarAsToolbar

Returns LOGICAL
Top

PUBLIC LOGICAL MenuItemsAsToolbar

Overrides Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm:MenuItemsAsToolbar

Returns LOGICAL
Top

PUBLIC DECIMAL MinHeightChars

Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm

Returns DECIMAL
Top

PUBLIC DECIMAL MinWidthChars

Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm

Returns DECIMAL
Top

PUBLIC CHARACTER OriginalWindowTitle

Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm

Returns CHARACTER
Top

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

Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm

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

PUBLIC HANDLE ProcedureHandle

Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm

Returns HANDLE
Top

PUBLIC LOGICAL ShowAsDialog

Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm

Returns LOGICAL
Top

PUBLIC INTEGER SplitterDistance


Returns INTEGER
Top

PUBLIC Infragistics.Win.UltraWinTabControl.UltraTabControl TabFolder


Returns Infragistics.Win.UltraWinTabControl.UltraTabControl
Top

PUBLIC UltraToolbarsManager ToolbarsManager

Overrides Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm:ToolbarsManager

Returns UltraToolbarsManager
Top

PUBLIC INTEGER WindowContainerColOffset

Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm

Returns INTEGER
Top

PUBLIC INTEGER WindowContainerRowOffset

Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm

Returns INTEGER
Top

PUBLIC System.Collections.Generic.List <Progress.Windows.WindowContainer> WindowContainers

Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm

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

PUBLIC CHARACTER WindowPositionRegistryKey

Inherited from Consultingwerk.WindowIntegrationKit.Forms.IEmbeddedWindowForm

Returns CHARACTER


©2006-2023 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       15.04.2024 06:18:01